- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership
resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership
resource.
Requires user authentication. To list events, the authenticated user must be a member of the space.
For an example, see List events from a Google Chat space.
HTTP request
GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Resource name of the Google Chat space where the events occurred. Format: |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an |
pageToken |
A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
filter |
Required. A query filter. You must specify at least one event type ( Optionally, you can also filter by start time (
To specify a start or end time, use the equals For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
Request body
The request body must be empty.
Response body
Response message for listing space events.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"spaceEvents": [
{
object ( |
Fields | |
---|---|
spaceEvents[] |
Results are returned in chronological order (oldest event first). Note: The |
nextPageToken |
Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.readonly
For more information, see the Authorization guide.