Usage summary

Get Usage Summary

Gets usage summary of all sessions for your account, including number of sessions and session durations.

get

/usageSummary

Authorizations

Query parameters

nextKeystring

If results are truncated, response will include hasMore:true and a nextKey to retrieve the next page. Pass the nextKey value as query parameter into the GET request to retrieve the next batch of results.

Example: xyz

startMonthstring · date

Specify a starting month for the usages summary e.g. '2023-07' will start the usage summary from July 2023.

Example: 2023-05

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.appetize.io/v1/usageSummary' \
  --header 'Authorization: Basic username:password'

200

200

{
  "hasMore": true,
  "nextKey": "xyz",
  "data": [
    {
      "month": "2023-07",
      "publicKey": "p7nww3n6ubq73r1nh9jtauqy8w",
      "numSessions": 325,
      "minutes": 162.5
    },
    {
      "month": "2023-08",
      "publicKey": "p7nww3n6ubq73r1nh9jtauqy8w",
      "numSessions": 102,
      "minutes": 80.3
    }
  ]
}

OK