Response for all versions of SKAN

curl -X GET 'https://api.airbridge.io/skadnetwork/v1/conversion-value-schema?api_key={API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json'

{
  "postbacks": [
    {
      "conversion_schema": {
        "fine": {
          "schema": [
            {
              "events": [],
              "is_overlapped": false,
              "conversion_value": "0"
            },
            {
              "events": [
                {
                  "values": {
                    "max_amount": 1,
                    "min_amount": 0
                  },
                  "event_name": "airbridge.ecommerce.order.completed",
                  "measurement_type": "engagement",
                  "partner_event_name": "adnetwork_mobile_purchase"
                },
                {
                  "values": {
                    "max_amount": 10000,
                    "min_amount": 0
                  },
                  "event_name": "airbridge.ecommerce.order.completed",
                  "measurement_type": "revenue",
                  "partner_event_name": "adnetwork_mobile_purchase"
                }
              ],
              "is_overlapped": false,
              "conversion_value": "1"
            }
          ],
          "lock_window": null
        },
        "coarse": {
          "schema": [
            {
              "events": [
                {
                  "values": {
                    "max_amount": 4,
                    "min_amount": 3
                  },
                  "event_name": "app_open",
                  "measurement_type": "retention",
                  "partner_event_name": null
                }
              ],
              "is_overlapped": null,
              "conversion_value": "low"
            }
          ]
        }
      },
      "postback_sequence_index": 0
    }
  ],
  "config_type": "SKAN 4.0",
  "default_currency": "KRW",
  "last_update_time": 1700000000
}

{
  "type": "about:blank",
  "title": "UNAUTHORIZED",
  "detail": "Unauthorized.",
  "status": 401,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

{
  "type": "about:blank",
  "title": "NOT_FOUND",
  "detail": "There is no such app. Please check.",
  "status": 404,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

{
  "type": "about:blank",
  "title": "url_disabled_by_toggle",
  "detail": "URL has been disabled. Turn on the toggle button to reactivate.",
  "status": 404,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

SKAdNetwork (SKAN) is Apple’s privacy-preserving framework for attributing iOS app installs without relying on user information or device information. Airbridge’s SKAdNetwork Configuration API provides ad channels with conversion values and the event mapped to each conversion value. Ad channels can then decode the postbacks they receive. The API returns as a nested JSON. Marketers can modify the mapping of conversion values and events at any time. Therefore, ad channels are recommended to call the SKAdNetwork Configuration API on a daily basis and keep the conversion value schema up to date. The following table describes the information a SKAN postback may contain, and how the information is structured and labelled. Note that Airbridge has two versions of [SKAN Conversion Value Rule] page, one of which supports all versions of SKAN, including both 3.0 or 4.0. The following table and the SKAdNetwork Configuration API are only applicable to the all-version page. For more information the [SKAN Conversion Value Rule] page, refer to this article.

GET

https://api.airbridge.io/skadnetwork/v1/conversion-value-schema?api_key={API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}

Request

Headers

string

You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.

string

Represents the media type of the resource. Defaults to application/json.

Query Params

string

required

iOS App Store ID.ex) 1370724782

string

required

The names of Integrated Channels are shown using the Airbridge display name.ex) tiktok, facebook.businessGuide) Ad Channels Integrated with Airbridge

string

required

API key that Airbridge provides to authenticated ad channels.

curl -X GET 'https://api.airbridge.io/skadnetwork/v1/conversion-value-schema?api_key={API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json'

Response

200

string

number

object[]

Show child attributes

number

object

Show child attributes

object

Show child attributes

object[]

Show child attributes

string

object[]

Show child attributes

string

object

Show child attributes

number

string

Show child attributes

object[]

Show child attributes

string

object[]

Show child attributes

string

object[]

Show child attributes

string

401

404

Not Found: URL.

{
  "postbacks": [
    {
      "conversion_schema": {
        "fine": {
          "schema": [
            {
              "events": [],
              "is_overlapped": false,
              "conversion_value": "0"
            },
            {
              "events": [
                {
                  "values": {
                    "max_amount": 1,
                    "min_amount": 0
                  },
                  "event_name": "airbridge.ecommerce.order.completed",
                  "measurement_type": "engagement",
                  "partner_event_name": "adnetwork_mobile_purchase"
                },
                {
                  "values": {
                    "max_amount": 10000,
                    "min_amount": 0
                  },
                  "event_name": "airbridge.ecommerce.order.completed",
                  "measurement_type": "revenue",
                  "partner_event_name": "adnetwork_mobile_purchase"
                }
              ],
              "is_overlapped": false,
              "conversion_value": "1"
            }
          ],
          "lock_window": null
        },
        "coarse": {
          "schema": [
            {
              "events": [
                {
                  "values": {
                    "max_amount": 4,
                    "min_amount": 3
                  },
                  "event_name": "app_open",
                  "measurement_type": "retention",
                  "partner_event_name": null
                }
              ],
              "is_overlapped": null,
              "conversion_value": "low"
            }
          ]
        }
      },
      "postback_sequence_index": 0
    }
  ],
  "config_type": "SKAN 4.0",
  "default_currency": "KRW",
  "last_update_time": 1700000000
}

{
  "type": "about:blank",
  "title": "UNAUTHORIZED",
  "detail": "Unauthorized.",
  "status": 401,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

{
  "type": "about:blank",
  "title": "NOT_FOUND",
  "detail": "There is no such app. Please check.",
  "status": 404,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

{
  "type": "about:blank",
  "title": "url_disabled_by_toggle",
  "detail": "URL has been disabled. Turn on the toggle button to reactivate.",
  "status": 404,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

API Reference

Tracking Link

Server-to-Server Event

Actuals Report

Revenue Report

Active Users Report

Retention Report

Raw Data

Attribution Result

Self-Serve Data Upload

SKAdNetwork Configuration API

Request

Headers

Query Params

Response

200

401

404

404