Difference between revisions of "GetConversionsDetails"

From Ad4Game Developers
Jump to: navigation, search
(Created page with "==Description== Returns details for all offers or a result set with optional filters. Results can display a set of fields for all matching offers: <ul> <li>- Id : the offer ...")
 
(→‎URL)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
  
−
Returns details for all offers or a result set with optional filters.
+
Returns the conversions details for a given period.
−
Results can display a set of fields for all matching offers:  
+
<br>Results can display a set of fields for conversions:  
 
<ul>
 
<ul>
−
<li>- Id : the offer id
+
<li>- TransactionType : lead, sale ...
−
<li>- Name : the offer name
+
<li>- Status : Approved or Disaproved
−
<li>- Platform : supported
+
<li>- OfferName : the offer name  
−
<li>- DailyCap : max lead per day.
+
<li>- OfferId : the offer id.
−
<li>- PreviewUrl : offer landing page.
+
<li>- TrackingDateTime : the tracking date.
−
<li>- TrackingUrl : Ad4Game tracking url
+
<li>- TrackerId : the tracker id.
−
<li>- Description : Description of the offer
+
<li>- Commission : the payout.
−
<li>- RestrictedTraffic : list of restricted traffic sources
+
<li>- Currency : dollar, euro ...
−
<li>- Country : Targeted country
+
<li>- subid
−
<li>- OptIn : offer opt-in can be either DOI or SOI
+
<li>- subid2
−
<li>- Rate : Net Rate paid to affiliate in $ USD
+
<li>- subid3
−
<li>- EndDate : The expire time of the offer
+
<li>- subid4
 +
<li>- Affid
 
</ul>
 
</ul>
  
 
==URL==
 
==URL==
−
https://traffic.ad4game.com/www/admin/offers-api.php?apiKey=[YOUR API KEY]&zoneId=[YOUR ZONE ID]&affiliateId=[YOUR AFFILIATE ID]&method=findAll&format=[xml OR json]
+
https://traffic.ad4game.com/www/admin/offers-api.php?apiKey=[YOUR API KEY]&affiliateId=[YOUR AFFILIATE ID]&zoneId=[YOUR ZONE ID]&method=getConversionsDetails&format=[xml OR json]&period_start=[yyyy-mm-dd]&period_end=[yyyy-mm-dd]
−
 
+
−
==HTTP Method(s)==
+
−
GET, POST
+
−
 
+
−
==Filters :==
+
−
<ul>
+
−
<li>countries : list of countries (ISO code) sperated by a comma (CA,US,FR,JP).</li>
+
−
<li>optIn :  can be either DOI or SOI.</li>
+
−
<li>platform : can be either Display, Android, IOS or Android & IOS.</li>
+
−
<li>restrictedTraffic :  restricted traffic sources can be either S, SEM, B, D, E, P or T</li>
+
−
S: Social traffic (facebook, etc)
+
−
SEM: Search Engine Marketing e.g. Google AdWords
+
−
B: Brand Bidding
+
−
D: Display / Banners
+
−
E: Email Marketing
+
−
P: Pop Unders
+
−
T: Text Links / Editorial content
+
−
</ul>
+
  
 
==Reponses types==
 
==Reponses types==
Line 43: Line 26:
 
<dd>
 
<dd>
 
   {"error":"Success",
 
   {"error":"Success",
−
     "Offers":
+
     "Conversions":
−
     {"3":{
+
     {"1030":{
−
       "OfferId":"3",
+
       "transaction_type":"lead",
−
       "OfferName":"The West",
+
       "status":"Approved",
−
       "Platform":"Display",
+
       "offer_name":"Travian",
−
       "DailyCap":"None",
+
       "offer_id":"325",
−
       "PreviewUrl":"http:\/\/www.the-west.net",
+
       "tracking_date_time":"2014-11-12 08:26:29",
−
       "TrackingUrl":"http:\/\/ads.ad4game.com\/www\/delivery\/dck.php?offerid=3&zoneid=7711",
+
       "TrackerId":"711",
−
       "Description":"Discover new land and experience exciting adventures and duels! The West is waiting for you!",
+
       "Commission":"2.5",
−
       "RestrictedTraffic":" Display \/ Banners, Email Marketing, Pop Unders, Text Links \/ Editorial content","Restrictions":"",
+
       "Curency":"$",
−
       "countries":[
+
      "subid":"125482",
−
        {"CountryName":"AT","OptIn":"SOI","endDate":"2013-08-16 15:55:42","Rate":"1.92"},
+
       "subid2":"0",
−
        {"CountryName":"AU","OptIn":"SOI","endDate":"2013-08-16 15:55:42","Rate":"0.40"}
+
      "subid3":"0",
−
        ]
+
      "subid4":"0",
 +
      "affid":"125482HjUGH"
 
       }
 
       }
 
     }
 
     }
 
   }
 
   }
 +
 
