diff --git a/content/api/rest-api.textile b/content/api/rest-api.textile index fdae78ee04..95a1c11706 100644 --- a/content/api/rest-api.textile +++ b/content/api/rest-api.textile @@ -675,6 +675,32 @@ bc[json]. [{ extras: , }] +h3(#annotations-client-summary). Retrieve annotation summary for a specific clientId + +h6. GET rest.ably.io/channels/@@/messages/@@/client-summary + +Retrieve the annotation summary for a specific clientId for a specific message identified by its serial. + +Example request: + +bc[sh]. curl https://rest.ably.io/channels/rest-example/messages/01726585978590-001@abcdefghij:001/client-summary?forClientId=client1 \ + -u "{{API_KEY}}" + +h5. Parameters + +- forClientId := _client1_ The clientId to retrieve the annotation summary for. It defaults to the clientId of the authenticated client. + +h5. Options + +- Accept := @application/json@ by default, or @application/x-msgpack@ +- Auth required := yes ("basic":#basic-authentication or "token":#token-authentication) + +h5. Returns + +A successful request returns an object containing the annotation summary for the specified message, clipped to only include the summary for the requested clientId. + +The summary is an object whose keys are annotation types, and the values are aggregated summaries for that annotation type. + h2(#push). Push h3(#post-device-registration). Register a device for receiving push notifications