The Insights Export API enables you to export attribute and metric values for Insights accounts or users. Exported data is available for download in CSV format.
You can restrict the export to the accounts or users in particular segments.
The Export API requires the export token for your Insights stream. If you do not know the export token for your Insights stream, submit a request at Zuora Global Support. Zuora Global Support will send the export token to a confirmed Insights administrator. See Global Support Scope for Insights for more information.
To start an export job and download the exported CSV file, you should interact with the Export API in the following order:
List Segments. If you want to export account or user data for particular segments, use List Segments to obtain the unique ID and segment number of each segment. You need the unique IDs in step 3.
You can use the segment numbers to check that you have identified the intended segments. For example, to view the account segment with segment number
120, navigate to:
List Attributes, List Metrics. To view the names of the attributes and metrics that are available for export, use List Attributes and List Metrics. You can also view the names of the available attributes and metrics in Insights settings. For example:
Export Account and User Fields. To start an account or user data export job, use Export Account or User Fields. The
fieldsarray in the request body specifies the attributes and metrics that Insights will include in the data export. For example:
"fields": ["account_balance", "usage_intensity_account"]
segmentsarray in the request body specifies the unique IDs of the segments to export account or user data for. For example:
- Check Export Status. To check whether the export job is complete, use Check Export Status. If the export job is complete, Insights provides the URL of the exported CSV file. You can then download the exported CSV file.
The articles in this section describe the Export API in detail.