Export Data from Flex Insights via API
Public beta
Flex Insights (also known as Historical Reporting) is currently available as a public beta release and the information contained in the Flex Insights documentation is subject to change. This means that some features are not yet implemented and others may be changed before the product is declared as generally available. Public beta products are not covered by a Twilio SLA.
Any reference to "Historical Reporting", "Flex Insights API", "Flex Insights Historical Reporting", or "Flex Insights Historical Reporting API" in the Flex Insights documentation refers to Flex Insights.
Learn how to export reports from within Insights to store the data in a warehouse of your own with this guide.
The export process consists of the following steps:
- Log in to the API to retrieve a Super Secret Token (SST)
- Retrieve a Temporary Token (TT) used for subsequent API calls
- Export the report
- Log out
Before you start exporting data you will need to have:
- a provisioned Flex Insights Workspace
- the credentials of a user with access to the Insights Workspace
- a table report that contains data you need to export
- REST API client support for cookies that are used to pass authentication tokens
Ensure that you are authenticated against the Flex Insights API by having a valid TT (temporary token).
The procedure is detailed at API General Usage
Exporting the raw report is useful for getting machine-friendly data from any report created from your Flex Insights Analytics Portal. You will need the ID of the workspace and ID of the report object to export the data.
Workspace ID: Log in to the Analytics Portal and check the URL in the browser address bar. For example:
The workspace ID is the string appearing between the #s=/gdc/workspaces/ segment and the vertical bar. In this case, the workspace ID qx8vgewnj2hyemje8f6bkrkbyqk8psrf.
Object ID: Within Analytics Portal navigate to the report you'd like to export, and check the URL in the address bar. It may look like this:
Object ID is the numerical expression at the very end of the URL and is typically preceded by obj/ segment. In the example above, Object ID is 643040.
Warning
The maximum report size for raw exports is 1GB. Exporting a report of this size may take minutes.
1curl --location --request POST 'https://analytics.ytica.com/gdc/app/projects/{workspace_id}/execute/raw' \2--header 'Accept: application/json' \3--header 'Content-Type: application/json' \4--header 'Cookie: GDCAuthTT=XXXXX-XXXXX-XXXXX' \5--data-raw '{6"report_req": {7"report": "/gdc/md/{workspace_id}/obj/{object_id}"8}9}'
Output
1{2"uri": "/gdc/projects/{workspace_id}/execute/raw/{download_id}"3}
Download the report by using URI from previous export.
Info
If you receive 202 response from API, it means that the request is accepted, but not ready to be delivered (still computing or preparing the CSV).
Since the export API can take several seconds, or minutes in edge cases, depending on the volume of data and number of columns, you need to add a retry in case the server returns 202. The data is only ready to download when the server returns 200.