Summary API Reporting

Last Updated: Dec 12, 2016 01:52PM PST
The summary reporting API provides a set of reports to expose campaign, cohort and events. Not all packages include access to this API; if you are interested in using this API and your package does not include access, please contact your Apsalar sales representative.

Please note: This documentation applies to a new version of the Summary Reporting API, released on February 2nd, 2015. If you are using the older version of the Summary Reporting API, you can access the documentation here.

Definitions

Base URI: https://clients.apsalar.com/api/
Report name: The available report names can be found here.
Formats
  • json : Returns JSON
  • csv : Returns a downloadable .CSV
  • html : Returns a table in the web browser
Arguments: Arguments are detailed in the returned 'apilist.html' call, but details are provided below for additional clarity:
  • 'start' and 'end' : Formatted as 'YYYY-MM-DD'
  • 'days' : Positive integer that will return current day plus the number of previous days requested. For example, if '1' is used, the current day's results will be returned and if '2' is used, the current day and yesterday's data will be returned.
    • Where both 'days' and 'start'/'end' appear in a request, 'start'/'end' takes precedence.
  • 'apps' : Formatted as platform.longname (e.g. iOS.com.apsalar.sampleapp). Data for multiple apps can be requested; the should be comma separated in the request (e.g. iOS.com.apsalar.sampleapp, Android.com.apsalar.othersampleapp).
  • 'events' : Formatted as platform.longname@event_name (e.g. iOS.com.apsalar.sampleapp@_START__)
    • Events can be requested from multiple apps in a single call. For example, to get a list of first use data for multiple apps: iOS.com.apsalar.sampleapp@__START__, iOS.com.apsalar.sampleapp@PURCHASE, Android.com.apsalar.othersampleapp@__START__, Android.com.apsalar.othersampleapp@PURCHASE).
  • 'no_site': removes the site field from the response
  • 'no_creative': removes the creative field from the response
  • 'no_country': removes the country field from the response

Reports

  • campaign_summary_report : Contains data on traffic acquired by the account, application, and performance metrics of campaigns. This report has the following outputs:
    • date: Date that install or re-engagement is attributed to, by click time
    • platform: Android or iOS
    • longname: The bundle ID of the app
    • app_name: The display name of the app as seen in the Apsalar UI
    • campaign: Campaign name that install or re-engagement is attributed to (maps to Campaign in the Traffic Report)
    • group: Group name that install or re-engagement is attributed to (maps to Campaign Group  column in the Traffic Report)
    • network: Network that install or re-engagement is attributed to (maps to Campaign Source column in the Traffic Report)
    • country: Country at time of install (maps to Country column in the Traffic Report)
    • site: Publisher ID (maps to the Publisher column in the Traffic Report)
    • creative: Creative ID (maps to Creative column in the Traffic Report)
    • spend: Amount spent on campaign (limited support)
    • impressions: Impressions generated by campaign on that date (limited support) (maps to Impressions column in the Traffic Report)
    • clicks: Total clicks for the combination of dimensions in the row (maps to Clicks column in the Traffic Report)
    • installsTotal installs for the combination of dimensions in the row (maps to Attribution column in Traffic Report, for installs)
    • install_lifetime_value: Lifetime revenue from installs for the combination of dimensions in the row (maps to Revenue column in Traffic Report, for installs)
    • install_transactions: Total transactions attributed to installs for the combination of dimensions in the row (maps to Transactions column in Traffic Report, for installs)
    • re-engagements: Total re-engagements for the combination of dimensions in the row (maps to Attribution column in Traffic Report, for re-engagements)
    • re-engagements_lifetime_value: Lifetime revenue from re-engagements for the combination of dimensions in the row (maps to Revenue column in Traffic Report, for re-engagements)
    • re-engagement_transactions: Total transactions attributed to re-engagements for the combination of dimensions in the row (maps to Transactions column in Traffic Report, for re-engagements)
  • event_cohort_report : Specified event data organized by campaign metrics
    • date: Date that install or re-engagement is attributed to, by click time
    • platform: Android or iOS
    • longname: The bundle ID of the app
    • app_name: The display name of the app as seen in the Apsalar UI
    • event: The name of the event
    • cohort_type: The type of attribution, either "install" or "re-engagement"
    • campaign: Campaign name that install or re-engagement is attributed to
    • group: Group name that install or re-engagement is attributed to
    • network: Network that install or re-engagement is attributed to
    • publisher: Publisher ID
    • country: Country at time of install
    • events: Total events for the combination of dimensions in the row
    • events_day_0 through events_day_30: Events per day for day 0, day 1, day 2, etc., for the combination of dimensions in the row
    • events_week_1 through events_week_25: Events per week for week 0, week 1, week 2, etc., for the combination of dimensions in the row
    • uniques: Total unique users for the combination of dimensions in the row
    • uniques_day_0 through uniques_day_30: Unique users per day for day 0, day 1, day 2, etc., for the combination of dimensions in the row
    • uniques_week_0 through uniques_week_25: Unique users per week for week 0, week 1, week 2, etc., for the combination of dimensions in the row
    • ltv: Total lifetime revenue for the combination of dimensions in the row
    • ltv_day_0 through ltv_day_30: Lifetime revenue per day for day 0, day 1, day 2, etc., for the combination of dimensions in the row
    • ltv_week_0 through ltv_week_25: Lifetime revenue per week for week 0, week 1, week 2, etc., for the combination of dimensions in the row
  • apilist : List of API calls that are available.
  • listlogins : List of users with access to the account​

Sample URI

The following campaign summary report query will return for all installs for iOS app com.apsalar.sampleapp in January 2014:

https://clients.apsalar.com/api/campaign_summary_report.html?start=2014-01-01&end=2014-01-31&apps=iOS.com.apsalar.sampleapp

The following event report query will return for all events called "PurchaseItem" and all session starts for iOS app com.apsalar.sampleapp and Android app com.apsalar.othersampleapp in January 2014:

https://clients.apsalar.com/api/event_cohort_report.html?start=2014-01-01&end=2014-01-31&apps=iOS.com.apsalar.sampleapp,Android.com.apsalar.othersampleapp&events=iOS.com.apsalar.sampleapp@__START__,iOS.com.apsalar.sampleapp@PurchaseItem,Android.com.apsalar.othersampleapp@__START__,Android.com.apsalar.othersampleapp@PurchaseItem


Access

To access data via the Summary Reporting API, you must provide credentials from your Apsalar account with API access.
  • By default, client permissions are turned off
  • To adjust API settings for your main Apsalar account (if disabled) or to modify the API access for previously added additional users, please contact Apsalar Support.

Limitations

  • 100,000 max rows returned
  • If greater than 100,000 rows would be returned from your query, no results will be returned

Loading In Excel

The 'html' web query is the most effective method for integrating an API call into Excel in a manner that can easily be refreshed.

Using an .iqy file, it is possible to import API data with prompts for required parameters allowing for quick data refresh. Attached to this article is a sample .iqy file which can be integrated into an Excel file using the following steps:
For Windows:
  • Click Data menu option
  • Select Existing Connections
  • Then select Browse for More
  • Select the Apsalar_Summary_Report_API_Sample.iqy file and follow the provided prompts.
For Mac:
  • Click Data menu option
  • Select Get External Data
  • Then select Run Saved Query...
  • Select the Apsalar_Summary_Report_API_Sample.iqy file and follow the provided prompts.
support@apsalar.com
http://assets3.desk.com/
apsalarinc
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
Invalid characters found
/customer/en/portal/articles/autocomplete