User Identifiers
AttentionIt is recommended to send all available user identifiers as they are crucial for accurate attribution, postback, cohort analysis etc.
1. Cookie ID(browser.clientID)
Cookie IDs can be retrieved through the SDK(refer to the data fetching guide).
The attribution data must be sent along with the Cookie ID for proper attribution.
Get the attribution data from resource.attributionData in the Web SDK fetchResource callback. For details, refer to Data Fetching - Web.
Place
attributionData at the top level of the request, at the same level as eventData. Send eventData.shortID and eventData.trackingData as well.
Request Example
Request Example
2. User ID(user.externalUserID)
User IDs may be sent without Cookie IDs if data fetching is inconvenient.
In such cases, Airbridge processes events based on the Cookie IDs mapped to the provided User ID.
However, if no mapping is found, this may lower the accuracy of reports.
Request Example
Request Example
POST
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).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.
object
Browser Information.
object
required
Event information.
object
Data required for attribution. Send the
resource.attributionData fetched from the Web SDK. [Docs]Place it at the same level as eventData.NOTE: Be careful not to modify this data.If data fetching is not an option, sending the User ID(user.externalUserID) will make this field optional.