Usage summary

Get Usage Summary

get

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

Authorizations

Query parameters

nextKeystringOptional

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 · dateOptional

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

objectOptionalExample: {"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}]}

get

HTTPcURLJavaScriptPython

GET /v1/usageSummary HTTP/1.1
Host: api.appetize.io
Authorization: Basic username:password
Accept: */*

200

OK

{
  "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
    }
  ]
}