Merchandise

get

https://viglink.io/v1/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 Params

clickDateStart

date

required

Start Date

clickDateEnd

date

required

End Date

campaignIds

string

Comma separated list of campaign IDs

subIds

string

Comma separated list of sub IDs

merchantGroupIds

string

Comma separated list of merchant group IDs

cuids

string

Comma separated list of CUIDs (custom tracking IDs)

pageUtmSource

string

Comma seperated list of page UTM sources

pageUtmMedium

string

Comma seperated list of page UTM mediums

pageUtmCampaign

string

Comma seperated list of page UTM campaings

pageUtmTerm

string

Comma seperated list of page UTM terms

pageUtmContent

string

Comma seperated list of page UTM contents

linkUtmSource

string

Comma seperated list of link UTM sources

linkUtmMedium

string

Comma seperated list of link UTM mediums

linkUtmCampaign

string

Comma seperated list of link UTM campaigns

linkUtmTerm

string

Comma seperated list of link UTM terms

linkUtmContent

string

Comma seperated list of link UTM contents

programType

string

enum

Type of program (CPA/CPC)

Allowed:

sovrnProduct

string

enum

Sovrn Product

deviceType

string

enum

Type of device

Allowed:

country

string

Two-letter ISO country code

Responses

400

Bad request

401

Authorization information is missing or invalid

404

Merchandise data not found

5XX

Unexpected error

Language

Credentials

Header

Response

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

application/json

200successful operation