ThousandEyes API v6
ThousandEyes API v6

Get Usage Details

ThousandEyes API v6 has been deprecated as of May 27, 2024. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.

GET /v6/usage

This endpoint returns usage for the current period. This endpoint requires the View Billing permission (a management permission), and provides visibility across all account groups within the organization. For users who have access to view billing in multiple organizations, query the endpoint using an aid querystring parameter (see optional parameters, below) from each organization.

Billing information (for past months) is not available via this endpoint; this will be implemented as a separate endpoint.

Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • aid={aid} optional, changes the organization context of the current request. If an invalid account group ID is specified as a parameter, the response will come back as an HTTP/400 error. When querying the /usage endpoint, the aid parameter is used to provide usage details for the organization to which the account group ID belongs. The output always provides visibility across all account groups within the specified organization.

Request

  • There is no request body for this request.

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/usage.json \
  -u {email}:{authToken}

Response

Sends back detailed usage information about the organization. Users in roles with insufficient permissions will receive an HTTP/403 response.

Code Snippet
CopyHTTP/1.1 200 OK
Date: Fri, 17 Jan 2020 17:59:14 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept-Encoding
X-Server-Name: r1grs
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 1000
X-Organization-Rate-Limit-Remaining: 999
X-Organization-Rate-Limit-Reset: 1579284000
Strict-Transport-Security: max-age=15724800; includeSubDomains
Strict-Transport-Security: max-age=31536000
X-Content-Type-Options: nosniff

Body

json
Copy{
    "usage": {
        "quota": {
            "monthStart": "2020-01-05 08:00:00",
            "monthEnd": "2020-02-05 08:00:00",
            "cloudUnitsIncluded": 4320000000,
            "enterpriseAgentsIncluded": 0,
            "endpointAgentsIncluded": 200,
            "endpointAgentsEssentialsIncluded": 10,
            "endpointAgentsEmbeddedIncluded": 11
        },
        "cloudUnitsUsed": 8500489,
        "cloudUnitsProjected": 20993812,
        "cloudUnitsNextBillingPeriod": 25123456,
        "enterpriseUnitsUsed": 79640902,
        "enterpriseUnitsProjected": 108016317,
        "enterpriseUnitsNextBillingPeriod": 0,
        "endpointAgentsUsed": 42,
        "endpointAgentsEssentialsUsed": 5,
        "endpointAgentsEmbeddedUsed": 6,
        "enterpriseAgentsUsed": 58,
        "tests": [
            {
                "aid": 315,
                "testId": 1158,
                "accountGroupName": "Documentation",
                "testName": "https://app.thousandeyes.com",
                "testType": "Web - Page Load",
                "cloudUnitsUsed": 140540,
                "cloudUnitsProjected": 340674
            },
            {
                "aid": 315,
                "testId": 1159,
                "accountGroupName": "Documentation",
                "testName": "https://support.thousandeyes.com",
                "testType": "Web - HTTP Server",
                "cloudUnitsUsed": 64390,
                "cloudUnitsProjected": 164457
            },
            [...]
        ],
        "endpointAgents": [
            {
                "aid": 7625,
                "accountGroupName": "Support",
                "endpointAgentsUsed": 22
            },
            {
                "aid": 315,
                "accountGroupName": "Documentation",
                "endpointAgentsUsed": 14
            },
            [...]
        ],
        "endpointAgentsEssentials": [
            {
                "aid": 7625,
                "accountGroupName": "Support",
                "endpointAgentsEssentialsUsed": 1
            },
            {
                "aid": 315,
                "accountGroupName": "Documentation",
                "endpointAgentsEssentialsUsed": 4
            },
            [...]
        ],
        "endpointAgentsEmbedded": [
            {
                "aid": 7625,
                "accountGroupName": "Support",
                "endpointAgentsEmbeddedUsed": 1
            },
            {
                "aid": 315,
                "accountGroupName": "Documentation",
                "endpointAgentsEmbeddedUsed": 5
            },
            [...]
        ],        
        "enterpriseAgents": [
            {
                "aid": 7625,
                "accountGroupName": "Support",
                "enterpriseAgentsUsed": 7
            },
            {
                "aid": 315,
                "accountGroupName": "Documentation",
                "enterpriseAgentsUsed": 1
            },
            [...]
        ],
        "enterpriseAgentUnits": [
            {
                "aid": 7625,
                "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
            },
            [...]
        ]
    }
}

For more information on our HTTP response status codes, see the response status codes documentation.

Next