Get Cost Data

GET

/api/v2/analytics/costs/

API endpoint for retrieving overall cost 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 overall cost 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')

Returns:

JSON response containing cost usage data aggregated by date

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/analytics/costs/?bucket_type=day&days=30&end_date=2024-03-31&limit=10&start_date=2024-03-01&time_series=true&type=fixed' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Overall costs data retrieved successfully",
    "data": {
        "costs": [
            [
                {
                    "date": "2024-05-01",
                    "total_cost_USD": "0.00350"
                },
                {
                    "date": "2024-05-02",
                    "total_cost_USD": "0.00425"
                },
                {
                    "date": "2024-05-03",
                    "total_cost_USD": "0.00298"
                }
            ]
        ]
    }
}

Get Corpus Indexing Mode Data

Get Document Count Data