Send In-app Events

curl -X POST 'https://api.airbridge.io/events/v2/apps/{app_name}/mobile-app/9360' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \
  -H 'x-airbridge-use-client-ip: 1' \
  -d '{
  "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
  "user": {
    "externalUserID": "19443",
    "externalUserEmail": "example@ab180.co",
    "externalUserPhone": "821012341234"
  },
  "device": {
    "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "ifa": "542177F1-5C23-438B-8088-82D34C94F6D7",
    "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
    "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
    "clientIP": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "limitAdTracking": true,
    "deviceModel": "LG-H542",
    "appTrackingTransparency": 0,
    "deviceIdentifier": "iPhone11,2",
    "manufacturer": "Samsung",
    "osName": "Android",
    "osVersion": "5.0.2",
    "locale": "ko-KR",
    "timezone": "Asia/Seoul",
    "orientation": "portrait",
    "screen": {
      "width": 123
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "value": 159990,
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "productID": "30372425",
            "price": 10990,
            "name": "나이키 커스텀",
            "position": "1",
            "quantity": 1
          }
        ]
      }
    }
  }
}'

{
  "at": "2020-02-06 16:06:49",
  "data": "Event(9360) is successfully proccessed."
}

{
  "at": "2020-02-06 16:06:49",
  "error": "invalid_request",
  "ingested": 0
}

{
  "at": "2020-02-06 16:06:49",
  "error": "unauthorized",
  "ingested": 0
}

Send In-App events in a server-to-server method. rate limit : 1000 requests per minute.

User Identifiers

AttentionIt is recommended to send all available user identifiers as they are crucial for accurate attribution, postback, cohort analysis etc.

1. Device ID

Device IDs can be retrieved through the SDK (refer to the data fetching guide). Available Device IDs per operating system are as follows:

Request Body Key	Data Fetching Field	Operating System
device.deviceUUID	Airbridge Device ID	All
device.gaid	GAID (Google Advertising ID)	Android
device.appSetID	App Set ID	Android
device.ifa	IDFA	iOS, iPadOS
device.ifv	IDFV	iOS, iPadOS

Request Example

{
    ... 

    "device": {
        "deviceUUID": "542177F1-5C23-438B-8088-82D34C94F6D7",
        "ifa": "542177F1-5C23-438B-8088-82D34C94F6D7",
        "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
        "osName": "iOS",
        "osVersion": "18.0.1"
    },
    "user": {
        "externalUserID": "19443",
        "externalUserEmail": "example@ab180.co",
        "externalUserPhone": "821012341234"
    }

    ...
}

{
    ...

    "device": {
        "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
        "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
        "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
        "osName": "Android",
        "osVersion": "5.0.2"
    },
    "user": {
        "externalUserID": "19443",
        "externalUserEmail": "example@ab180.co",
        "externalUserPhone": "821012341234"
    }

    ...
}

2. User ID(`user.externalUserID`)

User IDs may be sent without Device IDs if data fetching is inconvenient. In such cases, Airbridge processes events based on the Device IDs mapped to the provided User ID. However if no mapping is found, this may lower the accuracy of reports.

Request Example

{
    ...
    
    "user": {
        "externalUserID": "19443",
        "externalUserEmail": "example@ab180.co",
        "externalUserPhone": "821012341234"
    }

    ...
}

Precautions for Ad Channel Integration

Fields needed for Ad OptimizationWhen using channel integration, the event information can also be used for ad optimizations. Due to this, it is strongly recommended to send all available event information through the API. The fields below are generally used for optimization:

app.packageName
device.osName
device.osVersion
device.appTrackingTransparency
device.limitAdTracking

Example Payloads

Product Purchase

