Query Parameters

1. Query Parameters

Parameter Required? Values Description
date YES YYYY-MM-DD The date you are requesting data for
page_size NO 0 < Integer value <= number of apps in your account This is how many apps you want returned in the JSON response in one page. The larger this value is the longer the response will take. The default value is 1 if you do not pass a value.
page NO 0 < Integer value <= max pages The page you want returned, we will return the first page if no page is specified.
time_increment NO hourly, daily Returns the data in broken down by hour or day. Daily is the default.
group_by NO placements, content_types, content_cards Returns the data by content type by default. If you use placements or content_cards, it will return the revenue broken down by placement or content card instead.
mock NO 0, 1 Passing 1 will return test data so you can verify that your parsing script is correct. Not having this parameter or using 0 returns real data from your account.

2. JSON Example

{
  "Date": "2016-10-01",
  "TotalApps": 2,
  "PageSize": 1,
  "TotalPages": 2,
  "CurrentPage": 1,
  "Apps": [
    {
      "Name": "MyTapjoy",
      "Platform": "android",
      "AppKey": "bba49f11-b87f-4c0f-9632-21aa810dd6f1",
      "ContentTypes": [
        {
          "ContentType": "DirectPlay",
          "Global": {
            "Clicks": 0,
            "Conversions": 0,
            "Impressions": 0,
            "Revenue": 0,
            "ECPM": 0
          },
          "Countries": []
        },
        {
          "ContentType": "FullScreenInterstitial",
          "Global": {
            "Clicks": 0,
            "Conversions": 0,
            "Impressions": 0,
            "Revenue": 0,
            "ECPM": 0
          },
          "Countries": []
        },
        {
          "ContentType": "Offerwall",
          "Global": {
            "Revenue": 6010.0208,
            "Impressions": 176610,
            "Clicks": 91910,
            "Conversions": 24910,
            "ECPM": 34.0299
          },
          "Countries": [
            {
              "Country": "ae",
              "Revenue": 0,
              "Impressions": 7,
              "Clicks": 3,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ar",
              "Revenue": 0,
              "Impressions": 6,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "at",
              "Revenue": 0.056,
              "Impressions": 32,
              "Clicks": 21,
              "Conversions": 1,
              "ECPM": 1.75
            },
            {
              "Country": "au",
              "Revenue": 0.3304,
              "Impressions": 7,
              "Clicks": 6,
              "Conversions": 2,
              "ECPM": 47.2
            },
            {
              "Country": "ba",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "bd",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "be",
              "Revenue": 0.42364,
              "Impressions": 19,
              "Clicks": 6,
              "Conversions": 3,
              "ECPM": 22.29684
            },
            {
              "Country": "bg",
              "Revenue": 0.0476,
              "Impressions": 4,
              "Clicks": 4,
              "Conversions": 1,
              "ECPM": 11.9
            },
            {
              "Country": "bh",
              "Revenue": 0.056,
              "Impressions": 2,
              "Clicks": 1,
              "Conversions": 1,
              "ECPM": 28
            },
            {
              "Country": "br",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ca",
              "Revenue": 0.84952,
              "Impressions": 9,
              "Clicks": 6,
              "Conversions": 3,
              "ECPM": 94.39111
            },
            {
              "Country": "ch",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "cl",
              "Revenue": 0,
              "Impressions": 4,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "co",
              "Revenue": 0.224,
              "Impressions": 19,
              "Clicks": 7,
              "Conversions": 1,
              "ECPM": 11.78947
            },
            {
              "Country": "cz",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "de",
              "Revenue": 2.4528,
              "Impressions": 6,
              "Clicks": 3,
              "Conversions": 1,
              "ECPM": 408.8
            },
            {
              "Country": "dk",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "dm",
              "Revenue": 0,
              "Impressions": 5,
              "Clicks": 2,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "dz",
              "Revenue": 0,
              "Impressions": 20,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ec",
              "Revenue": 0,
              "Impressions": 4,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "eg",
              "Revenue": 0,
              "Impressions": 11,
              "Clicks": 8,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "es",
              "Revenue": 6.0648,
              "Impressions": 321,
              "Clicks": 166,
              "Conversions": 57,
              "ECPM": 18.89346
            },
            {
              "Country": "fi",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "fr",
              "Revenue": 10.44092,
              "Impressions": 219,
              "Clicks": 143,
              "Conversions": 50,
              "ECPM": 47.67543
            },
            {
              "Country": "gb",
              "Revenue": 18.75832,
              "Impressions": 351,
              "Clicks": 216,
              "Conversions": 69,
              "ECPM": 53.44251
            },
            {
              "Country": "gh",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "gr",
              "Revenue": 0.3094,
              "Impressions": 2,
              "Clicks": 1,
              "Conversions": 1,
              "ECPM": 154.7
            },
            {
              "Country": "hk",
              "Revenue": 0.0532,
              "Impressions": 3,
              "Clicks": 2,
              "Conversions": 1,
              "ECPM": 17.73333
            },
            {
              "Country": "hr",
              "Revenue": 0,
              "Impressions": 6,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "id",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ie",
              "Revenue": 0.056,
              "Impressions": 33,
              "Clicks": 20,
              "Conversions": 1,
              "ECPM": 1.69697
            },
            {
              "Country": "il",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 2,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "in",
              "Revenue": 0.084,
              "Impressions": 20,
              "Clicks": 8,
              "Conversions": 1,
              "ECPM": 4.2
            },
            {
              "Country": "iq",
              "Revenue": 0,
              "Impressions": 15,
              "Clicks": 7,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "is",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "it",
              "Revenue": 0.6608,
              "Impressions": 25,
              "Clicks": 13,
              "Conversions": 5,
              "ECPM": 26.432
            },
            {
              "Country": "je",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "jo",
              "Revenue": 0,
              "Impressions": 4,
              "Clicks": 2,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "jp",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ke",
              "Revenue": 0,
              "Impressions": 8,
              "Clicks": 2,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "kw",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "lb",
              "Revenue": 0,
              "Impressions": 3,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "lt",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ma",
              "Revenue": 0,
              "Impressions": 4,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "mk",
              "Revenue": 0.3094,
              "Impressions": 2,
              "Clicks": 2,
              "Conversions": 1,
              "ECPM": 154.7
            },
            {
              "Country": "mt",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "mx",
              "Revenue": 0.14,
              "Impressions": 18,
              "Clicks": 3,
              "Conversions": 1,
              "ECPM": 7.77778
            },
            {
              "Country": "ng",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "nl",
              "Revenue": 2.5634,
              "Impressions": 191,
              "Clicks": 107,
              "Conversions": 16,
              "ECPM": 13.42094
            },
            {
              "Country": "no",
              "Revenue": 0,
              "Impressions": 4,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "nz",
              "Revenue": 0,
              "Impressions": 5,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "pe",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "pk",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "pm",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "pr",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "ps",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "pt",
              "Revenue": 0,
              "Impressions": 8,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "qa",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "re",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "rs",
              "Revenue": 0,
              "Impressions": 4,
              "Clicks": 3,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "sa",
              "Revenue": 9.48556,
              "Impressions": 257,
              "Clicks": 101,
              "Conversions": 15,
              "ECPM": 36.90879
            },
            {
              "Country": "sc",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "se",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "sg",
              "Revenue": 0.4732,
              "Impressions": 13,
              "Clicks": 5,
              "Conversions": 2,
              "ECPM": 36.4
            },
            {
              "Country": "si",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "sk",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "sy",
              "Revenue": 0,
              "Impressions": 0,
              "Clicks": 1,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "th",
              "Revenue": 0.448,
              "Impressions": 3,
              "Clicks": 1,
              "Conversions": 1,
              "ECPM": 149.33333
            },
            {
              "Country": "tr",
              "Revenue": 0,
              "Impressions": 2,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "tt",
              "Revenue": 0,
              "Impressions": 3,
              "Clicks": 2,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "us",
              "Revenue": 5944.4562,
              "Impressions": 174787,
              "Clicks": 90955,
              "Conversions": 24647,
              "ECPM": 34.0097
            },
            {
              "Country": "uy",
              "Revenue": 0,
              "Impressions": 1,
              "Clicks": 0,
              "Conversions": 0,
              "ECPM": 0
            },
            {
              "Country": "za",
              "Revenue": 0.28,
              "Impressions": 2,
              "Clicks": 1,
              "Conversions": 1,
              "ECPM": 140
            }
          ]
        },
        {
          "ContentType": "Tapjoy.com",
          "Global": {
            "Revenue": 0,
            "Impressions": 0,
            "Clicks": 0,
            "Conversions": 0,
            "ECPM": 0
          },
          "Countries": []
        },
        {
          "ContentType": "Banner",
          "Global": {
            "Revenue": 0,
            "Impressions": 0,
            "Clicks": 0,
            "Conversions": 0,
            "ECPM": 0
          },
          "Countries": []
        }
      ]
    }
  ]
}

3. Field Descriptions

General Object Description Value
Date Date of the data in following format: YYYY-MM-DD Date String in following format: YYYY-MM-DD
TotalApps The total number of apps Integer number
PageSize The number of apps we will return per page. If you want all your apps in one response, you can set this to your total number of apps. We basically return the value you passed to us in the parameter so it could be larger than the number of apps in your app list. Integer number
TotalPages The total number of pages for this report Integer number
CurrentPage Current page number Integer number
Name App Name String
AppKey Unique app id for this app (not the SDK key) appID, not normalized
Platform Platform of this app android, ios
Status This will return a message to let you know if there was an error String
Country The country where the revenue/spend occurred. (2 letter country code) us, ca, gb, … all lowercase
Content Type Object Description Value
Type This is the content’s type. Examples include “message to earn”, “native to earn”, “offerwall” String
Impressions For M2E, N2E, P2E, this would be the primary offer’s impressions Integer number
Clicks The primary content’s clicks Integer number
Conversions The primary content’s conversions Integer number
Revenue The primary content’s total revenue in USD Float number
eCPM eCPM of this content unit for the specified day. There is no hourly version of this metric. Integer number
Placement Object Description Value
Name The placement name as listed in the dashboard String
Impressions Total number of impressions for this placement for ad units, this excludes impressions from non-revenue generating sources like the message in M2E. Integer Number
Clicks Total number of clicks for this placement Integer Number
Conversions Total number of conversions for this placement Integer Number
Revenue Total revenue for this placement in USD Float Number
eCPM eCPM for this placement. There is no hourly version of this metric. Float Number

4. Errors

Error Code Meaning Solution
400 Bad Request Check that your parameters are correct.
401 Bad or missing authentication token Check your authentication token to make sure it is correct and hasn’t expired.
500 Internal server error Try again or contact support@tapjoy.com if the problem persists.
429 Too many requests Lower the frequency of your calls.