Cost breakdown

GET

https://localhost:8080/api/v1/analytics/costs

GET

/api/v1/analytics/costs

1 curl -G https:https://localhost:8080/api/v1/analytics/costs \
2      -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken1234567890" \
3      -H "X-Workspace-Id: a3f1c9e2-4b7d-4f8a-9c2e-1d2f3b4c5d6e" \
4      -H "Content-Type: application/json" \
5      -d dateFrom=2024-05-01 \
6      -d dateTo=2024-05-31 \
7      -d departmentId=d7e8f9a0-b1c2-3d4e-5f6a-7b8c9d0e1f2a

200Retrieved

1 {
2   "data": {
3     "agents": [
4       {
5         "agentId": "agent-12345",
6         "agentName": "Alice Johnson",
7         "departmentId": "d7e8f9a0-b1c2-3d4e-5f6a-7b8c9d0e1f2a",
8         "departmentName": "Marketing",
9         "totalCost": 12500.75,
10         "spendChangePercent": 4.5
11       },
12       {
13         "agentId": "agent-67890",
14         "agentName": "Bob Smith",
15         "departmentId": "d7e8f9a0-b1c2-3d4e-5f6a-7b8c9d0e1f2a",
16         "departmentName": "Marketing",
17         "totalCost": 9800
18       }
19     ],
20     "departments": [
21       {
22         "departmentId": "d7e8f9a0-b1c2-3d4e-5f6a-7b8c9d0e1f2a",
23         "departmentName": "Marketing",
24         "totalCost": 22300.75,
25         "spendChangePercent": 3.2
26       },
27       {
28         "departmentId": "e1f2a3b4-c5d6-7e8f-9a0b-1c2d3e4f5a6b",
29         "departmentName": "Sales",
30         "totalCost": 31000,
31         "spendChangePercent": -1.1
32       }
33     ]
34   }
35 }

By agent and department. owner/admin/viewer.

Query parameters

dateFromstringOptional

YYYY-MM-DD

dateTostringOptional

YYYY-MM-DD

departmentIdstringOptional

Department UUID; when set, returns breakdown scoped to this department

Response

Wrapped as {“data”: AnalyticsCostsResponse}. Each cost item: spendChangePercent is JSON null when not computable.

Headers

Query parameters

Response