Home

API for Fetching Revenue Stats

Revenue report URL:

http://api.crossinstall.com/api/revenue

Parameters:

email (REQUIRED) - Your CrossInstall account email address.

api_key (REQUIRED) - Your CrossInstall API key. You can find your API key here.

start_date (OPTIONAL) - The start date (inclusive) for the performance statistics being fetched. Defaults to one month ago. Example date string format: 2013-04-01

end_date (OPTIONAL) - The end date (inclusive) for the performance statistics being fetched. Defaults to today. Example date string format: 2013-04-15

format (OPTIONAL) - You may specify the API's response format as either JSONXML or CSV. Defaults to JSON.

Example:

http://api.crossinstall.com/api/revenue?email=myaccount@mydomain.com&api_key=ABCD1234&start_date=2013-03-01&end_date=2013-03-31

Response:

success - true or false, to indicate if the API request was successful

error - If there is an error with your API request then this field will be present and contain a string describing the error

ts - Timestamp of the API request

response - Your reporting statistics will be in this section. The contents of this section are described below and depend on your account type.


 

Response Body for Game Developers/Publishers:

The "response" field will contain a section called apps. Each of your apps will be listed here. Each app will have the following data:

name - Your application's name

id - The CrossInstall id for your application. This is the same value as the "app" parameter on your ad's image & click URLs.

ios_store_id - Your application's iOS App Store identifier.

android_store_id - Your application's Android App Store identifier.

stats - An array of statistics about your app's performance, by day. Each day will have:

  • day: YYYY-MM-DD
  • impressions: the number of times you fetched & served the CrossInstall image URL for this app
  • clicks: the number of times you directed a user to your CrossInstall click URL for this app
  • conversions: the number of installs & app launches performed by your users after clicking the click URL
  • conversion_rate: the number of conversions per click
  • revenue: the revenue you earned on this app on this day
  • ecpm: the effective CPM (revenue per 1,000 impressions) on this app

Response Body for Advertisers:

The "response" field will contain a section called ads. Each of the ads you are running on CrossInstall will be listed here. Each ad will have the following data:

name - Your ad's name

id - The CrossInstall id for your ad campaign

ios - true or false, to indicate if this ad campaign is running on iOS

android - true or false, to indicate if this ad campaign is running on Android

device_restriction - If you have indicated any device restrictions (like iPad-only) they would be listed here for reference

allow_incent  - true or false, to indicate if this ad campaign is set to allow incentivization / rewarded; listed here for reference

countries - comma-separated list of countries (or "All") where this ad campaign is set to run; listed here for reference

stats - An array of statistics about your ad campaign's performance, by day. Each day will have:

  • day: YYYY-MM-DD
  • impressions: the number of impressions on your ad
  • clicks: the number of user clicks on your ad
  • conversions: the number of conversions on your ad
  • conversion_rate: the number of conversions per click
  • cost: your cost for the conversions on this ad on this day


 

Response Body for Publishers:

The "response" field will contain a section called campaigns. Each of the campaigns you are publishing from CrossInstall will be listed here. Each campaign will have the following data:

name - The campaign's name

id - The CrossInstall id for your campaign

ios - true or false, to indicate if this campaign is running on iOS

android - true or false, to indicate if this campaign is running on Android

device_restriction - Any device restrictions (like iPad-only) on this campaign are listed here for reference

allow_incent - true or false, to indicate if this campaign is set to allow incentivization / rewarded; listed here for reference

countries - comma-separated list of countries (or "All") where this campaign is allowed to run; listed here for reference

stats - An array of statistics about your ad campaign's performance, by day. Each day will have:

  • day: YYYY-MM-DD
  • clicks: the number of user clicks on your campaign
  • conversions: the number of conversions on your campaign
  • conversion_rate: the number of conversions per click
  • revenue: the revenue you earned for the conversions on this campaign on this day


Note: if you are a combination of a game developer and/or advertiser and/or publisher on CrossInstall then you'll receive several of the structures described above in the same API response.