Retrieving API Usage Metrics and Access Rights
New API endpoints have been introduced to provide customer System Administrators with valuable information including which members are using the API, how many calls they are making, and much more.
All authenticated users can access the QuotaPolicy and CurrentQuota endpoints.
/RateLimit.mvc/QuotaPolicy
Returns quota policies that are configured for the instance in an XML result.
Example:
<throttlePolicy trackAllRequests=“True” accessToken=“True”>
<quotas>
<add duration=“60” requestLimit=“10” byteLimit=“10000 ” errorLimit=“5”/>
<add duration=“1” requestLimit=“5”/>
</quotas>
</throttlePolicy>
/RateLimit.mvc/CurrentQuota
Returns quotas being tracked for the requesting Member.
Example:
[
{
“InitiatedDate”: “2023-05-31T17:05:35.1131409Z”,
“Expires”: “2023-05-31T17:06:35.1131409Z”,
“Data”:
{
“TotalRequests”: 1,
“TotalDuration”: 60,
“TotalErrors”: 0,
“TotalSize”: 1568
}
}
]
However, only customer System Administrators can access endpoints to retrieve API usage metrics to track TrackedRequestStats, SystemBuckets, and SystemRequestStats.
/RateLimit.mvc/TrackedRequestStats
Returns total counts per Member for all API requests that have accumulated since the last IIS application pool restart.
`Example:`
`[`
`{`
`“UserIdentity”: “Member:20”,`
`“Bytes”: 10568,`
`“Requests”: 40,`
`“Duration”: 2592,`
`“Errors”: 0,`
`“Rejections”: 4`
`}`
`]`
/RateLimit.mvc/SystemBuckets
Returns quotas being tracked per Member for all Members.
`Example`
`[`
`{`
`“ClientIP”: “127.0.0.1”,`
`“UserIdentity”: “Member:20”,`
`“Buckets”: [`
`{ quota 1 },`
`{ quota 2 }`
`]`
`}`
`]`
/RateLimit.mvc/SystemRequestStats
Returns quotas being tracked and total counts per Member that have accumulated since the last IIS application pool restart.
`Example:`
`[`
`{`
`“ClientIP”: “127.0.0.1”,`
`“CurrentBuckets”: [`
`{ quota 1 },`
`{ quota 2 }`
`],`
`“UserIdentity”: “Member:20”,`
`“Requests”: 40,`
`“Bytes”: 10568,`
`“Duration”: 2592,`
`“Errors”: 0,`
`“Rejections”: 4`
`}`
`]`