Usage Analytics per Member

GET/v2/analytics/computer/usageUsage Analytics per Member

Returns your organization's Perplexity usage broken down per member, as daily buckets. Each day lists one row per member with usage that day, keyed by email. credit_usage carries the same Model and Credit Source breakdown as v1; query_volume carries Feature, Project and Comet. Uses the same organization analytics API key as v1. Only complete UTC days are returned; the in-progress day is never included.

Parameters

datasetstringqueryrequired

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

one of "credit_usage", "query_volume"

group_bystringqueryrequired

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

one of "user_email"

start_timeintegerqueryrequired

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

minimum 0

end_timeintegerquery

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

minimum 0

limitintegerquery

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

pagestringquery

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

Responses

objectComputerUsageV2Response

categoriesarray of stringrequired

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

Show child attributes

dataarray of objectrequired

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

Show array items

end_timeintegerrequired

Day end in unix seconds (UTC), exclusive.

resultsarray of objectrequired

One row per member with credit usage on this day.

Show child attributes

Show array items

One member's credit usage for a single day.

by_categoriesobjectrequired

The member's day broken down by each label in the response's top-level `categories` list.

countintegerrequired

The member's credit total for the day. May exceed the sum of any single breakdown — usage without a category attribution counts toward the total but not the breakdown.

user_emailstringrequired

The member's email. Rows whose member can no longer be resolved to an email are omitted.

start_timeintegerrequired

Day start in unix seconds (UTC), inclusive.

has_morebooleanrequired

Whether more member rows exist beyond this page.

next_pagenull | string

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

Example response

{
  "categories": [
    "Model",
    "Credit Source"
  ],
  "data": [
    {
      "end_time": 1746144000,
      "results": [
        {
          "by_categories": {
            "Credit Source": [
              {
                "category": "paid",
                "count": 900
              }
            ],
            "Model": [
              {
                "category": "claude-opus-4-8",
                "count": 900
              }
            ]
          },
          "count": 900,
          "user_email": "alice@example.com"
        },
        {
          "by_categories": {
            "Credit Source": [
              {
                "category": "promo",
                "count": 500
              }
            ],
            "Model": [
              {
                "category": "claude-sonnet-4-6",
                "count": 500
              }
            ]
          },
          "count": 500,
          "user_email": "bob@example.com"
        }
      ],
      "start_time": 1746057600
    }
  ],
  "has_more": true,
  "next_page": "eyJwayI6ICJPUkcjLi4uIn0="
}

objectAnalyticsErrorResponse

errorobjectrequired

Show child attributes

codeintegerrequired

messagestringrequired

typestringrequired

Example response

{
  "error": {
    "code": 400,
    "message": "start_time must be before end_time.",
    "type": "invalid_request"
  }
}

objectAnalyticsErrorResponse

errorobjectrequired

Show child attributes

codeintegerrequired

messagestringrequired

typestringrequired

Example response

{
  "error": {
    "code": 0,
    "message": "string",
    "type": "string"
  }
}

objectAnalyticsErrorResponse

errorobjectrequired

Show child attributes

codeintegerrequired

messagestringrequired

typestringrequired

Example response

{
  "error": {
    "code": 0,
    "message": "string",
    "type": "string"
  }
}

objectAnalyticsErrorResponse

errorobjectrequired

Show child attributes

codeintegerrequired

messagestringrequired

typestringrequired

Example response

{
  "error": {
    "code": 0,
    "message": "string",
    "type": "string"
  }
}

Examples

datasetrequiredquery parameter

group_byrequiredquery parameter

start_timerequiredquery parameter

end_timequery parameter

limitquery parameter

pagequery parameter

curl -X GET 'https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0'

const response = await fetch('https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.perplexity.ai/v2/analytics/computer/usage?dataset=credit_usage&end_time=0&group_by=user_email&limit=0&page=string&start_time=0");
using var response = await client.SendAsync(request);

{
  "categories": [
    "Model",
    "Credit Source"
  ],
  "data": [
    {
      "end_time": 1746144000,
      "results": [
        {
          "by_categories": {
            "Credit Source": [
              {
                "category": "paid",
                "count": 900
              }
            ],
            "Model": [
              {
                "category": "claude-opus-4-8",
                "count": 900
              }
            ]
          },
          "count": 900,
          "user_email": "alice@example.com"
        },
        {
          "by_categories": {
            "Credit Source": [
              {
                "category": "promo",
                "count": 500
              }
            ],
            "Model": [
              {
                "category": "claude-sonnet-4-6",
                "count": 500
              }
            ]
          },
          "count": 500,
          "user_email": "bob@example.com"
        }
      ],
      "start_time": 1746057600
    }
  ],
  "has_more": true,
  "next_page": "eyJwayI6ICJPUkcjLi4uIn0="
}

{
  "error": {
    "code": 400,
    "message": "start_time must be before end_time.",
    "type": "invalid_request"
  }
}

{
  "error": {
    "code": 0,
    "message": "string",
    "type": "string"
  }
}

{
  "error": {
    "code": 0,
    "message": "string",
    "type": "string"
  }
}

{
  "error": {
    "code": 0,
    "message": "string",
    "type": "string"
  }
}

Search documentation

Skills

Operations

Usage Analytics per Member

Parameters

Responses

Skills

Operations