Usage
Get credit usage
Returns credit usage history for the project. Without filters, returns project-level totals. Add profileId to scope to a specific profile, or integrationId to scope to a specific connected account. Use from/to (YYYY-MM) to slice the history. Each entry contains the monthly credit count and a per-platform breakdown.
GET
/v1/usage/Authorization
accessKey x-access-key<token>
In: header
Query Parameters
profileId?string
Return usage for this profile only. Mutually exclusive with integrationId.
integrationId?string
Return usage for this integration only. Mutually exclusive with profileId.
from?string
Inclusive start month (YYYY-MM). Filters the usage history array.
Match
^\d{4}-(0[1-9]|1[0-2])$to?string
Inclusive end month (YYYY-MM). Filters the usage history array.
Match
^\d{4}-(0[1-9]|1[0-2])$Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/usage/"{
"success": true,
"totalUsage": 0,
"usage": [
{
"year": 0,
"month": 1,
"count": 0,
"platform": {
"property1": 0,
"property2": 0
}
}
]
}{
"success": true,
"message": "string"
}{
"success": true,
"message": "string"
}