Platform Routes

Integrating the platform will give you a set of routes that you can nest into your current app structure. See here for how to integrate, and nest the DPR routes into you app structure.

The provided routes allow you to run reports either synchronously, or asynchronously

Synchronous routes

Load report

/dpr/view-report/sync/:type/:reportId/:id/load-report
param description
:type report, dashboard
:reportId The report/product ID
:id The variant ID

The route resolves to the report loading page:

  • Displays the meta data about the report while the report is loading
  • Automatically redirects to the report once the report data has loaded

View report

/dpr/view-report/sync/:type/:reportId/:id/report
param description
:type report, dashboard
:reportId The report/product ID
:id The variant ID

Asynchronous routes

Asynchronous reporting is a 3 stage linear process:

  • Request report, with optional filters
  • Execution status polling
  • View report

Routes

Request

/dpr/request-report/:type/:reportId/:id/filters
param description
:type report, dashboard
:reportId The report ID
:id The variant ID

This is the entry point to the reporting process.

The request route is where users will:

  • Apply filters to the master dataset.
  • Apply sorting options.
  • Request the report.

Upon requesting a report the user is navigated to the polling route.

The executionId required for the polling route is returned by the report request.

Polling

/dpr/request-report/:type/:reportId/:id/:executionId/status
param description
:type report, dashboard
:reportId The report ID
:id The variant ID
:executionId The execution ID produced by the report request

The route resolves to the polling page:

  • Shows the user the current status of a report request
  • Polls the for the report status every second
  • Directs the user to the report route when request is finished and the data is loaded.

The tableId required for the view route is returned by the polling endpoint.

View

/dpr/view-report/async/:type/:reportId/:id/:tableId/:type
param description
:loadType async, sync
:type report, dashboard
:reportId The report ID
:id The variant ID
:tableId The ID of the table where the data is stored

The route resolves to the report page:

  • Displays the report, or dashboard