{
    "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
    "user": {
        "externalUserID": "19443",
        "externalUserEmail": "example@ab180.co",
        "externalUserPhone": "821012341234"
    },
    "device": {
        "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
        "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
        "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
        "deviceModel": "SM-0000",
        "manufacturer": "Samsung",
        "osName": "Android",
        "osVersion": "5.0.2",
        "locale": "ko-KR",
        "timezone": "Asia/Seoul",
        "orientation": "portrait",
        "screen": {
            "width": 123
        },
        "location": {
            "latitude": 120.103,
            "speed": "12"
        },
        "network": {
            "carrier": "SKTelecom",
            "cellular": true,
            "wifi": true
        }
    },
    "app": {
        "packageName": "com.ab180.co",
        "version": "1.2.3"
    },
    "eventData": {
        "goal": {
            "category": "airbridge.ecommerce.order.completed",
            "value": 159990,
            "semanticAttributes": {
                "action": "christmas purchase",
                "label": "chrismas sale",
                "transactionID": "12939172",
                "inAppPurchased": true,
                "currency": "KRW",
                "products": [
                    {
                        "quantity": 1,
                        "productID": "CH129",
                        "position": 0,
                        "name": "timeless trench coat",
                        "currency": "KRW",
                        "price": 159990
                    }
                ]
            },
            "customAttributes": {
                "season": "chirstmas",
                "gift": true
            }
        }
    }
}

Try API Request

POST

https://api.airbridge.io/events/v2/apps/{app_name}/mobile-app/9360

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.

string

The key value to use for API requests. Instructions for getting API keys are in “how to generate API Keys”.

string

required

You can send the user’s IP in the X-Forwarded-For header. Without X-Forwarded-For, user behavior is logged with the IP of the server that requested the Server To Server API, not the user’s IP (client request IP).We accept values in the form of ipv4 (123.123.123.123), ipv6 (2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d).

number

Can use device.clientIP to decide user’s IP when can’t send device IP at X-Forwarded-For.Required when: When device.clientIP is configured at Request Body

Path Params

string

required

Airbridge App Name. (Unique ID)

Body Params

string

Random UUID v4 string.Accepts a random string in UUID4 format.The event uuid is used for duplication as a unique ID for the event, and will be generated automatically by the event api if not provided.

number

The time the event occurred. (default: current timestamp)A Unix timestamp in milliseconds (13 digits in Unixtime).If the eventTimestamp is older than 24 hours from the time the event was sent, it will not be processed by the server.

object

User information.

Show child attributes

string

User ID.Required when: required if device.deviceUUID is not sent.

string

User email.

string

User phone number.

object

Custom user attributes.Accepts data in JSON format.{ "age_group": "30", "brand": "Nike" }

object

Device Information.Required when: required if user.ExternalUserID is not sent

Show child attributes

string

Airbridge Device ID.Accepts GAID, IDFA, IDFV, Randomly Generated UUID, or AppSetId.Required when: required if user.ExternalUserID is not sent

string

Advertising ID provided by Google

string

Advertising ID provided by Apple

string

AppSetId provided by Google.

string

Device ID provided by Apple

string

Required when User’s Device IP can’t be passed via X-Forwarded-For Request Header. Make sure to include x-airbridge-use-client-ip: 1 at Request Header.Required when: Required when User’s Device IP can’t be passed via X-Forwarded-For Request Header

boolean

The limit ad tracking setting configured on the Android devices. This value must be collected from the Airbridge SDK, and defaults to true if absent. When set to true, the amount of information shared with integrated ad channels via postback may be limited.

string

Device model name Android iOS

integer

App Tracking Transparency

Value	ATT Status
0	Not Determined
1	Restricted
2	Denied
3	Authorized

string

A specific device identifier, such as iPhone11,2 (iPhone only).

string

Device manufacturer Android iOS

enum

Device OS name. (e.g. “Android”, “iOS”) (Case sensitive)Required when: required if device.deviceUUID is sent.

Value	Description
`Android`	Android OS
`iOS`	iOS

string

Device OS version Android iOSRequired when: required if device.deviceUUID is sent.

string

Device Locale in BCP 47 language tag format. (eg. ko-KR, en-US, ja-JP)Airbridge recognizes the country and language of the event based on this field.

string

Device Timezone. Use a Timezone Name defined by the IANA Database. (eg. Asia/Seoul, America/Los_Angeles, Asia/Tokyo)

string

Device orientation Android iOS

string

Device screen information.

Show child attributes

string

Device screen density Android iOS

number

Device screen height Android iOS

number

Device screen width Android iOS

object

You can share the user consent necessary to comply with the Digital Markets Act (DMA) with Airbridge. For detailed information about the DMA, refer to this article.

