API Reference
Log In
API Reference

Get cost by agent

Returns one cost value in USD per agent for the whole window, with no time buckets. group chooses how calls are combined: TOTAL sums their cost; MEAN, MEDIAN, MAXIMUM and MINIMUM give the cost of a single call. For one value per agent per time bucket, use GET /v2/api/sources/metrics/ai/cost-metrics-by-agents-over-time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

ID of the team that owns this data.

string
enum

Predefined time window to aggregate results (e.g., TWELVE_MONTHS). Ignored if both startDate and endDate are provided. Defaults to TWELVE_MONTHS when no custom date range is specified.

string

Start of a custom date range in ISO 8601 format (e.g., 2025-09-01T00:00:00Z). Must be provided together with endDate. When both are provided, the period parameter is ignored and this custom range is used instead.

string

End of a custom date range in ISO 8601 format (e.g., 2025-09-30T23:59:59Z). Must be provided together with startDate. When both are provided, the period parameter is ignored and this custom range is used instead.

string
enum

Aggregation group for the metric.

Allowed:
agents
array of strings

Optional list of agent identifiers to include. Omit to include all agents.

agents
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*