.
Analytics Data Connector Workflow
Workflow
The analytics data connector utilizes a set of endpoints to view available reports, execute reports and retrieve the data set. Please follow these steps in order.
1. Request all available reports with GET Report. This endpoint returns a list of reports for which the ReportId which should be captured:
2. And used as the reportId parameter with GET Report Metadata. This endpoint returns metadata information about the report.
See sample report metadata payload
3. Continue to use the reportId and other available filters (within the request body) configured in the report with POST Create Dataset. This endpoint posts a report execution and returns a DatasetId which should be captured:
4. And used as the datasetId parameter with GET Dataset Metadata. This endpoint returns the Status of the report execution which indicates it's availability to be retrieved (Completed).
5. Continue using the datasetId parameter to retrieve the report details using GET Dataset. This endpoint returns a file with the payload to be downloaded.
6. Continue using the datasetId parameter to refresh it with up-to-date data from the report using POST Refresh Dataset. This endpoint posts a report execution and returns both the DatasetId and ReportId for reference: