Close

Attribution API

Omniata receives attribution data of the users as postbacks from the attribution partners. With some partners such as Adjust, Appsflyer and MAT postback integration can be done via the partner’s panel. The Attribution API also allows generic postback integration.

If the attribution partner or source does not handle the same UID as the main application UID, the Attribution API can link the user’s activity to the postback information via the Alias event. This is useful, for example, when the attribution source uses IDFA and the game uses a custom UID structure.

Postbacks: get

Stores the attribution information for the user. The API Key used for these resource is unique to the organization, as is not the same as the Application API Key. For more information on how to integrate attribution check the User Attribution setup guide.

Request Definition

The API URL is assigned per organization. We use “{orgname}” as an example, when testing use your organization’s assigned subdomain name defined in the Omniata panel.

GET https://{orgname}.acquirer.omniata.com/acquirer

Parameters

The event type qualifier is set to “ad_install”. In this case the value is categorized as mandatory and fixed value.

Name Example Description
api_key 99999999 Key that maps to the application in Omniata.
uid 123ABC123ABC Current IDFA of the user, required for iOS platform or Android advertiser ID, required for Android platform.
om_event_type ad_install Qualifier name for the event.
om_campaign MyGame_US_iPhone (1010101) Campaign name for the user acquisition.
om_publisher Facebook Ads Publisher of the campaign.
om_sub_ad Variation H (1010122) Ad descriptive name.
om_sub_adgroup Payers - 10% January 2017 (1010122) Ad group name for which the Ad belongs to.
om_sub_publisher none Sub publisher of the campaign if available.
om_partner Adjust Attribution partner name.

Response

Besides the standard HTTP response headers, the Event API response has the Cross-Origin Resource Sharing-related header.

Example request:

$ curl -I "https://{orgname}.acquirer.omniata.com/acquirer?api_key=99999999&uid=123ABC123ABC&om_event_type=ad_install&om_campaign=MyGame_US_iPhone+%281010101%29&om_publisher=Facebook+Ads&om_sub_ad=Variation+H+%281010122%29&om_sub_adgroup=Payers+-+10%25+January+2017+%281030200%29&om_sub_publisher=none&om_partner=Adjust"

Example response:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Cache-Control: no-cache
Content-Length: 43
Content-Type: image/gif
Date: Thu, 23 Feb 2017 16:18:26 GMT
Last-Modified: Mon, 28 Sep 1970 06:00:00 GMT
Pragma: no-cache
Server: Omniata-EP/1.0
Connection: keep-alive

Alias: get

Sets the advertising identifier (Ad Id) linked to the user. The Ad Id can be obtained from the platform SDKs.

Request Definition

The API URL is assigned per organization. We use “{orgname}” as an example, when testing use your organization’s assigned subdomain name defined in the Omniata panel.

GET https://{orgname}.acquirer.omniata.com/event

Parameters

The event type qualifier is set to “om_alias”. In this case the value is categorized as mandatory and fixed value.

Name Example Description
api_key 11111111 Key that maps to the application in Omniata.
uid 10000001A User identifier supplied by the application.
om_event_type om_alias Qualifier name for the event.
om_idfa 123ABC123ABC Current IDFA of the user, required for iOS platform.
om_google_aid 456EDF456EDF Android advertiser ID, required for Android platform
om_android_id ABC123ABC123ABCD Android ID, required for Android platform.

Response

Besides the standard HTTP response headers, requests to this API behave exactly the same as the standard Event API.

Example request:

$ curl -I "https://{orgname}.acquirer.omniata.com/event?api_key=11111111&uid=10000001A&om_event_type=om_alias&om_google_aid=456DEF456DEF&om_android_id=ABC123ABC123ABCD"

Example response:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Cache-Control: no-cache
Content-Length: 43
Content-Type: image/gif
Date: Thu, 23 Feb 2017 16:18:26 GMT
Last-Modified: Mon, 28 Sep 1970 06:00:00 GMT
Pragma: no-cache
Server: Omniata-EP/1.0
Connection: keep-alive
Click and drag to move
Standard Event Types

This article was last updated on March 30, 2017 16:21. If you didn't find your answer here, search for another article or contact our support to get in touch.