Server-to-Server Event

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 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

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

X-Forwarded-For

Requiredstring

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).

Path Params

app_name

Requiredstring

Airbridge App Name. (Unique ID)

Body Params

eventUUID

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.

eventTimestamp

number

The time the event occurred.

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. Please use a timestamp within 24 hours from the time it was sent.

user

object

User information.

device

object

Device Information.

device.deviceUUID

stringnullable

Airbridge Device ID.

Accepts GAID, IDFA, IDFV, Randomly Generated UUID, or AppSetId.

device.gaid

stringnullable

Advertising ID provided by Google

device.ifa

stringnullable

Advertising ID provided by Apple

device.appSetID

stringnullable

AppSetId provided by Google.

device.ifv

stringnullable

Device ID provided by Apple

device.limitAdTracking

boolean

The device's ad tracking restriction setting.

true for limit ad tracking, false for allow ad tracking. Android iOS

device.deviceModel

stringnullable

Device model name Android iOS

device.appTrackingTransparency

integer

Device locale Android iOS

device.deviceIdentifier

string

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

device.manufacturer

string

Device manufacturer Android iOS

device.osName

Requiredenum

Device OS name. (e.g. "Android", "iOS") (Case sensitive)

ENUM VALUES

Android

Android OS

iOS

iOS

device.osVersion

Requiredstring

Device OS version Android iOS

device.locale

string

Device locale Android iOS

device.timezone

string

Device timezone Android iOS

device.orientation

string

Device orientation Android iOS

device.screen

string

Device screen information.

device.location

object

Device location.

device.network

object

Device network information.

device.alias

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.

app

Requiredobject

User app information.

eventData

Requiredobject

Event information.

Request

123456
curl -X POST 'https://api.airbridge.io/events/v1/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' \
  -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","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},"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.product.addedToCart","semanticAttributes":{"currency":"KRW","action":"shoes","label":"nike","transactionID":"12939172","inAppPurchased":true,"products":[{"currency":"KRW","name":"나이키 커스텀","price":10990}]}}}}'

Payload

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
{
  "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",
    "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
    },
    "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.product.addedToCart",
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "name": "나이키 커스텀",
            "price": 10990
          }
        ]
      }
    }
  }
}

Request Body Key	Data Fetching Field	Description
eventData.shortID	Attribution Short ID	Campaign Parameter ID
eventData.trackingData.channel	Default Attribution Channel	Campaign Channel
eventData.trackingData.params	Default Attribution Parameters	Campaign Parameters

Request Body Key

Data Fetching Field

Description

eventData.shortID

Attribution Short ID

Campaign Parameter ID

eventData.trackingData.channel

Default Attribution Channel

Campaign Channel

eventData.trackingData.params

Default Attribution Parameters

Campaign Parameters

Headers

Accept-Language

string

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

Content-Type

string

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

Authorization

string

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

X-Forwarded-For

Requiredstring

We accept values in the form of ipv4 (123.123.123.123), ipv6 (2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d).

Path Params

app_name

Requiredstring

Airbridge App Name. (Unique ID)

Body Params

eventUUID

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.

eventTimestamp

number

The time the event occurred.

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. Please use a timestamp within 24 hours from the time it was sent.

user

object

User information.

browser

object

Browser Information.

eventData

Requiredobject

Event information.

eventData.shortID

Requiredstring

Attribution campaign parameter Short ID. Provide the value fetched from the Airbridge SDK(Android iOS).

NOTE: This value must be sent to the Airbridge server without processing or filtering.

If data fetching is not an option, sending the User ID(user.externalUserID) will make this field optional.

eventData.trackingData

Requiredobject

Tracking data from SDK.

eventData.goal

Requiredobject

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

curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/web/9320' \ -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' \ -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"browser":{"clientID":"05609013-bb5a-4594-bbc3-832cb1b87072","userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302"},"eventData":{"shortID":"aef04","trackingData":{"channel":"blog"},"goal":{"category":"airbridge.ecommerce.product.addedToCart","semanticAttributes":{"action":"shoes","label":"nike","query":"나이키","transactionID":"12939172","inAppPurchased":true,"currency":"KRW","products":[{"position":"1","productID":"30372425","name":"나이키 커스텀","price":10990,"quantity":1,"currency":"KRW"}]}}}}'

{ "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262", "user": { "externalUserID": "19443", "externalUserEmail": "example@ab180.co", "externalUserPhone": "821012341234" }, "browser": { "clientID": "05609013-bb5a-4594-bbc3-832cb1b87072", "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302" }, "eventData": { "shortID": "aef04", "trackingData": { "channel": "blog" }, "goal": { "category": "airbridge.ecommerce.product.addedToCart", "semanticAttributes": { "action": "shoes", "label": "nike", "query": "나이키", "transactionID": "12939172", "inAppPurchased": true, "currency": "KRW", "products": [ { "position": "1", "productID": "30372425", "name": "나이키 커스텀", "price": 10990, "quantity": 1, "currency": "KRW" } ] } } } }

Send In-app Events

User Identifiers

Attention

1. Device ID

Request Example

2. User ID(`user.externalUserID`)

Request Example

Example Payloads

Product Purchase

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Send In-web Events

User Identifiers

Attention

Request Example

2. User ID(`user.externalUserID`)

Request Example

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Server-to-Server Eventself.__wrap_n!=1&&self.__wrap_b(":Ricvf9tpkvecq:",0.5)

Send In-app Events

User Identifiers

Attention

1. Device ID

Request Example

2. User ID(user.externalUserID)

Request Example

Example Payloads

Product Purchase

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Send In-web Events

User Identifiers

Attention

1. Cookie ID(browser.clientID)

Request Example

2. User ID(user.externalUserID)

Request Example

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Server-to-Server Event

User Identifiers

2. User ID(`user.externalUserID`)

Example Payloads

1. Cookie ID(`browser.clientID`)

2. User ID(`user.externalUserID`)