Credits

Get Credit Aggregation

post/v1/credits/aggregation

Request

Base URL
https://api.explorium.ai
Auth
- API key in header api_key
- or API key in header api_key
TypeScript
https://skmtc.dev/vibeprospecting/apis/partner-service/docs/v1/credits/aggregation/post.ts
A function with typed inputs. Its response is checked against the schema.

tenantstring

request_contextobject nullable

from_datestring required

ISO 8601 datetime string for start date

to_datestring required

ISO 8601 datetime string for end date

mode'timely' | 'endpoints' required

Aggregation mode

resolution'hour' | 'day' | 'month'

Aggregation resolution (required for timely mode, optional for endpoints mode)

timezonestring

Timezone for aggregation, defaults to UTC

Successful Response

from_datestring required

ISO 8601 datetime string for start date

to_datestring required

ISO 8601 datetime string for end date

modestring required

Aggregation mode

resolution'hour' | 'day' | 'month'

Aggregation resolution (not applicable for endpoints mode)

timezonestring required

Timezone used for aggregation

total_creditsinteger required

Total credits consumed in the period

aggregationsobject[] required

Array of aggregation data points

No recorded changes to this operation across all 1 revision of this API.