Get Token Data

GET

/api/v2/token-counts/

API endpoint for retrieving overall token usage data aggregated by date.

Version:

2.1.0

Changelog:

v2.1.0: Added time series data support with bucket_type parameter

v2.0.0: New API version for token usage data.

GET Parameters:

type (str): Query type ('fixed' or 'range')
days (int): Number of days to look back (for 'fixed' type)
start_date (str): Start date in ISO format (for 'range' type)
end_date (str): End date in ISO format (for 'range' type)
time_series (bool): Whether to return data in time series format
bucket_type (str): Type of time bucket ('day', 'week', 'month')
limit (int): Number of top entities to return per date bucket (default: 10)

Returns:

JSON response containing token usage data aggregated by date, including prompt,
completion and total tokens

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/token-counts/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Overall token usage data retrieved successfully",
    "data": {
        "token_usage": [
            [
                {
                    "date": "2024-05-01",
                    "prompt_tokens": 35820,
                    "completion_tokens": 12450,
                    "total_tokens": 48270
                },
                {
                    "date": "2024-05-02",
                    "prompt_tokens": 42530,
                    "completion_tokens": 15640,
                    "total_tokens": 58170
                },
                {
                    "date": "2024-05-03",
                    "prompt_tokens": 38950,
                    "completion_tokens": 13720,
                    "total_tokens": 52670
                }
            ]
        ]
    }
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Get Query Count Data

Get Chat Log Details