---
title: "Merchants"
method: GET
path: "/reports/merchants"
tags: ["reports"]
---

# Merchants

`GET /reports/merchants`

This endpoint is used to query aggregated performance metrics by Merchant. This data can be used to see individual merchant performance, your top performing merchants, actualized earnings, and more, all in real-time. Metrics include Revenue, Clicks, Sales, Actions, Conversion Rate and EPC.

## Query parameters

- `clickDateStart` string, date, required
- `clickDateEnd` string, date, required
- `campaignIds` string
- `subIds` string
- `merchantGroupIds` string
- `cuids` string
- `pageUtmSource` string
- `pageUtmMedium` string
- `pageUtmCampaign` string
- `pageUtmTerm` string
- `pageUtmContent` string
- `linkUtmSource` string
- `linkUtmMedium` string
- `linkUtmCampaign` string
- `linkUtmTerm` string
- `linkUtmContent` string
- `programType` 'CPC' | 'CPA'
- `sovrnProduct` 'UNK' | 'ORG' | 'INS' | 'WRA' | 'RAC' | 'RAL' | 'CUP' | 'TPA' | 'PCR' | 'TXT' | 'SHG' | 'PRF'
- `deviceType` 'DSK' | 'MBL' | 'TBL' | 'UKN'
- `country` string

## Response `200`

successful operation

- MerchantsResponseModel — TSR Merchants response model
  - `data` object[]
    - `revenue` number
    - `clicks` number
    - `sales` number
    - `actions` number
    - `conversionRate` number
    - `epc` number
    - `merchantGroupId` integer
    - `merchantGroupName` string
  - `totals` object
    - `revenueTotal` number
    - `clicksTotal` number
    - `salesTotal` number
    - `actionsTotal` number
    - `conversionRateTotal` number
    - `epcTotal` number
    - `merchantGroupIdsTotal` number
    - `merchantGroupNameTotal` number

## Other responses

- `400` — Bad request
- `401` — Authorization information is missing or invalid
- `404` — Merchant data not found
- `5XX` — Unexpected error

---

[API](https://skmtc.dev/sovrn/apis/rest.md) · [All operations](https://skmtc.dev/sovrn/apis/rest/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sovrn/rest/revisions/cb783ced960d/schema)