Promotion Reporting

Use this endpoint to request all promotion data on your Tapdaq account.

If you group by app, you will receive only application ID(s). If you need more information about a given application ID, you need to resolve the id using the Apps endpoint.

If you need to filter your data by promotion ID, then please use the Promotions endpoint.

Authentication

To access any endpoint on the Tapdaq Reporting API you need to include your authentication token which can be found on the Tapdaq dashboard. You can scroll to the examples section to see how it is used.

Request

You can request data on a list of promotions:

POST https://analytics.tapdaq.com/v1/reports/promotion

Request Parameters

Name * Type Description
start_time required YYYY-MM-DD Start date of report range
end_time required YYYY-MM-DD End date of report range
group_by required array[ date, app, ad_network, country, placement_tag, ad_unit, promotion_id ] Define a breakdown of all the reports, at least one is required.
app_ids optional array[ <app_id> ] Filter of included applications, if not defined, all applications from account are fetched if not included
ad_units optional array[ native, static_interstitial ] Filter of included ad units, all ad units are included if not set
countries optional array[ gb, us, ... ] Filter of 2 digit country codes (ISO 3166-1 alpha-2) that are included in the report, if not set, all countries are selected

Response

For each unique group defined in a request, you will get an object in response array which is defined below. Please note that groups without any data are left out (omitted), so if you query last month with group_by =date, you don’t have to get a response object for each day in the selected range.

Name Type Description
[].group Group that identifies the current data item. It can have one or more parameters listed below, depends on a group_by defined in request
[].group.app STRING Application ID
[].group.date YYYY-MM-DD Date in YYYY-MM-DD format
[].group.ad_unit STRING Ad unit, available parameters are defined in request table
[].group.placement_tag STRING Placement tag of this group
[].group.promotion_id STRING Promotion ID of this group
[].group.countries CHAR(2) 2-digit code of selected country in ISO 3166-1 alpha-2
--- --- ---
[].bootup INT Number of bootups (please note this will be null if you filter by promotion ID)
[].install_received INT Number of installs received by this group
[].click_received INT Number of clicks received by this group
[].impression_received INT Number of impressions received by this group
[].impression_sent INT Number of impressions sent from this group
[].install_sent INT Number of installs sent from this group
[].click_sent INT Number of clicks sent from this group

Examples

Use the examples below to gain a better understanding of how to use our Reporting API.

Simple date breakdown

Get a simple breakdown of impressions, clicks and installs received, broken down to a day-by-day basis.

Request
Response
curl --include \
     --request POST \
     --header "Authorization: Bearer <YOUR_API_TOKEN>" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --data-binary "{
  \"group_by\": [\"date\"],
  \"start_time\": \"2017-03-01\",
  \"end_time\": \"2017-03-02\",
  \"placement_tag\": [
    \"default\"
  ]
}" \
'https://analytics.tapdaq.com/v1/reports/promotion'