How to Use the SKAdNetwork API

List of SKAdNetwork API Endpoints

The following API endpoints are available:

Create Async SKAdNetwork Raw Report Endpoint

Usage

This endpoint generates an asynchronous report query for raw SKAdNetwork data, which is the data collected from SKAdNetwork postbacks. Query this endpoint to see the number of SKAdNetwork conversions per network and app. You can also break down the conversions by conversion value, where available - the actual number from 0 to 63 is a dimension in this report. See full details below.

The endpoint returns a Report ID. The next step is to query the Get Report Status endpoint to see when the report is done and get a download URL.

Sample Query (Python)

import requests
    
    url = "https://api.singular.net/api/v2.0/create_async_skadnetwork_raw_report"
    params = {"api_key": API_KEY}
    data = {
       "skadnetwork_date_type": "skan_postback_date",
       "start_date": "2021-01-01",
       "end_date": "2021-01-01",
       "dimensions": "app,source,skan_network_id,skan_campaign_id,skan_app_id,skan_publisher_id,skan_conversion_value,skan_redownloads,skan_validated,country_field",
       "metrics": "skan_installs",
       "filters": '[{"dimension": "skan_validated", "operator": "in", "values": ["false"]},{"dimension": "skan_redownloads", "operator": "in", "values": ["true"]}]',
       "time_breakdown": "all",
    }
    
    response = requests.post(url=url, params=params, data=data)

Query Parameters

Available Dimensions

Available Metrics

Create Async SKAdNetwork Report Endpoint

Usage

This endpoint generates an asynchronous report query for SKAdNetwork data merged with ad network and tracker data. Query this endpoint to measure CPI, click-through rate, etc., for your SKAdNetwork campaigns, broken down by network and/or campaign.

The endpoint returns a Report ID. The next step is to query the Get Report Status endpoint to see when the report is done and to get a download URL.

Sample Query (Python)

import json
    import requests
    
    url = "https://api.singular.net/api/v2.0/create_async_skadnetwork_report"
    params = {"api_key": <API_KEY>}
    data = {
        "format": "csv",
        "skadnetwork_date_type": "estimated_install_date",
        "start_date": "2021-03-10",
        "end_date": "2021-03-10",
        "dimensions": "app,country_field,source,unified_campaign_id,unified_campaign_name",
        "metrics": "custom_impressions,custom_clicks,tracker_installs,adn_cost,skan_installs,ctr,skan_ocvr,skan_ecpi",
        "time_breakdown": "all"
    }
    
    response = requests.post(url=url, params=params, data=data)

Query Parameters

Available Dimensions

Available Metrics

SKAN Events Endpoint

Usage

This endpoint returns a list of your available SKAN events, for use when querying Create Async SKAdNetwork Report. The events are displayed as pairs of "display_name" and "name." "display_name" is the name of the event as it appears in the Events page, while "name" is the automatically assigned ID that you need to specify when you query Create Async SKAdNetwork Report.

For more information, see What are "SKAN Events"?

Sample Query (Python)

import requests
import json
  
url = "https://api.singular.net/api/v2.0/skan_events"
params = {'api_key': <API_KEY>}
result = requests.get(url=url, params=params)
print result.json()

Query Parameters

Sample Response

{
    u'status': 0, 
    u'substatus': 0, 
    u'value': {
        u'skan_events': [
            {u'display_name': u'level_up', u'name': u'845736495863948'}, 
            {u'display_name': u'tutorial_watched', u'name': u'34079384570293'}, 
            {u'display_name': u'facebook_login', u'name': u'283462837462348'}
        ]
    }
}

SKAN-Specific Error Codes

Singular uses standard HTTP response codes to indicate the success or failure of an API request. In general, 200 codes correspond to success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and 5xx codes are for other issues.

See also: List of general error codes returned by the Reporting API