The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Account Export API

The Marketing Cloud Personalization Account Export API helps you retrieve account-level data from datasets such as segments, engagement scores, change in engagement scores, and customer activity for use in other systems.

Your Personalization contract defines the volume of records you can export using the Account Export API. For more information, refer to your contract or contact your account representative.

Export account data from a Personalization dataset.

GET /api/dataset/<datasetId>/accounts.< json | csv >

https://<accountName>.<instance>.evergage.com/api/dataset/<datasetId>/accounts.< json | csv >

URL ParameterRequired?Description
accountNameYesThe Personalization account name. You can find the accountName by accessing Gears from the Personalization UI and reviewing the URL. For example, if the Gears URL is https://demo.us-1.evergage.com/, then the account name is demo.
instanceYesThe Personalization instance identifier. You can find this value by accessing Gears from the Personalization UI and reviewing the URL. For example, if the Gears URL is https://demo.us-1.evergage.com/, then the instance identifier is us-1.
datasetIdYesThe name or identifier of the Personalization dataset you’re exporting account data from.
filterNoOptional Segment name or ID
startNoOptional start time in epoch milliseconds used for engagement statistics
endNoOptional end time in epoch milliseconds used for engagement statistics
segmentationIdNoOptional segmentation identifier
segmentIdNoOptional segment identifier
pageSizeNoNumber of records to return. Returns all records unless specified.
pageNoPage number of records to show, starting at zero for the first page. Starts at zero unless specified.

Authorization: Basic <base64-encoded-API-token>

The Account Export API uses API tokens to authenticate requests. Your API token must be a strict Base64 encoding of your API Key ID and its API Secret Key, separated by a colon. You can use an existing API token if it has the required permissions. Alternatively, you can ask an account administrator to generate a new one from the Personalization UI. For more information on API tokens, see Personalization API Tokens on Salesforce Help.

Alternatively, if you use cURL to interact with the API, you can send your API Key ID and its API Key Secret using the -u "apiKeyId:apiKeySecret" command-line option. cURL automatically converts the apiKeyId:apiKeySecret pair into a Base64-encoded string and adds the Authorization: Basic <base64-encoded-API-token> to the request header. For an example of how to pass your API credentials in a cURL request, refer to the Example section in this article.

The following is an example GET request sent using cURL that retrieves account data in the JSON format from the specified Personalization dataset.

The following example request passes API credentials using the -u command-line option.

The preceding example cURL request generates the following example response in the JSON format.