Sign in

v24

latestOpenAPI 3.1.0raw.githubusercontent.com2025-12-1152106250.5 KB
Tenant

Get Usage Statistics

Retrieve usage statistics for billing purposes. Returns statistics for document sent and document received actions, grouped by aggregation period (day/week/month). If no date parameters are provided, returns daily stats for all available data.

get/api/stats

Query parameters

start_datestring date nullable

Start date in yyyy-mm-dd format. If not provided, queries from earliest available data.

Start date in yyyy-mm-dd format. If not provided, queries from earliest available data.

end_datestring date nullable

End date in yyyy-mm-dd format. If not provided, queries to latest available data.

End date in yyyy-mm-dd format. If not provided, queries to latest available data.

aggregation'DAY' | 'WEEK' | 'MONTH'

Aggregation type: DAY, WEEK, or MONTH. Defaults to DAY.

Response

Successful Response

tenant_idstring required

Tenant ID

period_startstring date required

Start date of the period

period_endstring date required

End date of the period

aggregation'DAY' | 'WEEK' | 'MONTH' required
total_daysinteger required

Number of days in the period

average_daily_usagenumber required

Average daily usage (total actions / total days)

budget_estimation_daysnumber

Estimated days until credits run out (credit_balance / average_daily_usage). 0.0 if average_daily_usage is 0 or credit_balance is None