Analytics Export Service

The Analytics Export Service allows the automated download of Interaction Analytics and Granular Analytics reports — including an A/B testing variant option for Interaction Analytics — via a download link. From a technical perspective, it's a REST API calling an export service. This allows it to be compatible with any BI (Business Intelligence) system.

Availability

The analytics data export is a premium add-on feature, available only to customers with Corporate or Premium subscriptions.

Prerequisite

For using this feature, you will need the following:

• Corporate or Premium subscription

• API key for authentication

• analyticsId, an identifier of the report that you generate

To obtain the API key and the analyticsId, open a support ticket or reach out to your customer success manager. In the request, please make sure to provide the following information:

• Configurations (settingsId values) the export should be provided for.

• Frequency of the reports: monthly / weekly / daily.

• Aggregation types:

  • • Interaction Analytics: {Aggregation} = interaction

    • Granular Analytics: {Aggregation} = granular

    • Interaction + A/B testing Analytics: {Aggregation} = interaction-abvariant

After the analytics data export has been activated for you, you will receive your analyticsId and authentication credentials. You can also find a more information about this process and subscriptions in this knowledge base article.

HTTP request

To export the analytics data, send an HTTP GET request with the following format: {serviceUrl}/download/v2/analytics/{analyticsId}/{filePrefix}

Parameters:

• serviceUrl = https://data-export.service.usercentrics.eu

• analyticsId = An aggregator of different settingsId values. The analytics ID will be provided by Usercentrics Support upon request. For more info, read this knowledge base article.

• filePrefix = Analytics file prefix, defines the output file’s format and content. Example: interaction-2026-01-01

Example request:

curl --location --request GET 'https://data-export.service.usercentrics.eu/download/v2/analytics/analyticsID/interaction-2026-01-01' \
--header 'X-API-Key: your_key'

To generate your HTTP request, you can use the Swagger documentation.

In response, you will get a JSON file, containing an array of download links which are valid for 15 minutes. Example response:

{
    "downloadUrls": [
        "https://storage.googleapis.com/analytics-raw-data-aggregation/analyticsId/file-1?auth=token",
        "https://storage.googleapis.com/analytics-raw-data-aggregation/analyticsId/file-2?auth=token"
    ]
}

filePrefix

The filePrefix defines the output file’s format and content. Usercentrics provides analytics for Interaction Analytics and Granular Analytics on a monthly, weekly and daily basis. The file prefix varies for the different aggregation types and aggregation frequency.

Aggregation type

The aggregation type defines, which analytics you want to receive via the API. The two following options are available:

• Interaction Analytics: {Aggregation} = interaction

• Granular Analytics: {Aggregation} = granular

• Interaction + A/B testing Analytics: {Aggregation} = interaction-abvariant

Frequency

The following table explains how to work with the different aggregation frequencies:

Authentication

To authenticate, send the API key either via header or query parameter:

• HTTP Header: x-api-key: 'your_key'

• Query parameter: apiKey=your_key

Your individual key will be provided by Usercentrics Support upon request. Read this knowledge base article to learn how to receive it.

What does the report look like?

Interaction Analytics Raw Data Export

The following event types are available for Interaction Analytics:

When using the interaction-abvariant aggregation type, the file includes an additional abvariant column, indicating which A/B test variant (e.g. variant0, variant1) the entry belongs to.

Granular Analytics Raw Data Export

There are two different possible values for consent:

Values for action in the raw data: