Learn how to query an update's viewers using the platform API
Within an update, users can reply and react, attach files, pin important messages to the top, and see who has viewed the conversation.
Queries
Get viewers
- Required scope:
updates:read - Returns an array containing metadata about one or a collection of an update's viewers
- Must be nested within an
updatesquery; can't be queried directly at the root
query {
updates {
viewers {
user_id
medium
user {
name
}
}
}
}Arguments
| Argument | Type | Description |
|---|---|---|
| limit | Int | The number of updates to return. The default is 100. |
| page | Int | The page number to get. Starts at 1. |
Fields
| Field | Type | Description | Possible Values |
|---|---|---|---|
| medium | String! | The channel that the viewers saw the update from. | "email""mobile""web" |
| user | User | The user who viewed the update. | |
| user_id | ID! | The unique identifier of the user who viewed the update. |
