Get cost breakdown
GET
/v1/costs/breakdownHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| groupBy | query | environment | agent | source | No | — |
| period | query | day | week | month | year | all | No | — |
| startDate | query | string | No | — |
| endDate | query | string | No | — |
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Cost breakdownapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| groupBy | environment | agent | source | No | — |
| period | string | No | — |
| environments | object[] | No | — |
| environments[].id | string | No | Unique identifier. |
| environments[].name | string | No | Human-readable name. |
| environments[].totalCT | integer | No | — |
| environments[].agentCT | integer | No | — |
| environments[].environmentCT | integer | No | — |
| environments[].threadCount | integer | No | — |
| agents | object[] | No | — |
| agents[].id | string | No | Unique identifier. |
| agents[].name | string | No | Human-readable name. |
| agents[].totalCT | integer | No | — |
| agents[].agentCT | integer | No | — |
| agents[].environmentCT | integer | No | — |
| agents[].threadCount | integer | No | — |
| sources | object[] | No | — |
| sources[].id | string | No | Unique identifier. |
| sources[].name | string | No | Human-readable name. |
| sources[].totalCT | integer | No | — |
| sources[].agentCT | integer | No | — |
| sources[].environmentCT | integer | No | — |
| sources[].threadCount | integer | No | — |