APG PayAPG Paydocs

API reference

Reporting

50 endpoints

A report dataset is something a dashboard can ask questions of: the dimensions it can be grouped and filtered by, the measures it adds up, and the time grains it buckets by. Read one to render a report builder without hard-coding anything, then ask it a question with POST /report-queries.

A filter is always filled from a lookup, never typed. A dimension whose lookup is Search is found by typing part of a name into dimension-values; what comes back is the value to filter by, with the name beside it. That is how a merchant filter works: search Acme, pick Acme Pty Ltd, filter by its mcht_ id. The values page by cursor: pass nextStartingAfter back as startingAfter for the next page.

Only the dimensions this caller may see are listed, and a dataset this caller may not read is not listed at all.

A caller no tenant bounds, the platform's own staff, is shown only the datasets of the reporting areas it holds: ReportsAcquiring_Query for payments, funds and finance, ReportsLending_Query, ReportsCustomers_Query and ReportsOperations_Query for Cube health. A dataset outside them answers as one that does not exist, as does a question narrowed to a tenant outside the caller's reach.

GET/report-datasets/{reportDatasetId}
RBAC
GET/report-datasets
RBAC
GET/report-datasets/{reportDatasetId}/dimension-values
RBAC
GET/report-ranges/{reportRangeId}
RBAC
GET/report-ranges
RBAC
POST/report-queries
ADT
RBAC
POST/report-query-batches
ADT
RBAC
POST/report-exports
ADT
RBAC
POST/report-query-plans
ADT
RBAC
GET/report-spaces/{reportSpaceId}
RBAC
GET/report-spaces
RBAC
POST/report-spaces
ADT
RBAC
PATCH/report-spaces/{reportSpaceId}
ADT
RBAC
DELETE/report-spaces/{reportSpaceId}
RBAC
GET/report-charts/{reportChartId}
RBAC
GET/report-charts
RBAC
POST/report-charts
ADT
RBAC
PATCH/report-charts/{reportChartId}
ADT
RBAC
DELETE/report-charts/{reportChartId}
RBAC
GET/report-dashboards/{reportDashboardId}
RBAC
GET/report-dashboards
RBAC
POST/report-dashboards
ADT
RBAC
PATCH/report-dashboards/{reportDashboardId}
ADT
RBAC
DELETE/report-dashboards/{reportDashboardId}
RBAC
GET/report-notebooks/{reportNotebookId}
RBAC
GET/report-notebooks
RBAC
POST/report-notebooks
ADT
RBAC
PATCH/report-notebooks/{reportNotebookId}
ADT
RBAC
DELETE/report-notebooks/{reportNotebookId}
RBAC
GET/report-pins/{reportPinId}
RBAC
GET/report-pins
RBAC
POST/report-pins
ADT
RBAC
PATCH/report-pins/{reportPinId}
ADT
RBAC
DELETE/report-pins/{reportPinId}
RBAC
GET/report-hidden-dashboards/{reportHiddenDashboardId}
RBAC
GET/report-hidden-dashboards
RBAC
POST/report-hidden-dashboards
ADT
RBAC
DELETE/report-hidden-dashboards/{reportHiddenDashboardId}
RBAC
POST/report-asks
RBAC
GET/report-conversations/{reportConversationId}
RBAC
GET/report-conversations
RBAC
POST/report-conversations
RBAC
DELETE/report-conversations/{reportConversationId}
RBAC
POST/report-conversations/{reportConversationId}/messages
RBAC
GET/exports/{exportId}
RBAC
GET/exports
RBAC
POST/exports
ADT
RBAC
PATCH/exports/{exportId}
ADT
RBAC
DELETE/exports/{exportId}
RBAC
POST/reports
ADT
RBAC