API Reference

Usage Analytics

Fetch spend, token, latency, status, provider, model, feature and environment analytics for your account. Full Tallyify API keys and provider API keys are never returned.

Endpoint

GET/profile/api-keys/usage🔐 Scope usage:read

Query Parameters

ParameterTypeDefaultDescription
periodstring30d7d, 30d, 90d, all
providerstringAllFilter by provider slug.
search_keystringEmptySearch internal key name, key prefix, or key_alias.

Response

JSON
{
  "summary": {
    "monthly_spend": 18.73,
    "today_spend": 1.42,
    "monthly_tokens": 12483920,
    "top_provider_by_cost": "openai",
    "top_model_by_cost": "gpt-4o-mini",
    "avg_latency_ms": 842,
    "error_rate": 0.42,
    "forecast_end_of_month_spend": 43.10
  },
  "usage": [
    {
      "internal_key_name": "Production Server",
      "key_prefix": "tly_live_abcd123",
      "provider": "openai",
      "model_name": "gpt-4o-mini",
      "key_alias": "openai-prod-main",
      "total_requests": 4821,
      "total_tokens": 12483920,
      "total_cost": 18.73,
      "last_used_at": "2025-03-08T12:00:00Z"
    }
  ],
  "timeseries": [
    { "date": "Mar 01", "requests": 328, "tokens": 841293, "cost": 1.42 }
  ]
}

Code Examples

JavaScript
const res = await fetch(
  'https://api.tallyify.com/profile/api-keys/usage?period=30d',
  { headers: { Authorization: 'Bearer tly_live_yourkey' } }
);
const { summary, usage, timeseries } = await res.json();
console.log(summary.monthly_spend, usage.length, timeseries.length);