Get merchant performance report (aggregate metrics)

post

https://api-sandbox.cardlytics.com/api/v1/partner/merchants/{external_merchant_id}/reports

Returns aggregated performance metrics for a partner-provided merchant over a date range. Supports optional filtering by offer IDs. Defaults: cube=merchant_performance; timeRange.from defaults to 2 years back (max lookback); timeRange.to defaults to today's date.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

external_merchant_id

string

required

Defaults to 67890

Partner-provided merchant identifier

Body Params

Optional filters. If offerIds is omitted or empty, metrics are returned for all offers under the merchant. cube currently supports only merchant_performance. timeRange is optional: from defaults to 2 years back (max lookback) and to defaults to today's date (YYYY-MM-DD).

cube

string

enum

Defaults to merchant_performance

Reporting cube to query. Only 'merchant_performance' is currently supported.

Allowed:

offerIds

array of strings

Optional list of partner offer IDs to filter. Empty or omitted returns all offers for the merchant.

offerIds

timeRange

object

Inclusive date range for the report (YYYY-MM-DD). If omitted: from defaults to 2 years back (max lookback) and to defaults to today's date.

Responses

400

Bad Request – Invalid parameters or date range.

401

Unauthorized – Invalid or missing access token.

500

Internal Server Error – An unexpected error occurred while processing the request.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Aggregated performance for offers under the merchant.