Get usage information for the last month
GET {{baseUrl}}/usage?aid=1234&expand=test
This endpoint returns usage for the current period. It provides visibility across all account groups within an organization. To access this endpoint, you need the View Billing permission (a management permission). If you have access to view billing in multiple organizations, query the endpoint using an aid querystring parameter (see optional parameters, below) from each organization.
Note: Access to billing information older than one month is not supported by this endpoint.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
aid | number | A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. | |
expand | string | Expands the available resources. By default, no expansion takes place if the expand query parameter is not passed. For example, to expand the "tests" resource, pass the query '?expand=test'. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"usage":{"quota":{"monthStart":"2020-01-05T08:00:00Z","monthEnd":"2020-02-05T08:00:00Z","cloudUnitsIncluded":4320000000,"endpointAgentsIncluded":200,"endpointAgentsEssentialsIncluded":10,"endpointAgentsEmbeddedIncluded":10,"enterpriseAgentsIncluded":25},"cloudUnitsUsed":8500489,"cloudUnitsProjected":20993812,"cloudUnitsNextBillingPeriod":25123456,"enterpriseUnitsUsed":79640902,"enterpriseUnitsProjected":108016317,"enterpriseUnitsNextBillingPeriod":0,"connectedDevicesUnitsUsed":79640902,"connectedDevicesUnitsProjected":108016317,"connectedDevicesUnitsNextBillingPeriod":0,"endpointAgentsUsed":42,"endpointAgentsEssentialsUsed":5,"endpointAgentsEmbeddedUsed":5,"enterpriseAgentsUsed":58,"enterpriseAgentUnits":[{"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"}],"tests":[{"aid":"1234","testId":"1158","accountGroupName":"Documentation","testName":"https://app.thousandeyes.com","testType":"Web-Page Load","cloudUnitsUsed":14050,"cloudUnitsProjected":340674},{"aid":"12345","testId":"1159","accountGroupName":"Documentation","testName":"https://support.thousandeyes.com","testType":"Web - HTTP Server","cloudUnitsUsed":64390,"cloudUnitsProjected":164457}],"endpointAgents":[{"aid":"1234","accountGroupName":"Support","endpointAgentsUsed":22},{"aid":"12345","accountGroupName":"Documentation","endpointAgentsUsed":14}],"endpointAgentsEssentials":[{"aid":"1234","accountGroupName":"Support","endpointAgentsEssentialsUsed":2},{"aid":"12345","accountGroupName":"Documentation","endpointAgentsEssentialsUsed":3}],"endpointAgentsEmbedded":[{"aid":"1234","accountGroupName":"Support","endpointAgentsEmbeddedUsed":2},{"aid":"12345","accountGroupName":"Documentation","endpointAgentsEmbeddedUsed":3}],"enterpriseAgents":[{"aid":"1234","accountGroupName":"Support","enterpriseAgentsUsed":7},{"aid":"12345","accountGroupName":"Documentation","enterpriseAgentsUsed":1}]},"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"esse do","deprecation":"consequat do et","name":"ea amet in","profile":"sint ullamco","title":"in enim","hreflang":"ea ullamco nulla aliquip"}}}