Authentication
Authenticate with a Bearer token using your PropelAuth API key from Studio API Keys:REDUCTO_API_KEY used for document processing.
Endpoint
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
startDate | string | 30 days ago | Start date in yyyy-mm-dd format |
endDate | string | Today | End date in yyyy-mm-dd format |
groupBy | string | product | Dimension to group results by. One of: product, feature, api_key, file_type |
orgId | string | API key’s org | Target organization ID. Required if your account belongs to multiple organizations. |
product | string | (none) | Filter by product. Repeatable for multiple values. |
feature | string | (none) | Filter by feature. Repeatable for multiple values. |
apiKey | string | (none) | Filter by API key. Repeatable for multiple values. |
fileType | string | (none) | Filter by file type. Repeatable for multiple values. |
Response
data represents one day and one group value. credits is the total credits consumed and requestCount is the number of API requests made.
Examples
Default: last 30 days grouped by product
Custom date range grouped by file type
Filter by specific products
Use repeatable query parameters to filter results:Multi-Organization Access
If your account belongs to multiple organizations, pass theorgId parameter to specify which organization’s usage to retrieve. Without it, the API defaults to the organization associated with your API key.
403 error.
Error Responses
| Status | Meaning |
|---|---|
401 | Missing or invalid API key |
400 | Invalid groupBy value |
403 | Not a member of the requested organization |
500 | Server error |
Related
Credit Usage
How credits are calculated per endpoint.
Account & Settings
Manage API keys, usage alerts, and billing in Studio.