The UsageReport method retrieves the usage data for the specified period.
Method Definition
URL: <Environment URL>/Account/UsageReport
UsageReport Method Result Definition
JSON Properties | Description | Data Type |
apiMetrics |
API usage metrics, including search calls, article fetch calls, and total API call counts. |
|
referenceNumber | A unique number that identifies or tags a request |
|
success | Flag that indicates whether the process succeeded. |
|
message | Result message. |
|
Sample
Sample Name | Sample Code |
Sample Request JSON |
{ "startDate": "2024-12-01", "endDate": "2025-01-10" } |
Sample Response JSON |
{ "apiMetrics": { "searchCallCount": 2, "articleFetchCallCount": 2, "totalApiCallCount": 4 }, "referenceNumber": "64e683b4d3b54957ad9b769ff14762e5", "success": true, "message": [], } |