Skip to main content
GET
Computer Usage Analytics per Member
This endpoint requires an organization analytics API key, generated by an org admin from the Perplexity web app — the same key v1 uses. See Computer Analytics API for setup, per-member semantics, and pagination.

Authorizations

Authorization
string
header
required

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

Query Parameters

dataset
enum<string>
required

The dataset to query. Per-member grouping is currently supported for credit_usage only.

Available options:
credit_usage
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.

Response

Per-member daily credit 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.

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.