v1

latestOpenAPI 3.1.02026-07-24173271.4 KB

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.

get/reports/merchandise

Query parameters

clickDateStartstring date required

Start Date

clickDateEndstring date required

End Date

campaignIdsstring

Comma separated list of campaign IDs

subIdsstring

Comma separated list of sub IDs

merchantGroupIdsstring

Comma separated list of merchant group IDs

cuidsstring

Comma separated list of CUIDs (custom tracking IDs)

pageUtmSourcestring

Comma seperated list of page UTM sources

pageUtmMediumstring

Comma seperated list of page UTM mediums

pageUtmCampaignstring

Comma seperated list of page UTM campaings

pageUtmTermstring

Comma seperated list of page UTM terms

pageUtmContentstring

Comma seperated list of page UTM contents

linkUtmSourcestring

Comma seperated list of link UTM sources

linkUtmMediumstring

Comma seperated list of link UTM mediums

linkUtmCampaignstring

Comma seperated list of link UTM campaigns

linkUtmTermstring

Comma seperated list of link UTM terms

linkUtmContentstring

Comma seperated list of link UTM contents

programType'CPC' | 'CPA'

Type of program (CPA/CPC)

sovrnProduct'UNK' | 'ORG' | 'INS' | 'WRA' | 'RAC' | 'RAL' | 'CUP' | 'TPA' | 'PCR' | 'TXT' | 'SHG' | 'PRF'

Sovrn Product

deviceType'DSK' | 'MBL' | 'TBL' | 'UKN'

Type of device

countrystring

Two-letter ISO country code

Response

successful operation