Returns a daily device or API transaction report from the analytics service, for one profile or for the whole server.
overallruns fromstartto the latest day and takes noend.detailandprofile-detailrun fromstarttoend.- The period is at most 366 days.
Authorization
SERVER and COMPANY users. A COMPANY user sees only their own profile: profile_id defaults to it, and any other profile_id answers 403. A SERVER user may pass any profile_id, or none for the server-wide report. BASIC users get 403.
Query parameters
-
the report to run
Values are
overall,detail, orprofile-detail. -
device transactions or API calls
Values are
deviceorapi. -
id of the profile; a COMPANY user's own profile when omitted, the whole server for a SERVER user when omitted
-
first day of the period,
YYYY-MM-DD -
last day of the period,
YYYY-MM-DD; required fordetailandprofile-detail, not accepted foroverall
Responses
-
OK - the analytics service's report, relayed as it answered. A JSON report is returned as is. A CSV report (a header row, then one row per day) is returned as
text/csv; the rows of theoverallreport are put on separate lines. -
Bad Request -
reportortransaction_typeis missing or not one of its values,profile_idis not a positive integer,startorendis missing or not a date,endwas sent with theoverallreport,startis afterend(or after today foroverall), or the period is longer than 366 days. -
Unauthorized - missing or invalid bearer token.
-
Forbidden - the user is a BASIC user, or a COMPANY user asked for another profile's
profile_id. -
Bad Gateway - the analytics service could not be reached, or answered with an error (its HTTP status is in
error_message). The service's address and response body are never returned. -
Service Unavailable - the analytics service is not configured on this server.
curl \
--request GET 'https://api.iformbuilder.com/exzact/api/v81/[servername]/usage?report=overall&transaction_type=device&start=2026-10-01' \
--header "Authorization: Bearer {access_token}"
Date,Count
2026-10-01,5
2026-10-02,7