[Reports] Caps (V3) - Admin

Ron Torres

Modified on: Fri, 23 Jan, 2015 at 6:09 AM

WSDL Page: http://<your_domain_here>/api/3/reports.asmx?op=Caps

Parameter Summary:

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

start_date / DATE = Report Start Date [MM/DD/YYYY]

end_date / DATE = Report End Date [MM/DD/YYYY]

search / STRING = Freeform Search Term

advertiser_id / INT = Advertiser ID ["0" = ALL Advertisers] {See export.asmx > Advertisers}

offer_id / INT = Offer ID ["0" = ALL Offers] {See export.asmx > Offers}

affiliate_id / INT = Affiliate ID ["0" = ALL Affiliates] {See export.asmx > Affiliates}

advertiser_tag_id / INT (short) = Advertiser Tag ID ["0" = ALL Advertiser Tags]

offer_tag_id / INT (short) = Offer Tag ID ["0" = ALL Offer Tags]

affiliate_tag_id / INT (short) = Affiliate Tag ID ["0" = ALL Affiliate Tags] {See get.asmx > AffiliateTags}

advertiser_manager_id / INT = Advertiser Manager ID ["0" = ALL Advertiser Managers]

affiliate_manager_id / INT = Affiliate Manager ID ["0" = ALL Affiliate Managers]

advertiser_billing_cycle_id / INT (unsignedByte) = Advertiser Billing Cycle ID ["0" = ALL Advertiser Billing Cycles] {See get.asmx > BillingCycles}

affiliate_billing_cycle_id / INT (unsignedByte) = Affiliate Billing Cycle ID ["0" = ALL Affiliate Billing Cycles] {See get.asmx > BillingCycles}

cap_type_id / INT (unsignedByte) = Cap Type ID ["0" = ALL Cap Type IDs] {See get.asmx > CapTypes}

cap_entity / STRING = Cap Entity ["offer_and_campaign", "offer", "campaign"]

cap_interval_id / INT (unsignedByte) = Cap Interval ID {See get.asmx > CapIntervals}

traffic_only / BOOL = Entities with Traffic Only? ["TRUE", "FALSE"]

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 ["advertiser_id", "advertiser_name", "offer_id", "offer_name", "affiliate_id", "affiliate_name", "campaign_id", "cap_type_id", "cap_type_name", "cap_interval_id", "cap_interval_name", "active", "start_date", "end_date", "current_total", "cap_limit", "percent_reached"]

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

Parameter Types:

api_key - ID

start_date - ID

end_date - ID

search - ID

advertiser_id - ID

offer_id - ID

affiliate_id - ID

advertiser_tag_id - ID

offer_tag_id - ID

affiliate_tag_id - ID

advertiser_manager_id - ID

affiliate_manager_id - ID

advertiser_billing_cycle_id - ID

affiliate_billing_cycle_id - ID

cap_type_id - ID

cap_entity - ID

cap_interval_id - ID

traffic_only - ID

start_at_row - ID

row_limit - ID

sort_field - ID

sort_descending - ID

Sample GET Call:

http://demo.cakemarketing.com/api/3/reports.asmx/Caps?api_key=dNJFmId9rI&start_date=01/01/2012&end_date=01/01/2013&search=Rename&advertiser_id=0&offer_id=0&affiliate_id=0&advertiser_tag_id=0&offer_tag_id=0&affiliate_tag_id=0&advertiser_manager_id=0&affiliate_manager_id=0&advertiser_billing_cycle_id=0&affiliate_billing_cycle_id=0&cap_type_id=0&cap_entity=offer_and_campaign&cap_interval_id=0&traffic_only=FALSE&start_at_row=1&row_limit=5&sort_field=percent_reached&sort_descending=FALSE

Sample XML Response:

