Retrieve Usage

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "iFormBuilder V80 MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/mcp"
  }
}

Close
GET /usage

Returns a daily device or API transaction report from the analytics service, for one profile or for the whole server.

  • overall runs from start to the latest day and takes no end.
  • detail and profile-detail run from start to end.
  • 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.

Headers

  • Authorization string

    e.g. Bearer {access_token}

Query parameters

  • report string Required

    the report to run

    Values are overall, detail, or profile-detail.

  • transaction_type string Required

    device transactions or API calls

    Values are device or api.

  • profile_id integer

    id of the profile; a COMPANY user's own profile when omitted, the whole server for a SERVER user when omitted

  • start string(date) Required

    first day of the period, YYYY-MM-DD

  • end string(date)

    last day of the period, YYYY-MM-DD; required for detail and profile-detail, not accepted for overall

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 the overall report are put on separate lines.

  • 400

    Bad Request - report or transaction_type is missing or not one of its values, profile_id is not a positive integer, start or end is missing or not a date, end was sent with the overall report, start is after end (or after today for overall), or the period is longer than 366 days.

  • 401

    Unauthorized - missing or invalid bearer token.

  • 403

    Forbidden - the user is a BASIC user, or a COMPANY user asked for another profile's profile_id.

  • 502

    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.

  • 503

    Service Unavailable - the analytics service is not configured on this server.

GET /usage
curl \
 --request GET 'https://api.iformbuilder.com/exzact/api/v80/[servername]/usage?report=overall&transaction_type=device&start=2026-10-01' \
 --header "Authorization: Bearer {access_token}"
Response examples (200)
Date,Count
2026-10-01,5
2026-10-02,7