This API allows for extracting raw data, as opposed to aggregated data. You can extract raw data at the pageview or session-level. Exports jobs can be created, run, and downloaded programmatically using this Raw Data API or manually downloaded using the Raw Data Export feature.
If you need to retrieve the aggregated data of your Contentsquare analysis features, you should use the Metrics API.
- Data ownership and flexibility: load and historize Contentsquare data in your data warehouse, implement your own custom computations and reporting
- Cross-device analyses: reconcile data from your Web and Apps projects
- User-centric analyses: understand how users behave across multiple sessions in their journey
- (Re)activation: export behavioral segments and leverage them in your marketing stack
- Data science: mine the granular Contentsquare data and add behavioral dimensions to your models
- Limit your export to what is necessary for fields and rows filtering, segment, and device.
- Identify the Cvars / Dvars (up to 10) that can be exported in separated columns (easier to process down the pipeline).
- Prefer an export in JSON when the data includes fields which values are arrays (list of values) => easy to parse in JSON, more complex in CSV.
- Use the new POST endpoint to automate the creation of jobs and build a full history of data.
Step 1: Create API credentials
Follow these instructions to generate credentials.
Step 2: Query the API
Now that you have created the data exports you want to have regularly and that you have created your API credentials, it’s time to retrieve the data via the API.
For detailed documentation on how the API works and how you can query it continue reading our Raw Data API documentation.
Do queries count towards my monthly request limit?
No. Queries on the Raw Data API's endpoints will not contribute to your monthly request limit for the Open API (that limit can only be reached via requests on the Metrics API endpoints).
What if my export does not download as expected?
Errors that may occur with the Raw Data API do not appear clearly in the UI. If your expected files are not available in the recent export interface, it means an error occurred and you should try again. To check for errors, you can go through the API to the list the job runs: job runs that have failed will have the state 'FAILURE'.
What if I change my segment definitions?
A change in segment definition may require re-exporting the historical data for this segment.