Skip to content

Add message/client-summary endpoint docs #3089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vladvelici wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add message/client-summary endpoint docs #3089

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion src/pages/docs/api/rest-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -991,7 +991,7 @@ Example request:

<Code>
```shell
curl https://rest.ably.io/channels/rest-example/messages/01726585978590-001@abcdefghij:001/annotations?limit=100 \
curl https://rest.ably.io/channels/mutable:channel/messages/01726585978590-001@abcdefghij:001/annotations?limit=100 \
-u "{{API_KEY}}"
```
</Code>
Expand Down Expand Up @@ -1032,6 +1032,40 @@ A successful request returns a [paginated response](#pagination) with an array c
```
</Code>

### Retrieve annotation summary for a client <a id="annotations-client-summary" />

#### GET rest.ably.io/channels/\{channelId\}/messages/\{messageSerial\}/client-summary

Retrieve the annotation summary for a specific `clientId` for a specific message identified by its serial.

Example request:

<Code>
```shell
curl https://rest.ably.io/channels/mutable:channel/messages/01726585978590-001@abcdefghij:001/client-summary?forClientId=client1 \
-u "{{API_KEY}}"
```
</Code>

##### Parameters

| Parameter | Description | Type |
|-----------|-------------|------|
| forClientId | The `clientId` to retrieve the annotation summary for. Defaults to the `clientId` of the authenticated client. | string |

##### Options

| Option | Value |
|--------|-------|
| Accept | `application/json` (the default), `application/x-msgpack` |
| Auth required | yes ([basic](#basic-authentication) or [token](#token-authentication)) |

##### Returns

A successful request returns an object containing the annotation summary for the specified message, filtered to only include the summary entries relevant to the requested `clientId`.

The summary is an object whose keys are [annotation types](/docs/messages/annotations#annotation-types), and the values are aggregated summaries for that annotation type.

### Retrieve instantaneous presence status for a channel <a id="presence" />

#### GET main.realtime.ably.net/channels/\{channelId\}/presence
Expand Down