Skip to content

Commit 5909bae

Browse files
author
Vlad Velici
committed
Add message/client-summary endpoint docs
1 parent 124c882 commit 5909bae

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

src/pages/docs/api/rest-api.mdx

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -991,7 +991,7 @@ Example request:
991991
992992
<Code>
993993
```shell
994-
curl https://rest.ably.io/channels/rest-example/messages/01726585978590-001@abcdefghij:001/annotations?limit=100 \
994+
curl https://rest.ably.io/channels/mutable:channel/messages/01726585978590-001@abcdefghij:001/annotations?limit=100 \
995995
-u "{{API_KEY}}"
996996
```
997997
</Code>
@@ -1032,6 +1032,40 @@ A successful request returns a [paginated response](#pagination) with an array c
10321032
```
10331033
</Code>
10341034
1035+
### Retrieve annotation summary for a client <a id="annotations-client-summary" />
1036+
1037+
#### GET rest.ably.io/channels/\{channelId\}/messages/\{messageSerial\}/client-summary
1038+
1039+
Retrieve the annotation summary for a specific `clientId` for a specific message identified by its serial.
1040+
1041+
Example request:
1042+
1043+
<Code>
1044+
```shell
1045+
curl https://rest.ably.io/channels/mutable:channel/messages/01726585978590-001@abcdefghij:001/client-summary?forClientId=client1 \
1046+
-u "{{API_KEY}}"
1047+
```
1048+
</Code>
1049+
1050+
##### Parameters
1051+
1052+
| Parameter | Description | Type |
1053+
|-----------|-------------|------|
1054+
| forClientId | The `clientId` to retrieve the annotation summary for. Defaults to the `clientId` of the authenticated client. | string |
1055+
1056+
##### Options
1057+
1058+
| Option | Value |
1059+
|--------|-------|
1060+
| Accept | `application/json` (the default), `application/x-msgpack` |
1061+
| Auth required | yes ([basic](#basic-authentication) or [token](#token-authentication)) |
1062+
1063+
##### Returns
1064+
1065+
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`.
1066+
1067+
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.
1068+
10351069
### Retrieve instantaneous presence status for a channel <a id="presence" />
10361070
10371071
#### GET main.realtime.ably.net/channels/\{channelId\}/presence

0 commit comments

Comments
 (0)