All Collections
API
SOAP API
Examples
Examples
D
Written by Dani Nabors
Updated over a week ago

Example of PHP code for requesting the server time by using System Service v3 and its getServerTime() operation:

$client = new SoapClient(
   'https://api.oddbytes.com/?v3=system.wsdl',
   array('soap_version' => '1.2',
         'connect_timeout' => 10,
         'compression' => (SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP),
         'cache_wdsl' => WSDL_CACHE_NONE));

$header = new SoapHeader(
   'https://api.oddbytes.com/?v3=system.wsdl',
   'AuthenticateRequest', new SoapVar(array('apiKey' => 'API_KEY'), SOAP_ENC_OBJECT), true);

$client->__setSoapHeaders($header);
try {
   echo("\n[SOAP response]\n");
   $serverTime = $client->__soapCall('getServerTime', array());
   echo("\n{$serverTime->dateTime}\n");
} catch (Exception $e) {
   echo($e->getMessage());
}

Example of the SOAP XML request header:

<soap:Header>
    <tns:AuthenticateRequest soap:mustUnderstand="1">
        <tns:apiKey>API_KEY</tns:apiKey>
    </tns:AuthenticateRequest>
</soap:Header>

Example of the SOAP XML request for fetching campaign ID values by using Campaigns Service v3 and its getCampaignIds() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=campaigns"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:ns2="https://api.oddbytes.com/?v3=campaigns">
 
    <SOAP-ENV:Header>
        <ns2:AuthenticateRequest SOAP-ENV:mustUnderstand="1">
            <apiKey>API_KEY</apiKey>
        </ns2:AuthenticateRequest>
    </SOAP-ENV:Header>
 
    <SOAP-ENV:Body>
        <ns1:getCampaignIds>
            <parameters>
                <filterNames>
                    <item>Test Campaign 001</item>
                </filterNames>
 
                <includeDeleted>false</includeDeleted>
            </parameters>
        </ns1:getCampaignIds>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML response as returned for above-specified request to the getCampaignIds() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=campaigns"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 
    <SOAP-ENV:Body>
        <ns1:getCampaignIdsResponse>
            <return xsi:type="ns1:CampaignIdsResult">
                <ids SOAP-ENC:arrayType="xsd:unsignedInt[1]"
                     xsi:type="ns1:array_unsignedInt_0_unbounded">
                    <item xsi:type="xsd:unsignedInt">223269</item>
                </ids>
 
                <deletedIds SOAP-ENC:arrayType="xsd:ur-type[0]"
                            xsi:type="ns1:array_unsignedInt_0_unbounded" />
            </return>
        </ns1:getCampaignIdsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML request for creating new creative by using Creatives Service v3 and its addCreative() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=creatives"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:ns2="https://api.oddbytes.com/?v3=creatives">
 
    <SOAP-ENV:Header>
        <ns2:AuthenticateRequest SOAP-ENV:mustUnderstand="1">
            <apiKey>API_KEY</apiKey>
        </ns2:AuthenticateRequest>
    </SOAP-ENV:Header>
 
    <SOAP-ENV:Body>
        <ns1:addCreative>
            <parameters>
                <campaignId>223269</campaignId>
 
                <creative>
                    <name>Test Creative 001</name>
                    <categoryId>0</categoryId>
                    <regionCode>US</regionCode>
                    <url>http://yourlandingpage.com</url>
                    <matching>2</matching>
                    <type>TEXTLINK</type>
 
                    <adUnit xsi:type="ns1:AdUnitUpdate">
                        <type>TEXTLINK_TEXT</type>
                        <title>Demo Title</title>
                        <content>Demo Content</content>
                        <url>Demo URL</url>
                        <fileType xsi:nil="true" />
                        <fileData xsi:nil="true" />
                    </adUnit>
 
                    <totalBudget>0</totalBudget>
                    <frequencyCap>24</frequencyCap>
                    <dailyVisitors>2000</dailyVisitors>
 
                    <scheduling>
                        <startDate>2012-01-01</startDate>
                        <endDate xsi:nil="true" />
                        <endDateUnlimited>true</endDateUnlimited>
 
                        <sunday>
                            <workHours>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                                <item>21</item>
                                <item>22</item>
                                <item>23</item>
                            </workHours>
 
                            <dailyBudget>100</dailyBudget>
                        </sunday>
 
                        <monday>
                            <workHours>
                                <item>7</item>
                                <item>8</item>
                                <item>9</item>
                                <item>10</item>
                                <item>11</item>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                            </workHours>
 
                            <dailyBudget>200</dailyBudget>
                        </monday>
 
                        <tuesday>
                            <workHours>
                                <item>7</item>
                                <item>8</item>
                                <item>9</item>
                                <item>10</item>
                                <item>11</item>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                            </workHours>
 
                            <dailyBudget>200</dailyBudget>
                        </tuesday>
 
                        <wednesday>
                            <workHours>
                                <item>7</item>
                                <item>8</item>
                                <item>9</item>
                                <item>10</item>
                                <item>11</item>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                            </workHours>
 
                            <dailyBudget>200</dailyBudget>
                        </wednesday>
 
                        <thursday>
                            <workHours>
                                <item>7</item>
                                <item>8</item>
                                <item>9</item>
                                <item>10</item>
                                <item>11</item>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                            </workHours>
 
                            <dailyBudget>200</dailyBudget>
                        </thursday>
 
                        <friday>
                            <workHours>
                                <item>7</item>
                                <item>8</item>
                                <item>9</item>
                                <item>10</item>
                                <item>11</item>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                            </workHours>
 
                            <dailyBudget>200</dailyBudget>
                        </friday>
 
                        <saturday>
                            <workHours>
                                <item>12</item>
                                <item>13</item>
                                <item>14</item>
                                <item>15</item>
                                <item>16</item>
                                <item>17</item>
                                <item>18</item>
                                <item>19</item>
                                <item>20</item>
                                <item>21</item>
                                <item>22</item>
                                <item>23</item>
                            </workHours>
 
                            <dailyBudget>100</dailyBudget>
                        </saturday>
                    </scheduling>
                </creative>
 
                <addAsPaused xsi:nil="true" />
            </parameters>
        </ns1:addCreative>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML response as returned for above-specified request to the addCreative() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=creatives"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 
    <SOAP-ENV:Body>
        <ns1:addCreativeResponse>
            <return xsi:type="ns1:AddResult">
                <addedId xsi:type="xsd:unsignedInt">4209439</addedId>
            </return>
        </ns1:addCreativeResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML request for updating a creative by using Creatives Service v3 and its updateCreative() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=creatives"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:ns2="https://api.oddbytes.com/?v3=creatives">
 
    <SOAP-ENV:Header>
        <ns2:AuthenticateRequest SOAP-ENV:mustUnderstand="1">
            <apiKey>API_KEY</apiKey>
        </ns2:AuthenticateRequest>
    </SOAP-ENV:Header>
 
    <SOAP-ENV:Body>
        <ns1:updateCreative>
            <parameters>
                <creativeId>4209439</creativeId>
 
                <creative>
                    <name>Updated Test Creative 001</name>
                    <categoryId xsi:nil="true" />
                    <url xsi:nil="true" />
                    <matching xsi:nil="true" />
                    <adUnit xsi:nil="true" />
                    <totalBudget>1000</totalBudget>
                    <frequencyCap xsi:nil="true" />
                    <dailyVisitors xsi:nil="true" />
                    <scheduling xsi:nil="true" />
                </creative>
            </parameters>
        </ns1:updateCreative>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML response as returned for above-specified request to the updateCreative() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=creatives"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 
    <SOAP-ENV:Body>
        <ns1:updateCreativeResponse>
            <return xsi:type="ns1:UpdateResult">
                <updatedIds SOAP-ENC:arrayType="xsd:unsignedInt[1]"
                            xsi:type="ns1:array_unsignedInt_0_unbounded">
                    <item xsi:type="xsd:unsignedInt">4209439</item>
                </updatedIds>
 
                <unchangedIds SOAP-ENC:arrayType="xsd:ur-type[0]"
                              xsi:type="ns1:array_unsignedInt_0_unbounded"/>
 
                <deletedIds SOAP-ENC:arrayType="xsd:ur-type[0]"
                            xsi:type="ns1:array_unsignedInt_0_unbounded"/>
            </return>
        </ns1:updateCreativeResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML request for pausing creatives by using Creatives Service v3 and its pauseCreatives() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=creatives"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:ns2="https://api.oddbytes.com/?v3=creatives">
 
    <SOAP-ENV:Header>
        <ns2:AuthenticateRequest SOAP-ENV:mustUnderstand="1">
            <apiKey>API_KEY</apiKey>
        </ns2:AuthenticateRequest>
    </SOAP-ENV:Header>
 
    <SOAP-ENV:Body>
        <ns1:pauseCreatives>
            <parameters>
                <creativeIds>
                    <item>4209439</item>
                </creativeIds>
            </parameters>
        </ns1:pauseCreatives>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML response as returned for above-specified request to the pauseCreatives() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=creatives"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 
    <SOAP-ENV:Body>
        <ns1:pauseCreativesResponse>
            <return xsi:type="ns1:StatusResult">
                <changedIds SOAP-ENC:arrayType="xsd:unsignedInt[1]"
                            xsi:type="ns1:array_unsignedInt_0_unbounded">
                    <item xsi:type="xsd:unsignedInt">4209439</item>
                </changedIds>
 
                <unchangedIds SOAP-ENC:arrayType="xsd:ur-type[0]"
                              xsi:type="ns1:array_unsignedInt_0_unbounded"/>
 
                <deletedIds SOAP-ENC:arrayType="xsd:ur-type[0]"
                            xsi:type="ns1:array_unsignedInt_0_unbounded"/>
            </return>
        </ns1:pauseCreativesResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML request for fetching stats by using Reports Service v3 and its getMonthlyTargetsStats() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=reports"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:ns2="https://api.oddbytes.com/index.php?v3=reports">
 
    <SOAP-ENV:Header>
        <ns2:AuthenticateRequest SOAP-ENV:mustUnderstand="1">
            <apiKey>API_KEY</apiKey>
        </ns2:AuthenticateRequest>
    </SOAP-ENV:Header>
 
    <SOAP-ENV:Body>
        <ns1:getMonthlyTargetsStats>
            <parameters>
                <date>2012-11-01</date>
                <regionCode>US</regionCode>
                <campaignIds xsi:nil="true" />
                <creativeIds xsi:nil="true" />
                <targetIds xsi:nil="true" />
                <conversionIds xsi:nil="true" />
                <creativeType>TEXTLINK</creativeType>
                <targetStatus xsi:nil="true" />
 
                <rangesFilter>
                    <impressionsOperator xsi:nil="true" />
                    <impressionsValue1 xsi:nil="true" />
                    <impressionsValue2 xsi:nil="true" />
 
                    <clicksOperator xsi:nil="true" />
                    <clicksValue1 xsi:nil="true" />
                    <clicksValue2 xsi:nil="true" />
 
                    <costOperator>GREATER_THAN</costOperator>
                    <costValue1>40</costValue1>
                    <costValue2 xsi:nil="true" />
 
                    <ctrOperator xsi:nil="true" />
                    <ctrValue1 xsi:nil="true" />
                    <ctrValue2 xsi:nil="true" />
 
                    <cpmOperator xsi:nil="true" />
                    <cpmValue1 xsi:nil="true" />
                    <cpmValue2 xsi:nil="true" />
 
                    <conversionsOperator>GREATER_THAN</conversionsOperator>
                    <conversionsValue1>25</conversionsValue1>
                    <conversionsValue2 xsi:nil="true" />
 
                    <revenueOperator xsi:nil="true" />
                    <revenueValue1 xsi:nil="true" />
                    <revenueValue2 xsi:nil="true" />
 
                    <cpaOperator xsi:nil="true" />
                    <cpaValue1 xsi:nil="true" />
                    <cpaValue2 xsi:nil="true" />
 
                    <crOperator xsi:nil="true" />
                    <crValue1 xsi:nil="true" />
                    <crValue2 xsi:nil="true" />
 
                    <averageRankOperator xsi:nil="true" />
                    <averageRankValue1 xsi:nil="true" />
                    <averageRankValue2 xsi:nil="true" />
 
                    <maxBidOperator xsi:nil="true" />
                    <maxBidValue1 xsi:nil="true" />
                    <maxBidValue2 xsi:nil="true" />
 
                    <averageBidOperator xsi:nil="true" />
                    <averageBidValue1 xsi:nil="true" />
                    <averageBidValue2 xsi:nil="true" />
                </rangesFilter>
 
                <orderSlice xsi:nil="true" />
            </parameters>
        </ns1:getMonthlyTargetsStats>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML response as returned for above specified request to the getMonthlyTargetsStats() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=reports"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 
    <SOAP-ENV:Body>
        <ns1:getMonthlyTargetsStatsResponse>
            <return xsi:type="ns1:MonthlyTargetsStatsResult">
                <stats SOAP-ENC:arrayType="ns1:MonthlyTargetsStats[5]"
                       xsi:type="ns1:array_MonthlyTargetsStats_0_unbounded">
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207744</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438352</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">113</impressions>
                        <clicks xsi:type="xsd:unsignedInt">98</clicks>
                        <cost xsi:type="xsd:float">56.4151</cost>
                        <ctr xsi:type="xsd:float">86.726</ctr>
                        <cpm xsi:type="xsd:float">499.2487</cpm>
                        <conversions xsi:type="xsd:unsignedInt">28</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">2.0148</cpa>
                        <cr xsi:type="xsd:float">28.571</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.15</maxBid>
                        <averageBid xsi:type="xsd:float">0.5757</averageBid>
                    </item>
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207744</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438355</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">104</impressions>
                        <clicks xsi:type="xsd:unsignedInt">85</clicks>
                        <cost xsi:type="xsd:float">51.3732</cost>
                        <ctr xsi:type="xsd:float">81.731</ctr>
                        <cpm xsi:type="xsd:float">493.9731</cpm>
                        <conversions xsi:type="xsd:unsignedInt">33</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">1.5568</cpa>
                        <cr xsi:type="xsd:float">38.824</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.15</maxBid>
                        <averageBid xsi:type="xsd:float">0.6044</averageBid>
                    </item>
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207747</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438365</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">114</impressions>
                        <clicks xsi:type="xsd:unsignedInt">102</clicks>
                        <cost xsi:type="xsd:float">56.1401</cost>
                        <ctr xsi:type="xsd:float">89.474</ctr>
                        <cpm xsi:type="xsd:float">492.4570</cpm>
                        <conversions xsi:type="xsd:unsignedInt">30</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">1.8713</cpa>
                        <cr xsi:type="xsd:float">29.412</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.19</maxBid>
                        <averageBid xsi:type="xsd:float">0.5504</averageBid>
                    </item>
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207747</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438366</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">122</impressions>
                        <clicks xsi:type="xsd:unsignedInt">102</clicks>
                        <cost xsi:type="xsd:float">54.1665</cost>
                        <ctr xsi:type="xsd:float">83.607</ctr>
                        <cpm xsi:type="xsd:float">443.9877</cpm>
                        <conversions xsi:type="xsd:unsignedInt">26</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">2.0833</cpa>
                        <cr xsi:type="xsd:float">25.490</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.19</maxBid>
                        <averageBid xsi:type="xsd:float">0.5310</averageBid>
                    </item>
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207747</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438367</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">107</impressions>
                        <clicks xsi:type="xsd:unsignedInt">96</clicks>
                        <cost xsi:type="xsd:float">50.8704</cost>
                        <ctr xsi:type="xsd:float">89.720</ctr>
                        <cpm xsi:type="xsd:float">475.4243</cpm>
                        <conversions xsi:type="xsd:unsignedInt">30</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">1.6957</cpa>
                        <cr xsi:type="xsd:float">31.250</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.19</maxBid>
                        <averageBid xsi:type="xsd:float">0.5299</averageBid>
                    </item>
 
                </stats>
            </return>
        </ns1:getMonthlyTargetsStatsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML request for fetching stats by using Reports Service v3 and its getMonthlyTargetsStats() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=reports"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:ns2="https://api.oddbytes.com/index.php?v3=reports">
 
    <SOAP-ENV:Header>
        <ns2:AuthenticateRequest SOAP-ENV:mustUnderstand="1">
            <apiKey>API_KEY</apiKey>
        </ns2:AuthenticateRequest>
    </SOAP-ENV:Header>
 
    <SOAP-ENV:Body>
        <ns1:getMonthlyTargetsStats>
            <parameters>
                <date>2012-11-01</date>
                <regionCode>US</regionCode>
                <campaignIds xsi:nil="true" />
                <creativeIds xsi:nil="true" />
                <targetIds xsi:nil="true" />
                <conversionIds xsi:nil="true" />
                <creativeType>TEXTLINK</creativeType>
                <targetStatus xsi:nil="true" />
                <rangesFilter xsi:nil="true" />
 
                <orderSlice>
                    <sortColumn>COST</sortColumn>
                    <sortOrder>DESCENDING</sortOrder>
                    <itemsLimit>2</itemsLimit>
                </orderSlice>
            </parameters>
        </ns1:getMonthlyTargetsStats>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example of the SOAP XML response as returned for above specified request to the getMonthlyTargetsStats() operation:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://api.oddbytes.com/?v3=reports"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 
    <SOAP-ENV:Body>
        <ns1:getMonthlyTargetsStatsResponse>
            <return xsi:type="ns1:MonthlyTargetsStatsResult">
                <stats SOAP-ENC:arrayType="ns1:MonthlyTargetsStats[2]"
                       xsi:type="ns1:array_MonthlyTargetsStats_0_unbounded">
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207744</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438352</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">113</impressions>
                        <clicks xsi:type="xsd:unsignedInt">98</clicks>
                        <cost xsi:type="xsd:float">56.4151</cost>
                        <ctr xsi:type="xsd:float">86.726</ctr>
                        <cpm xsi:type="xsd:float">499.2487</cpm>
                        <conversions xsi:type="xsd:unsignedInt">28</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">2.0148</cpa>
                        <cr xsi:type="xsd:float">28.571</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.15</maxBid>
                        <averageBid xsi:type="xsd:float">0.5757</averageBid>
                    </item>
 
                    <item xsi:type="ns1:MonthlyTargetsStats">
                        <campaignId xsi:type="xsd:unsignedInt">223268</campaignId>
                        <creativeId xsi:type="xsd:unsignedInt">4207747</creativeId>
                        <targetId xsi:type="xsd:unsignedInt">41438365</targetId>
                        <targetStatus xsi:type="ns1:TargetStatus">PAUSED</targetStatus>
                        <impressions xsi:type="xsd:unsignedInt">114</impressions>
                        <clicks xsi:type="xsd:unsignedInt">102</clicks>
                        <cost xsi:type="xsd:float">56.1401</cost>
                        <cr xsi:type="xsd:float">89.474</ctr>
                        <cpm xsi:type="xsd:float">492.4570</cpm>
                        <conversions xsi:type="xsd:unsignedInt">30</conversions>
                        <revenue xsi:type="xsd:float">0.00</revenue>
                        <cpa xsi:type="xsd:float">1.8713</cpa>
                        <cr xsi:type="xsd:float">29.412</cr>
                        <averageRank xsi:nil="true" xsi:type="xsd:float" />
                        <maxBid xsi:type="xsd:float">0.19</maxBid>
                        <averageBid xsi:type="xsd:float">0.5504</averageBid>
                    </item>
 
                </stats>
            </return>
        </ns1:getMonthlyTargetsStatsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Related Articles
Introduction
Error Responses
Domain Lists
Targets Service
Reports Service
Did this answer your question?