Get Agent Cost Data

GET

/api/v2/analytics/agents/costs

Breaks the cost of the date window down by agent.

Current Version:

2.1.0

Changelog:

2.1.0: Added the time_series and bucket_type parameters.

2.0.0: Initial version.

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Agents with the highest cost first.

Bodyapplication/json

🟠400Forbidden

🟠401405

🟠403Server Error

🟠405

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/analytics/agents/costs?agent_id=&bucket_type=&days=&end_date=&start_date=&time_series=&type=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Totals for the window

{
    "success": true,
    "message": "Agent cost data retrieved successfully",
    "data": {
        "costs": [
            {
                "agent_name": "Support Assistant",
                "prompt_tokens": 81230,
                "completion_tokens": 12044,
                "total_tokens": 93274,
                "total_cost": "2.10300"
            }
        ]
    }
}

Analytics

Get Agent Document Count Data