Usage Analytics

GET/v1/analytics/computer/usageUsage Analytics

Returns your organization's Perplexity usage analytics as a bucketed time series for a single dataset. Requires an organization analytics API key, generated by an org admin from Settings → Organization → Computer in the Perplexity web app. Only complete UTC grid buckets are returned: start_time snaps down to its bucket, and the in-progress bucket is never included. Datasets differ in what they count: credits for credit_usage, queries for query_volume, distinct active members for daily_active_users, and thread counts for the rest. Buckets of daily_active_users are not additive — a member active on several days is counted once per day, so summing them is not the window's active-member count.

Parameters

datasetstringqueryrequired

The dataset to query. query_volume and daily_active_users are daily organization-level datasets: they reject bucket_width=1h and user_email.

one of "credit_usage", "connectors", "artifacts", "skills", "spaces", "workflows", "task_durations", "query_volume", "daily_active_users"

start_timeintegerqueryrequired

Window start in unix seconds (UTC), inclusive. Snapped down to the bucket grid, so the first bucket 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

bucket_widthstringquery

Bucket size. Buckets align to the UTC grid. Not accepted as 1h for query_volume or daily_active_users, which are stored at day grain.

one of "1d", "1h"

one of "1d", "1h" · default "1d"

limitintegerquery

Buckets per page. 1d: default 7, max 31. 1h: default 24, max 168.

pagestringquery

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

user_emailstring · emailquery

Restrict results to a single member of your organization. Emails that don't match a current member return a generic 400. Not available for query_volume or daily_active_users, which are aggregated per organization; use the v2 endpoint for per-member query volume.

Responses

objectComputerUsageResponse

categoriesarray of stringrequired

Category breakdown labels the requested dataset surfaces, in canonical render order. Each label is a key in every bucket's `by_categories`.

Show child attributes

dataarray of objectrequired

Every bucket in the page's window, in chronological order. Buckets without data carry count 0 and an empty breakdown.

Show child attributes

Show array items

by_categoriesobjectrequired

Category breakdowns for this bucket, keyed by the labels declared in the response's top-level `categories` list. An empty list means the bucket has no data for that breakdown.

countintegerrequired

Bucket total. For credit_usage this may exceed the sum of any single breakdown — usage without a category attribution counts toward the total but not the breakdown.

end_timeintegerrequired

Bucket end in unix seconds (UTC), exclusive.

start_timeintegerrequired

Bucket start in unix seconds (UTC), inclusive.

has_morebooleanrequired

Whether more buckets exist beyond this page. False also when the window's remaining buckets are past the current data frontier.

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": [
    {
      "by_categories": {
        "Credit Source": [
          {
            "category": "paid",
            "count": 250
          },
          {
            "category": "promo",
            "count": 80
          }
        ],
        "Model": [
          {
            "category": "claude-opus-4-8",
            "count": 210
          },
          {
            "category": "claude-sonnet-4-6",
            "count": 120
          }
        ]
      },
      "count": 350,
      "end_time": 1746144000,
      "start_time": 1746057600
    }
  ],
  "has_more": false,
  "next_page": null
}

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

start_timerequiredquery parameter

end_timequery parameter

bucket_widthquery parameter

limitquery parameter

pagequery parameter

user_emailquery parameter

curl -X GET 'https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com'

const response = await fetch('https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com", 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/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.perplexity.ai/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com")
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/v1/analytics/computer/usage?bucket_width=1d&dataset=artifacts&end_time=0&limit=0&page=string&start_time=0&user_email=user%40example.com");
using var response = await client.SendAsync(request);

{
  "categories": [
    "Model",
    "Credit Source"
  ],
  "data": [
    {
      "by_categories": {
        "Credit Source": [
          {
            "category": "paid",
            "count": 250
          },
          {
            "category": "promo",
            "count": 80
          }
        ],
        "Model": [
          {
            "category": "claude-opus-4-8",
            "count": 210
          },
          {
            "category": "claude-sonnet-4-6",
            "count": 120
          }
        ]
      },
      "count": 350,
      "end_time": 1746144000,
      "start_time": 1746057600
    }
  ],
  "has_more": false,
  "next_page": null
}

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

Parameters

Responses

Skills

Operations