summary refs log tree commit diff
path: root/docs/admin_api/event_reports.md
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2024-12-16 11:27:34 -0800
committerGitHub <noreply@github.com>2024-12-16 13:27:34 -0600
commit8208186e3cc597fbf27862a1df816d209ccd21bd (patch)
treecab4d1504ddf3e10be803c2f22ba3779b6e87f51 /docs/admin_api/event_reports.md
parentBump http from 1.1.0 to 1.2.0 (#18013) (diff)
downloadsynapse-8208186e3cc597fbf27862a1df816d209ccd21bd.tar.xz
Add some useful endpoints to Admin API (#17948)
- Fetch the number of invites the provided user has sent after a given
timestamp
- Fetch the number of rooms the provided user has joined after a given
timestamp, regardless if they have left/been banned from the rooms
subsequently
- Get report IDs of event reports where the provided user was the sender
of the reported event
Diffstat (limited to 'docs/admin_api/event_reports.md')
-rw-r--r--docs/admin_api/event_reports.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/admin_api/event_reports.md b/docs/admin_api/event_reports.md

index 83f7dc37f4..9075e92882 100644 --- a/docs/admin_api/event_reports.md +++ b/docs/admin_api/event_reports.md
@@ -60,10 +60,11 @@ paginate through. anything other than the return value of `next_token` from a previous call. Defaults to `0`. * `dir`: string - Direction of event report order. Whether to fetch the most recent first (`b`) or the oldest first (`f`). Defaults to `b`. -* `user_id`: 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. -* `room_id`: string - Is optional and filters to only return rooms with room IDs that - contain this value. +* `user_id`: optional string - Filter by the user ID of the reporter. This is the user who reported the event + and wrote the reason. +* `room_id`: optional string - Filter by room id. +* `event_sender_user_id`: optional string - Filter by the sender of the reported event. This is the user who + the report was made against. **Response**