<cap_report_response>
<success>true</success>
<row_count>35</row_count>
<caps>
    <cap>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>169</offer_id>
        <offer_name>Free Cake Giveaway </offer_name>
      </offer>
      <cap_type>
        <cap_type_id>1</cap_type_id>
        <cap_type_name>Click</cap_type_name>
      </cap_type>
      <active>true</active>
      <start_date xsi:nil="true"/>
      <end_date xsi:nil="true"/>
      <current_total>71246</current_total>
      <cap_limit>0</cap_limit>
      <percent_reached xsi:nil="true"/>
    </cap>
    <cap>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>169</offer_id>
        <offer_name>Free Cake Giveaway </offer_name>
      </offer>
      <cap_type>
        <cap_type_id>2</cap_type_id>
        <cap_type_name>Conversion</cap_type_name>
      </cap_type>
      <active>true</active>
      <start_date xsi:nil="true"/>
      <end_date xsi:nil="true"/>
      <current_total>1824</current_total>
      <cap_limit>0</cap_limit>
      <percent_reached xsi:nil="true"/>
    </cap>
    <cap>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>211</offer_id>
        <offer_name>Trident App Offer</offer_name>
      </offer>
      <cap_type>
        <cap_type_id>2</cap_type_id>
        <cap_type_name>Conversion</cap_type_name>
      </cap_type>
      <cap_interval>
        <cap_interval_id>2</cap_interval_id>
        <cap_interval_name>Weekly</cap_interval_name>
      </cap_interval>
      <active>true</active>
      <start_date>2012-08-29T00:00:00</start_date>
      <end_date>2012-09-05T00:00:00</end_date>
      <current_total>26</current_total>
      <cap_limit xsi:nil="true"/>
      <percent_reached xsi:nil="true"/>
    </cap>
    <cap>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>205</offer_id>
        <offer_name>Deluxe ADista Mobile App Install</offer_name>
      </offer>
      <cap_type>
        <cap_type_id>1</cap_type_id>
        <cap_type_name>Click</cap_type_name>
      </cap_type>
      <cap_interval>
        <cap_interval_id>2</cap_interval_id>
        <cap_interval_name>Weekly</cap_interval_name>
      </cap_interval>
      <active>true</active>
      <start_date>2012-08-29T00:00:00</start_date>
      <end_date>2012-09-05T00:00:00</end_date>
      <current_total>532</current_total>
      <cap_limit xsi:nil="true"/>
      <percent_reached xsi:nil="true"/>
    </cap>
    <cap>
      <advertiser>
        <advertiser_id>1</advertiser_id>
        <advertiser_name>Rename Advertiser</advertiser_name>
      </advertiser>
      <offer>
        <offer_id>290</offer_id>
        <offer_name>WINNING T-Shirts</offer_name>
      </offer>
      <affiliate>
        <affiliate_id>2904</affiliate_id>
        <affiliate_name>Laguna Network</affiliate_name>
      </affiliate>
      <campaign>
        <campaign_id>2433</campaign_id>
        <campaign_type>
          <campaign_type_id>1</campaign_type_id>
          <campaign_type_name>Standard</campaign_type_name>
        </campaign_type>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <media_type>
          <media_type_id>2</media_type_id>
          <media_type_name>Network</media_type_name>
        </media_type>
        <payment>
          <is_percentage>false</is_percentage>
          <amount>30.0000</amount>
          <formatted_amount>$30.00</formatted_amount>
        </payment>
        <offer_contract>
          <offer_contract_id>458</offer_contract_id>
          <offer_contract_name>Hot List High Payout</offer_contract_name>
          <price_format>
            <price_format_id>1</price_format_id>
            <price_format_name>CPA</price_format_name>
          </price_format>
        </offer_contract>
      </campaign>
      <cap_type>
        <cap_type_id>2</cap_type_id>
        <cap_type_name>Conversion</cap_type_name>
      </cap_type>
      <cap_interval>
        <cap_interval_id>2</cap_interval_id>
        <cap_interval_name>Weekly</cap_interval_name>
      </cap_interval>
      <active>true</active>
      <start_date>2012-09-12T00:00:00</start_date>
      <end_date>2012-09-19T00:00:00</end_date>
      <current_total>0</current_total>
      <cap_limit xsi:nil="true"/>
      <percent_reached xsi:nil="true"/>
    </cap>
</caps>
</cap_report_response>

Related Articles