Report

Get Global Spend Report

get

Get Daily Spend per Team, based on specific startTime and endTime. Per team, view usage by each key, model [ { "group-by-day": "2024-05-10", "teams": [ { "team_name": "team-1" "spend": 10, "keys": [ "key": "1213", "usage": { "model-1": { "cost": 12.50, "input_tokens": 1000, "output_tokens": 5000, "requests": 100 }, "audio-modelname1": { "cost": 25.50, "seconds": 25, "requests": 50 }, } } ] ] }

Authorizations

APIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeader

Query parameters

start_dateany ofoptional

Time from which to start viewing spend

end_dateany ofoptional

Time till which to view spend

group_byany of · default: "team"optional

Group spend by internal team or customer or api_key

api_keyany ofoptional

View spend for a specific api_key. Example api_key='sk-1234

internal_user_idany ofoptional

View spend for a specific internal_user_id. Example internal_user_id='1234

team_idany ofoptional

View spend for a specific team_id. Example team_id='1234

customer_idany ofoptional

View spend for a specific customer_id. Example customer_id='1234. Can be used in conjunction with team_id as well.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/global/spend/report' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'

200

422

200

[
  {
    "request_id": "text",
    "api_key": "text",
    "model": "text",
    "api_base": "text",
    "call_type": "text",
    "spend": 1,
    "total_tokens": 1,
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "startTime": "text",
    "endTime": "text",
    "user": "text",
    "metadata": null,
    "cache_hit": "text",
    "cache_key": "text",
    "request_tags": null,
    "requester_ip_address": "text",
    "messages": "text",
    "response": "text"
  }
]

Successful Response