Get Agent Cost Data

GET

/api/v2/analytics/agents/costs

API endpoint for retrieving cost usage data for specified agents.

Version:

2.0.0

Changelog:

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

v2.0.0: New API version for agent cost usage data.

GET Parameters:

agent_id (list): List of agent IDs to filter by (can be specified multiple times as agent_id=1&agent_id=2)
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 for the specified agents

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Agent costs data retrieved successfully",
    "data": {
        "costs": [
            {
                "agent_name": "Example Agent",
                "prompt_tokens": 1000,
                "completion_tokens": 500,
                "total_tokens": 1500,
                "total_cost": "0.00150"
            }
        ]
    }
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Enable or Disable Guardrail for Organization

Get Agent Document Count Data