Campaign Cap Listing API

Must use a GET method to run the campaign cap listing API.  Results will return all of your caps for a specified campaign or affiliate/campaign specified in the URL.  

You are able to receive the caps in XML or JSON by including the following in the headers.

  • content-type:application/xml for an xml response
  • content-type:application/json for a json response

Base URL 

/v2/Campaigns/Cap

Parameters

ParameterDescriptionData TypeRequiredFormatting NotesExamplescampaignidThis is a campaign id from your account.Int*YesMust be a valid CID from your account.123456affiliateidThis is an affiliate id from your account.Int*NoRequired if you want to get a list of affiliate / campaign caps. for a specific campaign. Must be a valid AFID from your account.123456

Example URLs

https://api.linktrust.com/v2/Campaigns/Cap?campaignid=123456

https://api.linktrust.com/v2/Campaigns/Cap?campaignid=123456&affiliateid=123456

Example XML Response

<CampaignCapConfig>

<CampaignId>123456</CampaignId>

<CampaignName>Link Test</CampaignName>

<AffiliateId xsi:nil="true" />

<EnableCapEmailNotifications>true</EnableCapEmailNotifications>

<CapEmailAddress>test@test.com</CapEmailAddress>

<Caps>

<CampaignCap>

<CapId>152</CapId>

<CampaignId>123456</CampaignId>

<CapType>Daily</CapType>

<Enabled>true</Enabled>

<AffiliateId>-1</AffiliateId>

<CapValue>10.0000</CapValue>

<IsRevenue>true</IsRevenue>

<EmailNotificationThreshold>30</EmailNotificationThreshold>

<DateLastResetUtc>2016-08-30T19:50:51.297</DateLastResetUtc>

<ExpirationDateUtc>2016-09-02T06:00:00</ExpirationDateUtc>

<CurrentValue>0.0000</CurrentValue>

<HasEmailBeenQueued>false</HasEmailBeenQueued>

<IsMet>false</IsMet>

</CampaignCap>

<CampaignCap>

<CapId>363</CapId>

<CampaignId>123456</CampaignId>

<CapType>Weekly</CapType>

<Enabled>true</Enabled>

<AffiliateId>-1</AffiliateId>

<CapValue>200.0000</CapValue>

<IsRevenue>true</IsRevenue>

<EmailNotificationThreshold>10</EmailNotificationThreshold>

<DateLastResetUtc>2016-08-30T16:13:19.627</DateLastResetUtc>

<ExpirationDateUtc>2016-09-04T00:00:00</ExpirationDateUtc>

<CurrentValue>60.0000</CurrentValue>

<HasEmailBeenQueued>false</HasEmailBeenQueued>

<IsMet>false</IsMet>

</CampaignCap>

<CampaignCap>

<CapId>84</CapId>

<CampaignId>123456</CampaignId>

<CapType>Weekly</CapType>

<Enabled>true</Enabled>

<AffiliateId>-1</AffiliateId>

<CapValue>50.0000</CapValue>

<IsRevenue>false</IsRevenue>

<EmailNotificationThreshold>50</EmailNotificationThreshold>

<DateLastResetUtc>2016-08-12T23:06:37.51</DateLastResetUtc>

<ExpirationDateUtc>2016-09-04T00:00:00</ExpirationDateUtc>

<CurrentValue>16.0000</CurrentValue>

<HasEmailBeenQueued>false</HasEmailBeenQueued>

<IsMet>false</IsMet>

</CampaignCap>

<CampaignCap>

<CapId>378</CapId>

<CampaignId>123456</CampaignId>

<CapType>Monthly</CapType>

<Enabled>true</Enabled>

<AffiliateId>-1</AffiliateId>

<CapValue>100.0000</CapValue>

<IsRevenue>false</IsRevenue>

<EmailNotificationThreshold>20</EmailNotificationThreshold>

<DateLastResetUtc>2016-08-31T17:00:08.96</DateLastResetUtc>

<ExpirationDateUtc>2016-10-01T06:00:00</ExpirationDateUtc>

<CurrentValue>0.0000</CurrentValue>

<HasEmailBeenQueued>false</HasEmailBeenQueued>

<IsMet>false</IsMet>

</CampaignCap>

</Caps>

</CampaignCapConfig>

Example JSON Response

{

"CampaignId": 123456

"AffiliateId": null

"EnableCapEmailNotifications": true

"CapEmailAddress": "test@test.com"

"Caps": [4]

0:  {

"CapId": 152

"CapType": 1

"Enabled": true

"CapValue": 10

"IsRevenue": true

"EmailNotificationThreshold": 30

"CurrentValue": 0

"IsMet": false

}-

1:  {

"CapId": 363

"CapType": 2

"Enabled": true

"CapValue": 200

"IsRevenue": true

"EmailNotificationThreshold": 10

"CurrentValue": 60

"IsMet": false

}-

2:  {

"CapId": 84

"CapType": 2

"Enabled": true

"CapValue": 50

"IsRevenue": false

"EmailNotificationThreshold": 50

"CurrentValue": 16

"IsMet": false

}-

3:  {

"CapId": 378

"CapType": 3

"Enabled": true

"CapValue": 100

"IsRevenue": false

"EmailNotificationThreshold": 20

"CurrentValue": 0

"IsMet": false

}-

-

}