GET /stats

The Ably system can be queried to obtain usage statistics for a given application, and results are provided aggregated across all channels in use in the application in the specified period. Stats may be used to track usage against account quotas.

Servers

Request headers

Name Type Required Description
X-Ably-Version String No

The version of the API you wish to use.

Query parameters

Name Type Required Description
end String No

Default value: "now"

format String No

The response format you would like

Possible values:

  • "html"
  • "jsonp"
  • "msgpack"
  • "json"
limit Integer No
direction String No

Possible values:

  • "backwards"
  • "forwards"

Default value: "backwards"

start String No
unit String No

Specifies the unit of aggregation in the returned results.

Possible values:

  • "month"
  • "day"
  • "minute"
  • "hour"

Default value: "minute"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.