Organization summary

⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/analytics/summary

One call for the headline numbers of a period: requests, tokens, spend, active keys and members, compared with the period of the same length just before it. Built for dashboards and weekly reports.

For how this fits into a full workflow, see Usage analytics.

Headers

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys.
syntic-betaYes, while in previewadmin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.

Query parameters

ParameterTypeDefaultDescription
starting_atstringRFC 3339; required. Inclusive.
ending_atstringnowExclusive. At most 92 days after starting_at.
workspace_idstringRestrict to one workspace.

Response

200 OK, Content-Type: application/json

{
  "starting_at": "2026-10-01T00:00:00Z",
  "ending_at": "2026-11-01T00:00:00Z",
  "requests": 1842210,
  "input_tokens": 9120441870,
  "output_tokens": 611204003,
  "cost_usd": "28140.22",
  "active_api_keys": 37,
  "active_members": 64,
  "sessions": 22014,
  "previous_period": {
    "requests": 1510022,
    "cost_usd": "23011.90"
  },
  "change": {
    "requests_pct": 22.0,
    "cost_usd_pct": 22.3
  }
}
FieldTypeDescription
cost_usdstringCredit-billed spend; plan-included usage counts as 0. Matches the cost report for the same range.
previous_periodobjectThe same metrics for the preceding period of equal length.
changeobjectPercent change, one decimal.

Examples

curl -sS "https://app.syntic.ai/v1/organizations/analytics/summary?starting_at=2026-10-01T00:00:00Z&ending_at=2026-11-01T00:00:00Z" \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01"

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?