Show child attributes

string

Indicates whether the user is in the EEA and the DMA applies. Values other than "0" and "1" will not be processed. The value is neither a direct response from the user nor automatically filled in by Airbridge. Determine the appropriate value based on whether the user is in the EEA and the DMA applies.If 0, it is advised not to share the other field values with Airbridge.

0: The user is in the EEA, and DMA does not apply
1: The user is in the EEA, and DMA does apply

string

Indicates whether the user gave Google consent to use their data for ad personalization. Values other than "0" and "1" will not be processed.

0: The user did not give consent
1: The user gave consent

string

Indicates whether the user gave consent to send their data to Google for ad-related purposes. Values other than "0" and "1" will not be processed.

0: The user did not give consent
1: The user gave consent

object

required

User app information.

Show child attributes

string

required

The package name of the app registered on Google Play Store or Apple App Store. (Android: Package Name, iOS: Bundle ID)

string

Version of the app. Android iOS

object

required

Event information.

Show child attributes

object

required

An object that can contain information about an event. It can contain categories, actions, labels, values, and semantic attributes. (Related Guide)

Show child attributes

string

required

The name of the Airbridge event

number

Event’s value.This may represent the product value of purchase events, or revenue for ad impressions etc.

object

Custom event attribute.{ "color": "red" }

object

Semantic Attributes. Predefined attributes for which Airbridge is supposed to collect data.

Show child attributes

string

The currency for the payment event. You can use the currency used for the actual payment, as it will be converted to the currency set in your dashboard during event processing.

string

Airbridge event property 1

string

Airbridge event property 2

string

Product list ID.

string

Cart ID.

string

Transaction ID.

boolean

In-app purchases or not.true for in-app purchase, false for not an in-app purchase.

object[]

Product list.

Show child attributes

string

Currency.

string

Product ID.

number

Product Price.

string

Product name.

string

Product position.

integer

Product quantity.

curl -X POST 'https://api.airbridge.io/events/v2/apps/{app_name}/mobile-app/9360' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \
  -H 'x-airbridge-use-client-ip: 1' \
  -d '{
  "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
  "user": {
    "externalUserID": "19443",
    "externalUserEmail": "example@ab180.co",
    "externalUserPhone": "821012341234"
  },
  "device": {
    "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "ifa": "542177F1-5C23-438B-8088-82D34C94F6D7",
    "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
    "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
    "clientIP": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "limitAdTracking": true,
    "deviceModel": "LG-H542",
    "appTrackingTransparency": 0,
    "deviceIdentifier": "iPhone11,2",
    "manufacturer": "Samsung",
    "osName": "Android",
    "osVersion": "5.0.2",
    "locale": "ko-KR",
    "timezone": "Asia/Seoul",
    "orientation": "portrait",
    "screen": {
      "width": 123
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "value": 159990,
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "productID": "30372425",
            "price": 10990,
            "name": "나이키 커스텀",
            "position": "1",
            "quantity": 1
          }
        ]
      }
    }
  }
}'

Response

200

400

Invalid requests (timestamp, sdk signature, app name, etc.).

401

When using an invalid authentication token.

{
  "at": "2020-02-06 16:06:49",
  "data": "Event(9360) is successfully proccessed."
}

{
  "at": "2020-02-06 16:06:49",
  "error": "invalid_request",
  "ingested": 0
}

{
  "at": "2020-02-06 16:06:49",
  "error": "unauthorized",
  "ingested": 0
}

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

User Identifiers

1. Device ID

2. User ID(`user.externalUserID`)

Precautions for Ad Channel Integration

Example Payloads

Try API Request

Request

Headers

Path Params

Body Params

Response

200

400

401

​User Identifiers

​1. Device ID

​2. User ID(user.externalUserID)

​Precautions for Ad Channel Integration

​Example Payloads

Try API Request

​Request

​Headers

​Path Params

​Body Params

​Response

​200

​400

​401

User Identifiers

1. Device ID

2. User ID(`user.externalUserID`)

Precautions for Ad Channel Integration

Example Payloads

Request

Headers

Path Params

Body Params

Response

200

400

401