Skip to main content
GET
/
api
/
stats
Get Usage Statistics
curl --request GET \
  --url https://api.e-invoice.be/api/stats \
  --header 'Authorization: Bearer <token>'
{
  "tenant_id": "<string>",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "aggregation": "DAY",
  "actions": [
    {
      "action": "DOCUMENT_SENT",
      "stat_date": "2023-12-25",
      "count": 1
    }
  ],
  "total_days": 2,
  "average_daily_usage": 1,
  "budget_estimation_days": 0
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
start_date
string<date> | null

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

​
end_date
string<date> | null

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

​
aggregation
enum<string> | null
default:DAY

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

Available options:
DAY,
WEEK,
MONTH

Response

Successful Response

Statistics response for a tenant.

​
tenant_id
string
required

Tenant ID

​
period_start
string<date>
required

Start date of the period

​
period_end
string<date>
required

End date of the period

​
aggregation
enum<string>
required

Aggregation type used

Available options:
DAY,
WEEK,
MONTH
​
actions
ActionStats · object[]
required

List of action statistics, one entry per aggregation period per action

​
total_days
integer
required

Number of days in the period

Required range: x >= 1
​
average_daily_usage
number
required

Average daily usage (total actions / total days)

Required range: x >= 0
​
budget_estimation_days
number
default:0

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

Required range: x >= 0