Reporting API

Endpoints behind the reports page, revenue summaries, currency rates and admin analytics.

Reports and revenue

GET/api/reports/data

The aggregated dataset behind the Reports page and its PDF export.

Auth: SessionPermission: reports:read

Query parameters

toISO dateRequired. Exclusive end of the period.
fromISO dateStart of the period. Leave it out for all time.
compareFromISO dateStart of the comparison period; send with compareTo.
compareToISO dateExclusive end of the comparison period.
granularitystringday, week, month or auto (the default) for the trend buckets.
tzstringIANA time zone used to bucket by day, e.g. Asia/Kolkata. Defaults to UTC.

Returns. { kpis, pipeline, series, leads, calls, team, topOpenDeals, topWonDeals } — each metric with its comparison value. Members in restricted lead visibility get their assigned leads only.

GET/api/revenue

Revenue summary.

Auth: SessionPermission: revenue:view

Query parameters

targetnumberA revenue target to compare achievement against.
GET/api/currency/rates

Exchange rates used to display values in your chosen currency.

Auth: Session

Admin analytics

These endpoints back the Admin dashboard and are available to administrators only.

GET/api/admin/stats

Organization totals.

Auth: Session — administrators only

Returns. { totalContacts, totalDeals, totalCallRecordings }

GET/api/admin/trends

Trends over time and current distributions.

Auth: Session — administrators only

Returns. { trends, dealStages, contactStatuses }

GET/api/admin/member-behaviors

Per-member activity — contacts created, deals created and calls made.

Auth: Session — administrators only
GET/api/admin/activity-stream

A live feed of recent activity across the organization.

Auth: Session — administrators only