2021-06-03 10:21:02 -06:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Event Reports - Synapse< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "../favicon.svg" >
< link rel = "shortcut icon" href = "../favicon.png" >
< link rel = "stylesheet" href = "../css/variables.css" >
< link rel = "stylesheet" href = "../css/general.css" >
< link rel = "stylesheet" href = "../css/chrome.css" >
< link rel = "stylesheet" href = "../css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "../FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "../fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "../highlight.css" >
< link rel = "stylesheet" href = "../tomorrow-night.css" >
< link rel = "stylesheet" href = "../ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< link rel = "stylesheet" href = "../docs/website_files/table-of-contents.css" >
< link rel = "stylesheet" href = "../docs/website_files/remove-nav-buttons.css" >
< link rel = "stylesheet" href = "../docs/website_files/indent-section-headers.css" >
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2022-09-01 08:49:44 -06:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < li class = "part-title" > Introduction< / li > < li class = "chapter-item expanded " > < a href = "../welcome_and_overview.html" > Welcome and Overview< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Setup< / li > < li class = "chapter-item expanded " > < a href = "../setup/installation.html" > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../postgres.html" > Using Postgres< / a > < / li > < li class = "chapter-item expanded " > < a href = "../reverse_proxy.html" > Configuring a Reverse Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../setup/forward_proxy.html" > Configuring a Forward/Outbound Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../turn-howto.html" > Configuring a Turn Server< / a > < / li > < li class = "chapter-item expanded " > < a href = "../delegate.html" > Delegation< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Upgrading< / li > < li class = "chapter-item expanded " > < a href = "../upgrade.html" > Upgrading between Synapse Versions< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Usage< / li > < li class = "chapter-item expanded " > < a href = "../federate.html" > Federation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/index.html" > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../usage/configuration/config_documentation.html" > Configuration Manual< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/homeserver_sample_config.html" > Homeserver Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/logging_sample_config.html" > Logging Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../structured_logging.html" > Structured Logging< / a > < / li > < li class = "chapter-item expanded " > < a href = "../templates.html" > Templates< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/index.html" > User Authentication< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/index.html" > Single-Sign On< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../openid.html" > OpenID Connect< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/saml.html" > SAML< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/cas.html" > CAS< / a > < / li > < li class = "chapter-item expanded " > < a href = "../sso_mapping_providers.html" > SSO Mapping Providers< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../password_auth_providers.html" > Password Auth Providers< / a > < / li > < li class = "chapter-item expanded " > < a href = "../jwt.html" > JSON Web Tokens< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/refresh_tokens.html" > Refresh Tokens< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../CAPTCHA_SETUP.html" > Registration Captcha< / a > < / li > < li class = "chapter-item expanded " > < a href = "../application_services.html" > Application Services< / a > < / li > < li class = "chapter-item expanded " > < a href = "../server_notices.html" > Server Notices< / a > < / li > < li class = "chapter-item expanded " > < a href = "../consent_tracking.html" > Consent Tracking< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user_directory.html" > User Directory< / a > < / li > < li class = "chapter-item expanded " > < a href = "../message_retention_policies.html" > Message Retention Policies< / a > < / li > < li class = "chapter-item expanded " > < a href = "../modules/index.html" > Pluggable Modules< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../modules/writing_a_module.html" > Writing a module< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../modules/spam_checker_callbacks.html" > Spam checker callbacks< / a > < / li > < li class = "chapter-item expanded " > < a href = "../modules/third_party_rules_callbacks.html" > Third-party rules callbacks< / a > < / li > < li class = "chapter-item ex
2021-06-03 10:21:02 -06:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > Synapse< / h1 >
< div class = "right-buttons" >
< a href = "../print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/event_reports.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
<!-- Page table of contents -->
< div class = "sidetoc" >
< nav class = "pagetoc" > < / nav >
< / div >
< h1 id = "show-reported-events" > < a class = "header" href = "#show-reported-events" > Show reported events< / a > < / h1 >
< p > This API returns information about reported events.< / p >
2022-01-31 09:25:00 -07:00
< p > To use it, you will need to authenticate by providing an < code > access_token< / code >
for a server admin: see < a href = "../usage/administration/admin_api" > Admin API< / a > .< / p >
2021-06-03 10:21:02 -06:00
< p > The api is:< / p >
< pre > < code > GET /_synapse/admin/v1/event_reports?from=0& limit=10
< / code > < / pre >
< p > It returns a JSON body like the following:< / p >
< pre > < code class = "language-json" > {
" event_reports" : [
{
" event_id" : " $bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY" ,
" id" : 2,
" reason" : " foo" ,
" score" : -100,
" received_ts" : 1570897107409,
" canonical_alias" : " #alias1:matrix.org" ,
" room_id" : " !ERAgBpSOcCCuTJqQPk:matrix.org" ,
" name" : " Matrix HQ" ,
" sender" : " @foobar:matrix.org" ,
" user_id" : " @foo:matrix.org"
},
{
" event_id" : " $3IcdZsDaN_En-S1DF4EMCy3v4gNRKeOJs8W5qTOKj4I" ,
" id" : 3,
" reason" : " bar" ,
" score" : -100,
" received_ts" : 1598889612059,
" canonical_alias" : " #alias2:matrix.org" ,
" room_id" : " !eGvUQuTCkHGVwNMOjv:matrix.org" ,
" name" : " Your room name here" ,
" sender" : " @foobar:matrix.org" ,
" user_id" : " @bar:matrix.org"
}
],
" next_token" : 2,
" total" : 4
}
< / code > < / pre >
< p > To paginate, check for < code > next_token< / code > and if present, call the endpoint again with < code > from< / code >
set to the value of < code > next_token< / code > . This will return a new page.< / p >
< p > If the endpoint does not return a < code > next_token< / code > then there are no more reports to
paginate through.< / p >
< p > < strong > URL parameters:< / strong > < / p >
< ul >
< li > < code > limit< / code > : integer - Is optional but is used for pagination, denoting the maximum number
of items to return in this call. Defaults to < code > 100< / code > .< / li >
< li > < code > from< / code > : integer - Is optional but used for pagination, denoting the offset in the
returned results. This should be treated as an opaque value and not explicitly set to
anything other than the return value of < code > next_token< / code > from a previous call. Defaults to < code > 0< / code > .< / li >
< li > < code > dir< / code > : string - Direction of event report order. Whether to fetch the most recent
first (< code > b< / code > ) or the oldest first (< code > f< / code > ). Defaults to < code > b< / code > .< / li >
< li > < code > user_id< / code > : string - Is optional and filters to only return users with user IDs that
contain this value. This is the user who reported the event and wrote the reason.< / li >
< li > < code > room_id< / code > : string - Is optional and filters to only return rooms with room IDs that
contain this value.< / li >
< / ul >
< p > < strong > Response< / strong > < / p >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > id< / code > : integer - ID of event report.< / li >
< li > < code > received_ts< / code > : integer - The timestamp (in milliseconds since the unix epoch) when this
report was sent.< / li >
< li > < code > room_id< / code > : string - The ID of the room in which the event being reported is located.< / li >
< li > < code > name< / code > : string - The name of the room.< / li >
< li > < code > event_id< / code > : string - The ID of the reported event.< / li >
< li > < code > user_id< / code > : string - This is the user who reported the event and wrote the reason.< / li >
< li > < code > reason< / code > : string - Comment made by the < code > user_id< / code > in this report. May be blank or < code > null< / code > .< / li >
< li > < code > score< / code > : integer - Content is reported based upon a negative score, where -100 is
" most offensive" and 0 is " inoffensive" . May be < code > null< / code > .< / li >
< li > < code > sender< / code > : string - This is the ID of the user who sent the original message/event that
was reported.< / li >
< li > < code > canonical_alias< / code > : string - The canonical alias of the room. < code > null< / code > if the room does not
have a canonical alias set.< / li >
< li > < code > next_token< / code > : integer - Indication for pagination. See above.< / li >
< li > < code > total< / code > : integer - Total number of event reports related to the query
(< code > user_id< / code > and < code > room_id< / code > ).< / li >
< / ul >
< h1 id = "show-details-of-a-specific-event-report" > < a class = "header" href = "#show-details-of-a-specific-event-report" > Show details of a specific event report< / a > < / h1 >
< p > This API returns information about a specific event report.< / p >
< p > The api is:< / p >
< pre > < code > GET /_synapse/admin/v1/event_reports/< report_id>
< / code > < / pre >
< p > It returns a JSON body like the following:< / p >
2021-11-01 05:36:20 -06:00
< pre > < code class = "language-json" > {
2021-06-03 10:21:02 -06:00
" event_id" : " $bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY" ,
" event_json" : {
" auth_events" : [
" $YK4arsKKcc0LRoe700pS8DSjOvUT4NDv0HfInlMFw2M" ,
" $oggsNXxzPFRE3y53SUNd7nsj69-QzKv03a1RucHu-ws"
],
" content" : {
" body" : " matrix.org: This Week in Matrix" ,
" format" : " org.matrix.custom.html" ,
" formatted_body" : " < strong> matrix.org< /strong> :< br> < a href=\" https://matrix.org/blog/\" > < strong> This Week in Matrix< /strong> < /a> " ,
" msgtype" : " m.notice"
},
" depth" : 546,
" hashes" : {
" sha256" : " xK1//xnmvHJIOvbgXlkI8eEqdvoMmihVDJ9J4SNlsAw"
},
" origin" : " matrix.org" ,
" origin_server_ts" : 1592291711430,
" prev_events" : [
" $YK4arsKKcc0LRoe700pS8DSjOvUT4NDv0HfInlMFw2M"
],
" prev_state" : [],
" room_id" : " !ERAgBpSOcCCuTJqQPk:matrix.org" ,
" sender" : " @foobar:matrix.org" ,
" signatures" : {
" matrix.org" : {
" ed25519:a_JaEG" : " cs+OUKW/iHx5pEidbWxh0UiNNHwe46Ai9LwNz+Ah16aWDNszVIe2gaAcVZfvNsBhakQTew51tlKmL2kspXk/Dg"
}
},
" type" : " m.room.message" ,
" unsigned" : {
2021-11-01 05:36:20 -06:00
" age_ts" : 1592291711430
2021-06-03 10:21:02 -06:00
}
},
" id" : < report_id> ,
" reason" : " foo" ,
" score" : -100,
" received_ts" : 1570897107409,
" canonical_alias" : " #alias1:matrix.org" ,
" room_id" : " !ERAgBpSOcCCuTJqQPk:matrix.org" ,
" name" : " Matrix HQ" ,
" sender" : " @foobar:matrix.org" ,
" user_id" : " @foo:matrix.org"
}
< / code > < / pre >
< p > < strong > URL parameters:< / strong > < / p >
< ul >
< li > < code > report_id< / code > : string - The ID of the event report.< / li >
< / ul >
< p > < strong > Response< / strong > < / p >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > id< / code > : integer - ID of event report.< / li >
< li > < code > received_ts< / code > : integer - The timestamp (in milliseconds since the unix epoch) when this
report was sent.< / li >
< li > < code > room_id< / code > : string - The ID of the room in which the event being reported is located.< / li >
< li > < code > name< / code > : string - The name of the room.< / li >
< li > < code > event_id< / code > : string - The ID of the reported event.< / li >
< li > < code > user_id< / code > : string - This is the user who reported the event and wrote the reason.< / li >
< li > < code > reason< / code > : string - Comment made by the < code > user_id< / code > in this report. May be blank.< / li >
< li > < code > score< / code > : integer - Content is reported based upon a negative score, where -100 is
" most offensive" and 0 is " inoffensive" .< / li >
< li > < code > sender< / code > : string - This is the ID of the user who sent the original message/event that
was reported.< / li >
< li > < code > canonical_alias< / code > : string - The canonical alias of the room. < code > null< / code > if the room does not
have a canonical alias set.< / li >
< li > < code > event_json< / code > : object - Details of the original event that was reported.< / li >
< / ul >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2022-06-27 04:16:03 -06:00
< a rel = "prev" href = "../usage/administration/admin_api/background_updates.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-06-03 10:21:02 -06:00
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../admin_api/media_admin_api.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2022-06-27 04:16:03 -06:00
< a rel = "prev" href = "../usage/administration/admin_api/background_updates.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-06-03 10:21:02 -06:00
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../admin_api/media_admin_api.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< script type = "text/javascript" src = "../docs/website_files/table-of-contents.js" > < / script >
< / body >
< / html >
