Consumer Data Access API

This document assumes that the reader has already created an API user and is capable of obtaining a token via the Monetate Auth API's /refresh endpoint. If you're unfamiliar with these steps, refer to Manage API Keys.

Various privacy policies and regulations give consumers the right to request that a company provide access to all the data that the company has collected about them. To help comply with these regulations, Monetate provides an API endpoint that accepts a customer ID that you provide and for which you can receive a response containing all the data associated to that ID.

Access Endpoint

Make a GET request to the following endpoint:

Consumer Data Access Endpoint


Submit a support ticket using the

 to obtain your account's retailerShortname if you don't know it.

Substitute a different customer_id to access data about the customer associated with that ID.

Example Request


Response

The response to a successful request includes the following headers:

  • content-type: text/csv; charset=utf-8
  • content-Disposition: attachment; filename={retailerShortname}_{customer_id}_{ISO8601 timestamp}.csv

The body contains concatenated CSVs with headers of all facts that Monetate can associate with that customer ID. Here's an example response:

Example Response


Response Codes

The possible response codes are as follows:

  • 200 Success.
  • 401 Auth problem. Your token is invalid, your header is incorrectly formatted, or you are trying to use a token from an account from another retailer.

If Monetate has no information it can associate with the submitted customer ID, then you still receive a 200 response but with an empty body.



Updated 27 Sep 2024