EXPORT Rules Target API

Updated on 2014-03-27
Current Version: Version 3
Deprecated Version: 
Requests Allowed: GET & SOAP

 

Summary:

Returns rule target details.

You can view rules targets for specific offers on the Offer card >> Traffic tab.

 

Resource/WSDL Page:

http://<your_domain_here>/api/3/export.asmx?op=RuleTargets

 

Parameters

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

 

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

Example Value: 

Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

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

Obtained via GET Shared Rules API. Must pass integer greater than zero

Example Values: 3

 

 **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/3/export.asmx/RuleTargets?api_key=dNJFmId9rI&rule_id=238

 

Sample XML Response:

<rule_targets_export_response>
  <success>true</success>
  <row_count>1</row_count>
  <rule_targets>
    <rule_target>
      <rule_target_id>231</rule_target_id>
      <rule_target_type>
        <rule_target_type_id>3</rule_target_type_id>
        <rule_target_type_name>Device</rule_target_type_name>
      </rule_target_type>
      <exclude>false</exclude>
      <operator>
        <operator_id>10</operator_id>
        <operator_name>listcontains</operator_name>
        <operator_label>List Contains</operator_label>
      </operator>
      <percentage_split xsi:nil="true"/>
      <devices>
        <device>
          <device_id>1658</device_id>
          <device_name>10 G2</device_name>
        </device>
        <device>
          <device_id>780</device_id>
          <device_name>Ipad</device_name>
        </device>
        <device>
          <device_id>183</device_id>
          <device_name>Ipod Touch</device_name>
        </device>
        <device>
          <device_id>305</device_id>
          <device_name>Quicktime Agent</device_name>
        </device>
        <device>
          <device_id>189</device_id>
          <device_name>Sidekick Ii</device_name>
        </device>
      </devices>
    </rule_target>
  </rule_targets>
</rule_targets_export_response>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Invalid Rule ID

Rule ID does not exist