---
title: "Merchandise"
method: GET
path: "/reports/merchandise"
tags: ["reports"]
---

# Merchandise

`GET /reports/merchandise`

This endpoint is used to query aggregated performance metrics by Merchandise. This data can be used to see individual product performance, your top performing products, actualized earnings, and more, all in real-time. Metrics include Revenue, Sales, and Actions.

## 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

- MerchandiseResponseModel
  - `data` object[]
    - `productName` string
    - `merchantGroupName` string
    - `merchantGroupId` integer
    - `revenue` number
    - `sales` number
    - `actions` number
  - `totals` object
    - `productNameTotal` number
    - `merchantGroupNameTotal` number
    - `merchantGroupIdsTotal` number
    - `revenueTotal` number
    - `salesTotal` number
    - `actionsTotal` number

## Other responses

- `400` — Bad request
- `401` — Authorization information is missing or invalid
- `404` — Merchandise 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)