Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Gets the usage data of a usage plan in a specified time interval.

get/usageplans/{usageplanId}/usage#startDate&endDate

Path parameters

usageplanIdstring required

The Id of the usage plan associated with the usage data.

Query parameters

keyIdstring

The Id of the API key associated with the resultant usage data.

startDatestring required

The starting date (e.g., 2016-01-01) of the usage data.

endDatestring required

The ending date (e.g., 2016-12-31) of the usage data.

positionstring

The current pagination position in the paged result set.

limitinteger

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Response

Success

usagePlanIdstring

The plan Id associated with this usage data.

startDatestring

The starting date of the usage data.

endDatestring

The ending date of the usage data.

positionstring
itemsobject

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}</code>, where <code>{api_key}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>.