List Campaigns

GET 
/affiliate-manager/:locationId/campaigns

Retrieve the list of affiliate campaigns for a location.

Request

Version stringrequired

API Version

Available options2021-07-28

locationId stringrequired

Location Id

query string

Filter campaigns whose name contains this text

skip number

Number of campaigns to skip

Possible values: >= 0

Default value:0

limit number

Number of campaigns to return, maximum 100

Possible values: >= 1 and <= 100

Default value:10

onlyActiveLiveMode boolean

Return only campaigns in live mode

Default value:false

trackTypes string[]

Comma separated track types

Available optionsformssurveyscalendersfunnelswebsitesstoreexternal_sourcecommunity

application/json

Successful response

application/json

Schema

Schema

campaignsobject[]required

Campaigns for the location

metaobjectrequired

Pagination metadata

Example (auto)

{
  "campaigns": [
    {
      "_id": "6385d230f6d19db03eef6fb2",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Summer launch",
      "trackType": "funnels",
      "liveMode": true,
      "currency": "USD",
      "cookieLife": 30,
      "commissionType": "percentage",
      "commission": 10,
      "customer": 12,
      "leads": 34,
      "revenue": 1500,
      "commissionAmount": 150
    }
  ],
  "meta": {
    "count": 42
  }
}