GET

/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates

https://azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates

Query aggregated Azure subscription consumption data for a date range.

Access Token Required: API Key

Query Params

reportedStartTimestringrequired

The start of the time range to retrieve data for.

reportedEndTimestringrequired

The end of the time range to retrieve data for.

showDetailsstring

`True` returns usage data in instance-level detail, `false` causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime).

aggregationGranularitystring

`Daily` (default) returns the data in daily granularity, `Hourly` returns the data in hourly granularity.

continuationTokenstring

Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request GET \ 2 --url 'https://azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Commerce/UsageAggregates' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'