Dynatrace Platform Subscription API - GET usage per environment
Gets the usage data for a Dynatrace Platform Subscription split by monitoring environment.
The request produces an application/json
payload.
GET |
|
Authentication
To execute this request, you need the Allow read access for usage and consumption resources (account-uac-read
) scope assigned to your token. To learn how to obtain and use it, see Authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
accountUuid | string | The ID of the required account. You can find the UUID on the Account > Account management API page, during creation of an OAuth client. | path | required |
subscriptionUuid | string | The UUID of the requested subscription | path | required |
startTime | string | Date as ISO string | query | required |
endTime | string | Date as ISO string | query | required |
environmentIds | string[] | - | query | optional |
capabilityKeys | string[] | - | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | SubscriptionEnvironmentUsageListDto | - |
400 | - | The request was unacceptable, often due to missing a required parameter |
401 | - | The bearer token is incorrect/expired or the requested account information does not match the bearer token |
403 | - | Access denied |
404 | - | The requested resource was not found |
500 | - | Something went wrong on Account Management API's end |
Response body objects
The SubscriptionEnvironmentUsageListDto
object
Element | Type | Description |
---|---|---|
data | SubscriptionEnvironmentUsageDto[] | Subscription usage data |
lastModifiedTime | string | The time the subscription data was last modified in |
The SubscriptionEnvironmentUsageDto
object
Element | Type | Description |
---|---|---|
environmentId | string | The id of the environment |
usage | SubscriptionUsageDto[] | A list of subscription usage for the environment. |
The SubscriptionUsageDto
object
Element | Type | Description |
---|---|---|
capabilityKey | string | The capability key |
capabilityName | string | The name of the capability |
startTime | string | The start time of the capability usage in |
endTime | string | The end time of the capability usage in |
value | number | The usage for the capability |
unitMeasure | string | The unit of measure for the capability usage |
Response body JSON model
1{2 "data": [3 {4 "environmentId": "string",5 "usage": [6 {7 "capabilityKey": "string",8 "capabilityName": "string",9 "startTime": "string",10 "endTime": "string",11 "value": 1,12 "unitMeasure": "string"13 }14 ]15 }16 ],17 "lastModifiedTime": "string"18}