Skip to main content
Perplexity

Search documentation

Type to search this documentation.

Usage Analytics per Member

GET

/

v2

/

analytics

/

computer

/

usage

Usage Analytics per Member

curl --request GET \
  --url https://api.perplexity.ai/v2/analytics/computer/usage \
  --header 'Authorization: Bearer <token>'
title="200"
{
  "categories": [
    "Model",
    "Credit Source"
  ],
  "data": [
    {
      "start_time": 1746057600,
      "end_time": 1746144000,
      "results": [
        {
          "user_email": "alice@example.com",
          "count": 900,
          "by_categories": {
            "Model": [
              {
                "category": "claude-opus-4-8",
                "count": 900
              }
            ],
            "Credit Source": [
              {
                "category": "paid",
                "count": 900
              }
            ]
          }
        },
        {
          "user_email": "bob@example.com",
          "count": 500,
          "by_categories": {
            "Model": [
              {
                "category": "claude-sonnet-4-6",
                "count": 500
              }
            ],
            "Credit Source": [
              {
                "category": "promo",
                "count": 500
              }
            ]
          }
        }
      ]
    }
  ],
  "has_more": true,
  "next_page": "eyJwayI6ICJPUkcjLi4uIn0="
}
title="400"
{
  "error": {
    "message": "start_time must be before end_time.",
    "type": "invalid_request",
    "code": 400
  }
}
title="401"
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": 123
  }
}
title="404"
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": 123
  }
}
title="429"
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": 123
  }
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

dataset

enum<string>

required

The dataset to query. query_volume at this grain carries Feature, Project and Comet breakdowns, but not Model or Model Family.

Available options:

credit_usage,

query_volume

group_by

enum<string>

required

The dimension to group each day's usage by. user_email is currently the only supported value.

Available options:

user_email

start_time

integer

required

Window start in unix seconds (UTC), inclusive. Snapped down to the day grid, so the first day can include usage from before this time.

Required range: x >= 0

end_time

integer

Window end in unix seconds (UTC), exclusive. Defaults to now; future values are capped at now. The window may span at most 90 days.

Required range: x >= 0

limit

integer

Member rows per page. Default 50, max 100. A page can span multiple days.

page

string

Opaque pagination cursor from a previous response's next_page. Valid only with the same query parameters it was issued for.

Per-member daily usage for the requested window. Days with no attributable usage are omitted; the analytics store syncs periodically, so recent days may not yet be present.

categories

string[]

required

Category breakdown labels each member row surfaces, in canonical render order. Each label is a key in every row's by_categories.

data

object[]

required

Daily buckets in chronological order, each with one row per member who used credits that day. Days with no attributable usage are omitted.

Show child attributes

has_more

boolean

required

Whether more member rows exist beyond this page.

next_page

string | null

Cursor for the next page; pass as the page parameter with otherwise identical query parameters.

Was this page helpful?

⌘I

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu