Legacy Reporting API

1. Overview

The Legacy endpoint serves real-time reporting data on metrics like clicks, installs, conversions, and other events, in XML and JSON.

For Advertisers, the default API response includes: Data for all offers that are enabled (Tapjoy approved and Advertiser enabled). To see data for non-enabled offers, use the all_offers=1 parameter (see Parameters below).

For Publishers, the default API response includes: Data for any app id used for publishing Tapjoy ads. Note the app id is used as the primary advertising offer id and data will be reported even if campaigns are disabled.

2. Reporting API Key

Please note, this is a different key from the Insights Reporting API key.

To find your Legacy Reporting API key on the Tapjoy dashboard:

  • Go to Settings in the top navigation bar
  • Scroll down to the Application Platforms – API Keys – Mediation Keys section at the bottom of the page
  • Click on API Keys

You will see a line that says Ad Reporting API Key. This is your key for the Legacy Reporting API.

If your are using the "V2″ Tapjoy dashboard (dashboard.tapjoy.com), you can find this key at https://dashboard.tapjoy.com/reporting/api. There, it is called the "Legacy Reporting API Key".

Please contact your Tapjoy AM or support if you have any questions.

3. Sample requests and responses

Data can be requested to be returned in XML or JSON, based on the format of the request url. See Parameters section below for a list of required and optional url parameters that can be included in your request.

XML Request and Response

https://api.tapjoy.com/reporting_data.xml?email=sample%40example.com&api_key=your_api_key&date=YYYY-MM-DD&page_size=50&page=2&timezone=0

Response:

<!--?xml version="1.0" encoding="UTF-8"?-->
  
    YYYY-MM-DD
    NUM
    NUM
    NUM
    NUM
    NUM
    
      App Name
      00000000-0000-0000-0000-000000000000
      http://offer-destination-url.com
      App Platform
      true
      VideoOffer
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0
      0
      0
      66d2dd3-1111-443a-1ac3-764111aaa88
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      0
      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
    

    ...

JSON Request and Response

https://api.tapjoy.com/reporting_data.json?email=sample%40example.com&api_key=your_api_key&date=YYYY-MM-DD&page_size=5&page=9&timezone=-5

Response:

{
    "Date" : "YYYY-MM-DD",
    "Timezone" : NUM,
    "TotalOffers" : NUM,
    "PageSize" : NUM,
    "TotalPages" : NUM,
    "CurrentPage" : NUM,
    "Apps" : [
      {
        "Name"                           : "App Name",
        "AppKey"                         : "00000000-0000-0000-0000-000000000000",
        "url"                            : "http://offer-destination-url.com",
        "Platform"                       : "App Platform",
        "Rewarded"                       : true,
        "OfferType"                      : "VideoOffer",
        "PaidInstalls"                   : 0,
        "PaidInstallsHourly"             : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "PaidClicks"                     : 0,
        "PaidClicksHourly"               : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Spend"                          : 0,
        "SpendHourly"                    : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Sessions"                       : 0,
        "SessionsHourly"                 : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "NewUsers"                       : 0,
        "NewUsersHourly"                 : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DailyActiveUsers"               : 0,
        "OfferwallRevenue"               : 0,
        "OfferwallRevenueHourly"         : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "OfferwallImpressions"           : 0,
        "OfferwallImpressionsHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "OfferwallClicks"                : 0,
        "OfferwallClicksHourly"          : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "OfferwallConversions"           : 0,
        "OfferwallConversionsHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferRevenue"           : 0,
        "FeaturedOfferRevenueHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferImpressions"       : 0,
        "FeaturedOfferImpressionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferClicks"            : 0,
        "FeaturedOfferClicksHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "FeaturedOfferConversions"       : 0,
        "FeaturedOfferConversionsHourly" : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallRevenue"            : 0,
        "TJMOfferwallRevenueHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallImpressions"        : 0,
        "TJMOfferwallImpressionsHourly"  : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallClicks"             : 0,
        "TJMOfferwallClicksHourly"       : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "TJMOfferwallConversions"        : 0,
        "TJMOfferwallConversionsHourly"  : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayRevenue"              : 0,
        "DirectPlayRevenueHourly"        : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayImpressions"          : 0,
        "DirectPlayImpressionsHourly"    : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayClicks"               : 0,
        "DirectPlayClicksHourly"         : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "DirectPlayConversions"          : 0,
        "DirectPlayConversionsHourly"    : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Ecpa"                           : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "EcpaAggregate"                  : 0,
        "EcpaGoal"                       : 0,
        "SecondaryConversions"           : 0,
        "SecondaryConversionsHourly"     : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "SecondaryOfferItemId"          : "000000-0000-0000-0000-00000000000",
        "Event_A_Revenue"                : 0,
        "Event_A_RevenueHourly"          : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Event_A_Impressions"            : 0,
        "Event_A_ImpressionsHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Event_A_Clicks"                 : 0,
        "Event_A_ClicksHourly"           : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
        "Event_A_Conversions"            : 0,
        "Event_A_ConversionsHourly"      : [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
      },

      ...

    ]
  }

4. Request Parameters

NameValuesDescription
emailsample%40example.comurl-encoded email that is associated with the partner account/API Key — **required**
api\_keye.g. "1ceb9db808404321b2dbc1e88cbef9cf"Partner API Key — **required**
datee.g. YYYY-MM-DDDate for data being requested — **required**
pagee.g. 3When the response contains multiple pages, indicated in the response metadata, you can request a specific page by specifying the page number. Defaults to first page of results if number of offers is greater than page\_size.
page\_sizee.g. 50Number of offers to be returned per page of response data. Default is 50.
all\_offers1Response will include all enabled and disabled campaigns — **without this parameter, only enabled offers will be returned**
timezonee.g. 0Timezone offset from GMT. Defaults to account timezone if not specified.

5. Additional considerations

A. Rate limiting

You must limit your requests to this API to at most one request per minute.

B. Timezone

Unless timezone is specified in your request URL, the data returned will be in the timezone specified for your account. The timezone parameter expects an integer specifying the UTC offset of the desired timezone in hours (i.e. ‘timezone=-8’ for Pacific Time) or seconds (i.e. ‘timezone=-28800’ for Pacific Time). Each response includes a "Timezone" field, so you can be sure what timezone the results are returned in.

C. Pagination

This feed will return data on a maximum of 100 offers at once. In order to see data about additional offers, provide the page parameter to the request. Each response includes "TotalOffers", "PageSize", "TotalPages", and "CurrentPage", so you can be sure to retrieve all relevant offer data.