Skip to content

Activity, exports, and reporting

The activity system is the account's event log; the export endpoints turn queries into files; and the dashboard endpoints expose the app's reporting. Together they are the raw material for KPI reporting.

Activity feed

MethodPathPurpose
GET/api/internal/activity/The account activity feed (paginated)
GET/api/internal/activity/{uuid}/export/Export an activity artifact
GET/api/internal/activity/{uuid}/export-url/Get a download URL for an export
Activities cover the operational events on the account - imports, exports, skip trace runs, data deliveries. Poll the feed with a since-style cursor from your last seen activity and you have a lightweight change stream for the account.

Dashboards

MethodPathPurpose
GET/api/internal/dashboard/List available dashboards
GET/api/internal/dashboard/{slug}/A dashboard's definition and data
GET/api/internal/dashboard-report/{uuid}/A specific dashboard report

The dashboards the app renders are readable through the API, which means any metric you can see in the app you can pull into your own reporting.

Per-record logs

GET /api/internal/property/{uuid}/logs/ and GET /api/internal/owner/{uuid}/logs/ return the change history of a single record - who changed what, when. This is the ground truth for per-record QA.

Building a KPI report

The pattern for a daily KPI job, using only counting reads:

  1. Define each KPI as a query you can count. Stage tags, statuses, and phone tags all expose properties-count; the property list returns count for any filtered query; dashboards expose the app's own metrics.
  2. Snapshot on a schedule. Once a day, read every count and store the snapshot with a date stamp on your side.
  3. Report deltas, not levels. New-records-today = today's count minus yesterday's. Movement between stages = per-stage deltas.
  4. Verify the pipeline itself. Alert when a count that should always grow goes flat (broken import) or a suppression count stops moving (broken suppression job).

Scheduled exports on filter presets (Filter presets) complement this: counts for the topline numbers, exports when you need the row-level data behind them.