Reports Overview

Report endpoints return the same data as the matching reports in Shape, as JSON, so you can load them into tools like Tableau.

How reports work

• Request: POST /reports/{report-name}/{crmid}, with filters inside a filters object in the body.
• Scope: each report returns data for the system your API key belongs to. Use the CRM ID and API key for the same system. A corporate CRM ID and key return the corporate system’s data only. To report on every branch, send one request per branch with that branch’s CRM ID and API key.
• Dates: fromDate and toDate take YYYY-MM-DD and are inclusive. There’s no maximum range; use paging for long ranges. Report dates and times are in your system’s time zone.
• Pages: slctPerPage sets results per page (default 50, maximum 500) and pn sets the page number, starting at 1. You’ve reached the last page when a page has fewer results than slctPerPage. Both accept numbers or text.
• Response: every report returns status and msg, with results in data (Data on Call Flow and Email Activity). status is 1 for success and 0 for an error, with the reason in msg (message for API key errors). A report with no results returns status 1 and an empty list.

Example request

{
  "filters": {
    "fromDate": "2026-08-01",
    "toDate": "2026-08-08",
    "slctPerPage": 50,
    "pn": 1
  }
}

Errors

{
  "status": 0,
  "msg": "Invalid Parameters",
  "data": []
}

Report list

User Talk Time and User Call Attempts are GET requests with query parameters; see their pages.