[Export] Campaigns (V5) - Admin

Ron Torres

Modified on: Thu, 10 Sep, 2015 at 7:30 AM

NOTE: At least ONE from this Set must be returned with an ID this is NOT "0"; {affiliate_id, offer_id, campaign_id}

WSDL Page: http://<your_domain_here>/api/5/export.asmx?op=Campaigns

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

campaign_id / INT = Campaign ID ["0" = ALL Campaigns] {See export.asmx > Campaigns}

offer_id / INT = Offer ID ["0" = ALL Offers (offer_id and affiliate_id cannot both be "0")] {See export.asmx > Offers}

affiliate_id / INT = Affiliate ID ["0" = ALL Affiliates (offer_id and affiliate_id cannot both be "0")] {See export.asmx > Affiliates}

account_status_id / INT (unsignedByte) = Affiliate Account Status ID ["0" = ALL Affiliate Account Statuses] {See get.asmx > AccountStatuses}

media_type_id / STRING = Media Type ID ["0" = ALL Media Types] {See get.asmx > GetMediaTypes}

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

sort_field / STRING = Sort Field ["campaign_id", "date_created"]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

Parameter Types:

api_key - ID

campaign_id - ID

offer_id - ID

affiliate_id - ID

account_status_id - ID

media_type_id - ID

start_at_row - ID

row_limit - ID

sort_field - ID

sort_descending - ID

Sample GET Call:

http://demo.cakemarketing.com/api/5/export.asmx/Campaigns?api_key=dNJFmId9rI&campaign_id=0&offer_id=0&affiliate_id=6066&account_status_id=1&media_type_id=15&start_at_row=1&row_limit=1&sort_field=campaign_id&sort_descending=FALSE

Sample XML Response:

<campaign_export_response>
<success>true</success>
<row_count>9</row_count>
<campaigns>
    <campaign>
      <campaign_id>14972</campaign_id>
      <campaign_type>
        <campaign_type_id>1</campaign_type_id>
        <campaign_type_name>Standard</campaign_type_name>
      </campaign_type>
      <affiliate>
        <affiliate_id>6066</affiliate_id>
        <affiliate_name>#1 Affiliate</affiliate_name>
      </affiliate>
      <offer>
        <offer_id>1001330</offer_id>
        <offer_name>Ramon Test Offer</offer_name>
      </offer>
      <offer_contract>
        <offer_contract_id>2427</offer_contract_id>
        <price_format>
          <price_format_id>2</price_format_id>
          <price_format_name>CPC</price_format_name>
        </price_format>
      </offer_contract>
      <original>true</original>
      <exceptions>
        <blocked_sub_affiliates/>
        <blocked_creatives/>
      </exceptions>
      <account_status>
        <account_status_id>1</account_status_id>
        <account_status_name>Active</account_status_name>
      </account_status>
      <payout>
        <is_percentage>false</is_percentage>
        <amount>50.0000</amount>
        <formatted_amount>$50.00</formatted_amount>
      </payout>
      <currency>
        <currency_id>1</currency_id>
        <currency_symbol>$</currency_symbol>
        <currency_name>US Dollar</currency_name>
        <currency_abbr>USD</currency_abbr>
      </currency>
      <media_type>
        <media_type_id>15</media_type_id>
        <media_type_name>Adware</media_type_name>
      </media_type>
      <deal_flow>
        <date_contacted xsi:nil="true"/>
        <date_io_sent xsi:nil="true"/>
        <date_io_signed xsi:nil="true"/>
        <date_creative_sent xsi:nil="true"/>
        <date_pixel_placed xsi:nil="true"/>
      </deal_flow>
      <paid>true</paid>
      <paid_redirects>true</paid_redirects>
      <disable_prepop_appending>false</disable_prepop_appending>
      <suppression_amount xsi:nil="true"/>
      <click_cap>
        <limit xsi:nil="true"/>
        <cap_interval>
          <cap_interval_id>0</cap_interval_id>
          <cap_interval_name>None</cap_interval_name>
        </cap_interval>
        <start_date xsi:nil="true"/>
        <review_no_redirect>false</review_no_redirect>
      </click_cap>
      <conversion_cap>
        <limit xsi:nil="true"/>
        <cap_interval>
          <cap_interval_id>0</cap_interval_id>
          <cap_interval_name>None</cap_interval_name>
        </cap_interval>
        <start_date xsi:nil="true"/>
        <review_no_redirect>false</review_no_redirect>
      </conversion_cap>
      <pixel_info>
        <pixel_status>Pending</pixel_status>
        <pixel_html/>
        <postback_url/>
        <postback_delay_ms xsi:nil="true"/>
      </pixel_info>
      <upsell_info>
        <disable_upsells>false</disable_upsells>
        <paid_upsells>false</paid_upsells>
        <paid_upsells_same_session_only>false</paid_upsells_same_session_only>
        <clear_session_on_conversion>false</clear_session_on_conversion>
      </upsell_info>
      <test_link/>
      <redirect_offer>
        <offer_contract_id>2396</offer_contract_id>
        <price_format>
          <price_format_id>1</price_format_id>
          <price_format_name>CPA</price_format_name>
        </price_format>
      </redirect_offer>
      <redirect_404>false</redirect_404>
      <date_created>2013-03-20T09:37:38.203</date_created>
      <expiration_date xsi:nil="true"/>
      <notes/>
    </campaign>
</campaigns>
</campaign_export_response>

NOTE: At least ONE from this Set must be returned with an ID this is NOT "0"; {affiliate_id, offer_id, campaign_id}

Related Articles