v1

latestOpenAPI 3.1.02026-07-26189891.1 MB
Usage v2

Get Usage By App

Gets the aggregated usage information for an app matching the name provided as a path parameter during a time period. The results will either have a singular item, or be an empty array.

get/v2/usage/apps/{name}

Path parameters

namestring required

The name of the app from which to get the aggregated usage data.

Query parameters

fromstring required

Start time. A date-time string as defined by the ISO 8601 date format. This date-time will be used to calculate the starting day; the exact time will not be used.

tostring required

End time. A date-time string as defined by the ISO 8601 date format. This date-time will be used to calculate the ending day; the exact time will not be used.

retentionstring

Limit report to apps that contribute to a variable retention pool. Value must be a string indicating the retention pool duration, e.g. 7d for a seven day retention pool.

Response

OK

fromstring

The calculated starting time (exclusive) used internally.

tostring

The calculated ending time (exclusive) used internally.