===XML===
 
===XML===
 
<dd>
 
<dd>
−
   <Offers>
+
   <Conversions>
−
    <Offer Id="656">
+
    <Conversion>
−
      <Name>The Hobbit Android</Name>
+
        <TransactionType>lead</TransactionType>
−
      <Platform>Android Smartphone & Tablet</Platform>
+
        <Status>Approved</Status>
−
      <DailyCap>63</DailyCap>
+
        <OfferName>Travian</OfferName>
−
      <PreviewUrl>https://play.google.com/store/apps/details?id=com.kabam.fortress</PreviewUrl>
+
        <OfferId>325</OfferId>
−
      <TrackingUrl>http://ads.ad4game.com/www/delivery/dck.php?offerid=656&zoneid=7711</TrackingUrl>
+
        <TrackingDateTime>2014-11-12 08:26:29</TrackingDateTime>
−
      <Description>The battle for Middle-earth has just begun! PLAY FOR FREE and join thousands worldwide to drive ..</Description>
+
        <TrackerId>711</TrackerId>
−
      <RestrictedTraffic> Social traffic (facebook, etc), Social traffic (facebook, etc) Email MarketingM, Brand Bidding</RestrictedTraffic>
+
        <Commission>2.5</Commission>
−
      <Countries>
+
        <Currency>$</Currency>
−
        <Country name="US">
+
        <subid>125482</subid>
−
          <OptIn>SOI</OptIn><Rate>$3.75</Rate>
+
        <subid2>0</subid2>
−
          <EndDate>2013-09-15 16:47:12</EndDate>
+
        <subid3>0</subid3>
−
        </Country>
+
        <subid4>0</subid4>
−
      </Countries>
+
        <AffId>125482HjUGH</AffId>
−
    </Offer>
+
    </Conversion>
−
   </Offers>
+
   </Conversions>

Latest revision as of 10:35, 24 November 2014

Contents

[edit] Description

Returns the conversions details for a given period.
Results can display a set of fields for conversions:

  • - TransactionType : lead, sale ...
  • - Status : Approved or Disaproved
  • - OfferName : the offer name
  • - OfferId : the offer id.
  • - TrackingDateTime : the tracking date.
  • - TrackerId : the tracker id.
  • - Commission : the payout.
  • - Currency : dollar, euro ...
  • - subid
  • - subid2
  • - subid3
  • - subid4
  • - Affid

[edit] URL

https://traffic.ad4game.com/www/admin/offers-api.php?apiKey=[YOUR API KEY]&affiliateId=[YOUR AFFILIATE ID]&zoneId=[YOUR ZONE ID]&method=getConversionsDetails&format=[xml OR json]&period_start=[yyyy-mm-dd]&period_end=[yyyy-mm-dd]

[edit] Reponses types

[edit] JSON

 {"error":"Success",
   "Conversions":
   {"1030":{
     "transaction_type":"lead",
     "status":"Approved",
     "offer_name":"Travian",
     "offer_id":"325",
     "tracking_date_time":"2014-11-12 08:26:29",
     "TrackerId":"711",
     "Commission":"2.5",
     "Curency":"$",
     "subid":"125482",
     "subid2":"0",
     "subid3":"0",
     "subid4":"0",
     "affid":"125482HjUGH"
     }
   }
 }

[edit] XML

 <Conversions>
    <Conversion>
        <TransactionType>lead</TransactionType>
        <Status>Approved</Status>
        <OfferName>Travian</OfferName>
        <OfferId>325</OfferId>
        <TrackingDateTime>2014-11-12 08:26:29</TrackingDateTime>
        <TrackerId>711</TrackerId>
        <Commission>2.5</Commission>
        <Currency>$</Currency>
        <subid>125482</subid>
        <subid2>0</subid2>
        <subid3>0</subid3>
        <subid4>0</subid4>
        <AffId>125482HjUGH</AffId>
    </Conversion>
 </Conversions>
Retrieved from "http://developer.ad4game.com/index.php?title=GetConversionsDetails&oldid=440"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox