User Usage

Description

This API returns your total credit usage for a specified date range. After receiving a successful response, you can download the usage report as an Excel file using the Download button.

Request Parameters

reportOption (optional)
A predefined date range. Supported values:

- "Today"
- "Yesterday"
- "Last 7 days"
- "Last 30 days"
- "This month"
- "Last Month"

Date Range
startDate (optional)
The start date of a custom date range, in dd-mm-yyyy format.
Example: 01-06-2025
endDate (optional)
The end date of a custom date range, in dd-mm-yyyy format.
Example: 30-06-2025

Note: Use either reportOption or a custom date range (startDate and endDate). Do not provide both in the same request.

This API is rate-limited to 100 requests per minute per user.

API Request & Response Guidelines

🟢 200 OK

Usage Report Generated Successfully

Returned when usage data is successfully fetched and exported as an Excel file.

Response type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

This endpoint returns a downloadable Excel (.xlsx) file, not JSON.

Request Parameters

{
  "reportOption": "Last 7 days",
  "startDate": "01-06-2025",
  "endDate": "30-06-2025"
}

Field	Type	Description
reportOption	String	Predefined date range (Today, Yesterday, Last 7 days, Last 30 days, This month, Last Month)
startDate	String	Custom start date (dd-mm-yyyy)
endDate	String	Custom end date (dd-mm-yyyy)

Example Response Headers

Content-Disposition: attachment; filename=user-usage.xlsx
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Response Body

Binary Excel file stream: <xlsx binary data>

🟢 200 OK (Business Validation Errors)

No Usage Data Found

Returned when no collections exist for the selected date range.

{
  "status": true,
  "message": "No usage data found for the given date range.",
}

Invalid Report Option

Returned when an unsupported report option is provided.

{
  "status": false,
  "message": "Invalid report option"
}

🟠 401 Unauthorized

Missing or Invalid Authorization

Returned when:

Authorization header is missing

API key is invalid

API key is not associated with a user

{
  "status": false,
  "message": "You are not Authorized"
}

🟠 429 Too Many Requests

Returned when the request limit is exceeded.

Limit:

100 requests per minute per user/API key

{
  "status": false,
  "message": "Rate limit exceeded."
}

🔴 500 Internal Server Error

Unexpected Server Error

Returned when an unexpected error occurs outside normal validation flow.

{
  "status": false,
  "message": "Service unavailable"
}

Generic format:

{
  "status": false,
  "message": "<error message>"
}

Important Note

Consumers of this API should not rely solely on the HTTP status code. Some validation and business-rule failures may return HTTP 200 OK with "status": false in the response body. Always inspect the status field to determine whether the operation succeeded.

Description#

API Request & Response Guidelines#

🟢 200 OK#

Usage Report Generated Successfully#

Request Parameters#

Example Response Headers#

Response Body#

🟢 200 OK (Business Validation Errors)#

No Usage Data Found#

Invalid Report Option#

🟠 401 Unauthorized#

Missing or Invalid Authorization#

🟠 429 Too Many Requests#

🔴 500 Internal Server Error#

Unexpected Server Error#

Important Note#

Request

Responses