Get enterprise agent usage
GET {{baseUrl}}/usage/units/enterprise-agents?startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&cursor=
This endpoint returns the organization's enterprise agents usage for a specific time period, or the curent billing cycle if no time period is specified.
In the /v7/usage API, a shared enterprise agent's usage is reported in the account group where the agent was created (i.e Primary Account Group). However in this API, the shared agent's usage is distributed among all the account groups where the tests are running on the particular agent. This API is also only available to customers on usage based pricing model.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startDate | string | Use with the endDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window. | |
endDate | string | Defaults to current time the request is made. Use with the startDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window. | |
cursor | null | (Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"breakdowns":[{"aid":"1234","agentId":"121404","accountGroupName":"Support","agentName":"TEVA-test-agent","enterpriseUnitsUsed":599878,"enterpriseUnitsProjected":597808,"vagentId":"123456"},{"aid":"315","agentId":"121404","accountGroupName":"Documentation","agentName":"lab-physical-appliance-1","enterpriseUnitsUsed":597123,"enterpriseUnitsProjected":597808,"vagentId":"789"}],"_links":{"previous":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"Ut irure mollit","deprecation":"est deserunt nulla","name":"cillum irure","profile":"in adipisicing ullamco Lorem","title":"officia proident","hreflang":"dolor eiusmod est nostrud consequat"},"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"nulla officia velit ex in","deprecation":"magna ipsum","name":"esse Duis Lorem","profile":"sun","title":"magna deserun","hreflang":"nostrud sunt consectetur ipsum"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"occaecat in esse","deprecation":"enim dolor reprehenderit","name":"tempor voluptate nulla sed enim","profile":"laboris","title":"Ut","hreflang":"elit in"}}}