Submit a Ticket My Tickets
Welcome
Login  Sign up

EXPORT CampaignLeadTiers API Version 1

EXPORT CampaignLeadTiers API Version 1

Updated on 2016-02-05
Current Version: Version  1
Deprecated Version: N/A
Requests Allowed: GET/SOAP

 

Summary:

Returns an array of Campaign Lead Tiers

 

Resource/WSDL Page:

http://<your_domain_here>/api/1/export.asmx?op=CampaignLeadTiers

 

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

This api_key will provide you with the ability to export Campaigns for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

campaign_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique campaign. Obtained via EXPORT Campaigns API. Pass 0 for all campaigns. 

 

Example Values: 1234

offer_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique offer.  Obtained via EXPORT Offers API. Pass 0 for all offers

Example Values: 1234

offer_contract_id

Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique offer contracts, Obtained via EXPORT Offers API. Pass 0 for all offer contracts


Example Values: 1234 

affiliate_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique affiliate. Obtained via EXPORT Affiliates API. Pass 0 for all affiliates


Example Values: 1234

account_status_id
Required
Type: INTEGER
Length (Max/Min): N/A

Obtained via Get AccountStatuses API. Pass 0 for all statuses

 

Example Values: 3

media_type_id

Required
Type: INTEGER
Length (Max/Min): 50

Obtained via GET MediaTypes API. Pass 0 for all media types

 

Example Values: 7

 

start_at_row
Required
Type: INTEGER
Length (Max/Min): N/A

Skip to begin export at a specific row. pass 0 to start at beginning of data

 

Example Values: 0

  

row_limit
Required
Type: INTEGER
Length (Max/Min): N/A

Limit the number of rows returned. 0 means no limit

 

Example Values: 0

sort_field
Required
Type: ENUM
Length (Max/Min): N/A

Specify how to sort the data

 

Example Values: campaign_id or date_created

sort_descending
Required
Type: ENUM
Length (Max/Min): N/A

 

Example Values: true, false

 

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example Request

GET

http://demo.cakemarketing.com/api/1/export.asmx/CampaignLeadTiers?api_key=RUxep4nIQQmSAFn4JFECgOMdvJLeocp&campaign_id=0&offer_id=1001602&offer_contract_id=0&affiliate_id=0&account_status_id=0&media_type_id=0&start_at_row=0&row_limit=0&sort_field=campaign_id&sort_descending=false 

 

Sample XML Response:

 

<campaign_lead_tier_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/1/">
<success>true</success>
<row_count>9</row_count>
<campaign_tiers>
<campaign_tier>
<campaign_id>18459</campaign_id>
<campaign_default_payout>0.0000</campaign_default_payout>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>-1</affiliate_id>
<affiliate_name>Affiliate -1</affiliate_name>
<offer_contract_id>2812</offer_contract_id>
<offer_contract_name>OC-Gold</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>true</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>18460</campaign_id>
<campaign_default_payout>15.0000</campaign_default_payout>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>3692</affiliate_id>
<affiliate_name>Cake</affiliate_name>
<offer_contract_id>2812</offer_contract_id>
<offer_contract_name>OC-Gold</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>true</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>18748</campaign_id>
<campaign_default_payout>0.0000</campaign_default_payout>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>3692</affiliate_id>
<affiliate_name>Cake</affiliate_name>
<offer_contract_id>2812</offer_contract_id>
<offer_contract_name>OC-Gold</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>true</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>20677</campaign_id>
<campaign_default_payout xsi:nil="true"/>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>5920</affiliate_id>
<affiliate_name>@Test1231</affiliate_name>
<offer_contract_id>2812</offer_contract_id>
<offer_contract_name>OC-Gold</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>true</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>22280</campaign_id>
<campaign_default_payout xsi:nil="true"/>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>5920</affiliate_id>
<affiliate_name>@Test1231</affiliate_name>
<offer_contract_id>2812</offer_contract_id>
<offer_contract_name>OC-Gold</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>true</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>22825</campaign_id>
<campaign_default_payout xsi:nil="true"/>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>5838</affiliate_id>
<affiliate_name>MyPoints</affiliate_name>
<offer_contract_id>2812</offer_contract_id>
<offer_contract_name>OC-Gold</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>true</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>754884</campaign_id>
<campaign_default_payout>0.0000</campaign_default_payout>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>-1</affiliate_id>
<affiliate_name>Affiliate -1</affiliate_name>
<offer_contract_id>5360</offer_contract_id>
<offer_contract_name>OC-Silver</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>false</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>754885</campaign_id>
<campaign_default_payout>0.0000</campaign_default_payout>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>-1</affiliate_id>
<affiliate_name>Affiliate -1</affiliate_name>
<offer_contract_id>5361</offer_contract_id>
<offer_contract_name>OC-Bronze</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>false</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
<campaign_tier>
<campaign_id>754886</campaign_id>
<campaign_default_payout>0.0000</campaign_default_payout>
<campaign_status_id>1</campaign_status_id>
<campaign_status_name>Active</campaign_status_name>
<affiliate_id>-1</affiliate_id>
<affiliate_name>Affiliate -1</affiliate_name>
<offer_contract_id>5362</offer_contract_id>
<offer_contract_name>OC-Tierless</offer_contract_name>
<offer_contract_default_payout>0.0000</offer_contract_default_payout>
<offer_contract_is_default>false</offer_contract_is_default>
<campaign_lead_tiers>
<campaign_lead_tier>
<lead_tier_id>33</lead_tier_id>
<lead_tier_name>has SSN</lead_tier_name>
<lead_tier_group_id xsi:nil="true"/>
<lead_tier_definition>has SSN = 1</lead_tier_definition>
<lead_tier_payout>25.0000</lead_tier_payout>
</campaign_lead_tier>
</campaign_lead_tiers>
</campaign_tier>
</campaign_tiers>
</campaign_lead_tier_response>

 


Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.




Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.