Publisher Reporting API

From docs.airnowmedia.com
Jump to: navigation, search

Contents

Preface

This document contains information required to use the Airnow Monetization's Publisher Reporting API.

Introduction

The Publisher Reporting API is an intuitive interface for publishers to request for reports to view the statistical data.

Authentication

An API Key is required for all inbound API requests. Developers will have to login into their account on Airnow Monetization portal and go to "API" section. Go to the "Generate Open API key section". Press Generate API KEY button to get openapikey.

API Rate Limit for overall APIs is 5000 per day.

Parameters and description

Parameter Name Description Mandatory
method Name of report Yes
apikey Your API key Yes
startdate Start Date (In YYYY-MM-DD format only) Yes
enddate End Date(In YYYY-MM-DD format only) Yes
adplatform Advertiser AdType Yes
platformType Advertiser Platform No
appid Application ID No
appname Application Name No
select Parameter names you want to filter No
offset Offset you want to provide No
limit Number of rows you wish to see No
adplatform
pushAds
iconAds
smartWallAds
bannerAds
banner360Ads
bundle_sdk1
bundle_sdk2
inlineAds
inlineBannerAds
ALL
platformtype
Android
iOS
MobileWeb
Select
Date
New Installs
Earnings
CPM
impressions

Sample APIs

Request End Points

Getting Application Data

Get the Application data of Publisher for a given date range.

We have two levels of Application Reports. Response format for both the reports are same.

1. Account Level

This type of report renders the complete data under a publisher for given platform type, by default its Android. You can add the 'adplatform' and 'select' parameters to filter the data.

Request Example:

http://openapi.airpush.com/getApplicationReports?openapikey=<API_KEY>&startdate=<START_DATE>&enddate=<END_DATE>&adplatform=<Ad types required>&platformtype=<platform type>&select=<Fields you wish to view>&offset=<VALUE>&limit=<VALUE>

2. Application Level

This type of report renders the complete data of a particular application. You need to include the Application name or the Application Id. Even here, you can add the 'adplatform' and 'select' parameters if you wish to filter the data.

Request Examples:

Using Application Name

http://openapi.airpush.com/getApplicationReports?openapikey=<API_KEY>&startdate=<START_DATE>&enddate=<END_DATE>&appname=<Application Name>&adplatform=<Ad types required>&select=<Fields you wish to view>&offset=<VALUE>&limit=<VALUE>

Using Application Id

http://openapi.airpush.com/getApplicationReports?openapikey=<API_KEY>&startdate=<START_DATE>&enddate=<END_DATE>&appid=<Application Id>&adplatform=<Ad types required>&select=<Fields you wish to view>&offset=<VALUE>&limit=<VALUE>

Response Format:

   [
       {
           "App Id": "12345",
           "name": "App Name xyz",
           "Start Date": "2014-05-01",
           "End Date": "2015-05-01",
           "Ad Type": "Push ads",
           "Impressions": "26346946",
           "New Installs": "509430",
           "CPM": "$0.04",
           "Earnings": "833.39"
       },
       {
           ......
       }
  ]

Response Format for Bundled SDK Reports:

   [
       {           
            "App Id": "1234",
            "App Name": "AppName",
            "Start Date": "2015-11-11",
            "End Date": "2015-11-11",
            "Ad Type": "Add-on 1",
            "Add-on": "1234",
            "CPM": "$12.3",
            "Earnings": "12.345"
       },
       {
           ......
       }
  ]

Note:

1. Both 'startdate' and 'enddate' parameter values must be in YYYY-MM-DD format. These fields are mandatory.

2. Ad Platform - The 'adplatform' parameter is mandatory. You need to add this parameter to view reports for specific ad types.

3. App Name - The 'appname' parameter is not mandatory. You need to add this parameter when you wish to view reports for a specific application. Here you need to provide exact name of application name.

4. App ID - The 'appid' parameter is not mandatory. You need to add this parameter when you wish to view reports for a specific application. Here you need to provide application ID.

5. Select - The 'select' parameter is not mandatory. You need to add this parameter when you wish to view the reports with specific columns.

6. We do not return more than 500 rows in the response. If you wish to retrieve reports beyond 500 rows, then you can include the 'offset' and 'limit' parameters. The value of limit should not be greater than 500.

Error Codes

Error Code Error Messages
5001 No Parameters received.
5002 The Ad Platform field cannot be left empty.
5003 This type of Ad Platform is not available.
5004 Start Date field cannot be left empty.
5005 End Date field cannot be left empty.
5006 End Date cannot be more than the current date.
5007 End Date cannot be less than the start date.
5008 This publisher does not exist.
5009 Please provide valid Select parameters.
5010 Maximum 500 rows can be rendered. Please decrease the limit value.
5011 Invalid Start date.
5012 Invalid End date.
5013 This Application does not belong to this user.
5014 Platform Type cannot be empty.
5015 Please provide valid platform type.
5016 Please provide numeric value for appid.
5017 App id cannot be empty.
5018 App name cannot be empty.
5019 Start Date cannot be more than the current date.
5020 This ad platform is not available for the given application.
Personal tools
Namespaces

Variants
Actions
Toolbox