GetConversions

From MdotM API
Jump to: navigation, search
  • Returns conversion data, by Device ID.
  • During a campaign, the advertiser can call this method periodically to retrieve conversion events.
  • Using this information, the advertiser can measure the quality of paid conversion events along User Engagement or Revenue per User (RPU) lines.

Specs

Method: GET
Rate Limit: Every 60 seconds.
URL: http://ads.mdotm.com/api/1.0/getConversions
with required parameters (email, secretkey):

Name Description Type Compulsion Example
email
Your email address
String
Required
email=api@mdotm.com
secretKey
Alphanumeric authentication code
String
Required
secretKey=4431141f1f341afaacd

and additional parameters below. Users must specify at least one appID.

Name Description Type Compulsion Example
appID
Limit results to one or more App IDs
String
Required
appID=123456789
appID[]=123456789&appID[]=com.your.appname
startDT
Specify start date to limit results by conversionDT, YYYY-MM-DD (all times PST)
String
Optional
startDT=2012-01-01
endDT
Specify end date to limit results by conversionDT, YYYY-MM-DD (all times PST)
String
Optional
endDT=2012-03-31
offset
Offset
String
Optional
offset=100000 -

When startDT and endDT are not supplied, the last 7 days are assumed as default. A maximum of 100,000 objects are returned. To retrieve more than 100,000 objects, use the offset parameter (passing in 100000, 200000, ...) to get at different sets; alternatively, fetch data by day or week.

Returns: JSON Array conversions of conversion objects, each containing attributes of:

Name Description Type Example
campaignID
Campaign ID
String
"123456"
adgroupID
Ad Group ID
String
"123456"
campaignName
Campaign Name
String
"Summer Friends iOS"
adgroupName
Ad Group Name
String
"Tier1EnglishSpeaking"
appID
iOS: iTunes App ID,
Android: Package Name
String
"123456789" or "com.example.appname"
bundleID
Arbitrary bundle ID
String
"com.example.mybundle"
clickID
Unique identification for each click,
32 characters
String
"dac01a1f2c1c7cbe12df7eda42c73ae49"
deviceID
Unique identification for each device:
36 characters (iOS IDFA) or 14-15 characters (Android IMEI),
or other unique identifier (MdotM DeviceID-less Universal Tracking)
String
"46B5BDF6-0676-403F-8142-D2D2920290F1"
aid
identifierForAdvertising for each device:
36 characters (iOS)
String
"dac01a1f2c1c7cbe12df7eda42c73ae49dade5924"
clickDT
Date and time or related click (all times PST)
String
"2012-01-04 11:08"
launchDT
Date and time of launch (all times PST)
String
"2012-01-05 04:05"
conversionDT
Date and time of when conversion detected (all times PST)
String
"2012-01-06 09:15"
price
Spend, in USD
Float
"1.50"
countryCode
Country Code of conversion, 2 characters
String
"GB"
graphicFile
Filename of creative
String
"http://cdn.mdotm.com/mdotm/1234/Example1_320x50.gif"
siteID
Site ID available for site-specific bidding
String
"3f2c2bcf90bc6cc39a5d750cf31d5200"
siteName
Site Name (if available) for site-specific bidding
String
"Solitaire_iOS_Int"

Note: MdotM defers to the following waterfall when returning deviceID

Example

Request

http://ads.mdotm.com/api/1.0/getConversions?email=your@email.com&secretKey=yoursecretkey&appID=com.example.appname&startDT=2012-01-01&endDT=2012-03-31
http://ads.mdotm.com/api/1.0/getConversions?email=your@email.com&secretKey=yoursecretkey&appID=123456789&startDT=2011-02-01&endDT=2012-03-31

Response

{
"error":0,
"description":"success",
"response":
           {"conversions":[
                           {
                            "campaignID":"123456",
                            "adgroupID":"123456",
                            "campaignName":"Summer with Friends",
                            "adgroupName":"Tier1EnglishSpeaking",
                            "appID":"123456789",
                            "bundleID":"com.example.mybundle",
                            "clickID":"dac01a1f2c1c7cbe12df7eda42c73ae49",
                            "deviceID":"dac01a1f2c1c7cbe12df7eda42c73ae49dade5924",
                            "clickDT":"2012-01-04 09:08",
                            "conversionDT":"2012-01-05 04:05",
                            "price":"1.50",
                            "countryCode":"GB",
                            "graphicFile":"http://cdn.mdotm.com/mdotm/1234/Example1_320x50.gif",
                         
                           }
                           ...
                          ]
           }             
}