API documentation for Signal & Event
Auth Api
Authenticates user based on client and endpoint id provided, returns authorization code on success
authRequest
| AuthRequest | object | Authorization Model | |
| user | object | Container for user identifiers fora single request. At least one user ID is required | |
| client | int32 | This required ID uniquely identifies each Client of the Integrating Partner. The identifier(s) will be generated and provided by ADARA | |
| endpoint | int32 | This required ID uniquely identifies each Integrating Partner.The identifier will be generated and provided by ADARA |
curl --request POST \ --url 'https://qa3-ao.adara.com/api/1.1/auth' \ --data '{ "user": { "client_id": 3, "endpoint_owner": 99 }}'OK
| string | string |
Created
Unauthorized
Forbidden
Not Found
{ "schema": "{string}"}Authenticates user based on client and endpoint id provided, returns authorization code on success
authRequest
| AuthRequest | object | Authorization Model | |
| user | object | Container for user identifiers fora single request. At least one user ID is required | |
| client | int32 | This required ID uniquely identifies each Client of the Integrating Partner. The identifier(s) will be generated and provided by ADARA | |
| endpoint | int32 | This required ID uniquely identifies each Integrating Partner.The identifier will be generated and provided by ADARA |
curl --request POST \ --url 'https://qa3-ao.adara.com/api/auth' \ --data '{ "user": { "client_id": 3, "endpoint_owner": 99 }}'OK
| string | string |
Created
Unauthorized
Forbidden
Not Found
{ "schema": "{string}"}Records event(feedback) provided by customer
| clientId | integer | clientId | |
| endpointOwnerId | integer | endpointOwnerId |
eventRequest
| EventApiRequest | object | ||
| events | array[object] | An array of events objects. An Event API request can contain multiple events associated with the specified user. At least one events object must be specified | |
| event | array[string] | An array of strings representing the additional event data. The list must be in the same order as the items in the event_schema array Enum: | |
| event | string | Event name required for each event | |
| event | array[string] | An array of strings representing column labels for additional event data Enum: | |
| event | string | Timestamp of the event. In date/time format "yyyy-MM-dd HH:mm:ss"in UTC timezone. Required | |
| offer | string | Event name required for each event | |
| signal | string | Signal associated with theevent. Required for each event | |
| user | object | Container for user identifiers for a single request. At least one user ID is required | |
| adara | int64 | ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync | |
| client | object | The Client ID specifies the client for which the Endpoint Owner is making the request | |
| client | int32 | This is the unique ADARA generated ID assigned for each client of the Endpoint Owner. It is only required when a user identifier contained in the clientobject is passed | |
| client | string | Name of the client | |
| guid | string | Client's User GUID. This is a first party user identifier that does not apply tothe other user id classifications. This can be used for the Client's first party cookie id or an internal customer id | |
| guid | string | ||
| loyalty | string | Client's Loyalty IDfor the user, such as the frequent flyer or rewards number | |
| pnr | object | ||
| pnr | string | Passenger Name Record(PNR) | |
| timestamp | string | Date of the PNR record. The required format is yyyy-MM-dd | |
| tms | string | Client’s Tag Management SystemIDfor the user | |
| email | string | MD5 hashed lower-cased email. | |
| email | string | SHA1 hashed lower-cased email | |
| email | string | SHA256 hashed lower-cased email. This is preferred emailhashing | |
| mobile | object | ||
| android | object | Container for Android mobile application IDs | |
| ad | string | Android AdvertisingID | |
| ios | object | Container for iOS mobile application IDs | |
| idfa | string | iOS Identifier for Advertisers (IDFA/IFA) | |
| phone | string | SHA-256 hashed phone number | |
| tag | array[object] | ||
| tag | string | ||
| tag | string |
curl --request POST \ --url 'https://qa3-ao.adara.com/api/1.1/events/{endpointOwnerId}/{clientId}' \ --header 'Authorization: {Authorization}' \ --data '{ "events": [ { "event_data": [ "{array[string]...}" ], "event_name": "OFFER_ACCEPTED", "event_schema": [ "{array[string]...}" ], "event_ts": "2017-12-31 01:20:59", "offer_id": "SeatUpgrade12345", "signal_code": "UUS_TVS_1" } ], "user": { "adara_id": 20001, "client": { "client_id": 1, "client_name": "{string}", "guid": "{string}", "guid_sha256": "{string}", "loyalty_id": "{string}", "pnr": { "pnr_id": "{string}", "timestamp": "{string}" }, "tms_id": "{string}" }, "email_md5": "{string}", "email_sha1": "{string}", "email_sha256": "{string}", "mobile": { "android": { "ad_id": "{string}" }, "ios": { "idfa": "{string}" } }, "phone_sha256": "{string}", "tag_manager_ids": [ { "tag_id": "{string}", "tag_manager_id": "{string}" } ] }}'OK
| No response body |
Created
{"status": "EINVALID", "error": { "message": "Invalid Request" } }
{ "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }
Forbidden
Not Found
No responseRecords event(feedback) provided by customer
| clientId | integer | clientId | |
| endpointOwnerId | integer | endpointOwnerId |
eventRequest
| EventApiRequest | object | ||
| events | array[object] | An array of events objects. An Event API request can contain multiple events associated with the specified user. At least one events object must be specified | |
| event | array[string] | An array of strings representing the additional event data. The list must be in the same order as the items in the event_schema array Enum: | |
| event | string | Event name required for each event | |
| event | array[string] | An array of strings representing column labels for additional event data Enum: | |
| event | string | Timestamp of the event. In date/time format "yyyy-MM-dd HH:mm:ss"in UTC timezone. Required | |
| offer | string | Event name required for each event | |
| signal | string | Signal associated with theevent. Required for each event | |
| user | object | Container for user identifiers for a single request. At least one user ID is required | |
| adara | int64 | ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync | |
| client | object | The Client ID specifies the client for which the Endpoint Owner is making the request | |
| client | int32 | This is the unique ADARA generated ID assigned for each client of the Endpoint Owner. It is only required when a user identifier contained in the clientobject is passed | |
| client | string | Name of the client | |
| guid | string | Client's User GUID. This is a first party user identifier that does not apply tothe other user id classifications. This can be used for the Client's first party cookie id or an internal customer id | |
| guid | string | ||
| loyalty | string | Client's Loyalty IDfor the user, such as the frequent flyer or rewards number | |
| pnr | object | ||
| pnr | string | Passenger Name Record(PNR) | |
| timestamp | string | Date of the PNR record. The required format is yyyy-MM-dd | |
| tms | string | Client’s Tag Management SystemIDfor the user | |
| email | string | MD5 hashed lower-cased email. | |
| email | string | SHA1 hashed lower-cased email | |
| email | string | SHA256 hashed lower-cased email. This is preferred emailhashing | |
| mobile | object | ||
| android | object | Container for Android mobile application IDs | |
| ad | string | Android AdvertisingID | |
| ios | object | Container for iOS mobile application IDs | |
| idfa | string | iOS Identifier for Advertisers (IDFA/IFA) | |
| phone | string | SHA-256 hashed phone number | |
| tag | array[object] | ||
| tag | string | ||
| tag | string |
curl --request POST \ --url 'https://qa3-ao.adara.com/api/events/{endpointOwnerId}/{clientId}' \ --header 'Authorization: {Authorization}' \ --data '{ "events": [ { "event_data": [ "{array[string]...}" ], "event_name": "OFFER_ACCEPTED", "event_schema": [ "{array[string]...}" ], "event_ts": "2017-12-31 01:20:59", "offer_id": "SeatUpgrade12345", "signal_code": "UUS_TVS_1" } ], "user": { "adara_id": 20001, "client": { "client_id": 1, "client_name": "{string}", "guid": "{string}", "guid_sha256": "{string}", "loyalty_id": "{string}", "pnr": { "pnr_id": "{string}", "timestamp": "{string}" }, "tms_id": "{string}" }, "email_md5": "{string}", "email_sha1": "{string}", "email_sha256": "{string}", "mobile": { "android": { "ad_id": "{string}" }, "ios": { "idfa": "{string}" } }, "phone_sha256": "{string}", "tag_manager_ids": [ { "tag_id": "{string}", "tag_manager_id": "{string}" } ] }}'OK
| No response body |
Created
{"status": "EINVALID", "error": { "message": "Invalid Request" } }
{ "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }
Forbidden
Not Found
No responseProvides score value for the requested signal(s)
| clientId | integer | clientId | |
| endpointOwnerId | integer | endpointOwnerId |
APIRequest
| ApiRequest | object | ||
| data | array[string] | Listof signal code identifiers. At least one item is required Enum: | |
| user | object | Container for user identifiers for a single request. At least one user ID is required | |
| adara | int64 | ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync | |
| client | object | The Client ID specifies the client for which the Endpoint Owner is making the request | |
| client | int32 | This is the unique ADARA generated ID assigned for each client of the Endpoint Owner. It is only required when a user identifier contained in the clientobject is passed | |
| client | string | Name of the client | |
| guid | string | Client's User GUID. This is a first party user identifier that does not apply tothe other user id classifications. This can be used for the Client's first party cookie id or an internal customer id | |
| guid | string | ||
| loyalty | string | Client's Loyalty IDfor the user, such as the frequent flyer or rewards number | |
| pnr | object | ||
| pnr | string | Passenger Name Record(PNR) | |
| timestamp | string | Date of the PNR record. The required format is yyyy-MM-dd | |
| tms | string | Client’s Tag Management SystemIDfor the user | |
| email | string | MD5 hashed lower-cased email. | |
| email | string | SHA1 hashed lower-cased email | |
| email | string | SHA256 hashed lower-cased email. This is preferred emailhashing | |
| mobile | object | ||
| android | object | Container for Android mobile application IDs | |
| ad | string | Android AdvertisingID | |
| ios | object | Container for iOS mobile application IDs | |
| idfa | string | iOS Identifier for Advertisers (IDFA/IFA) | |
| phone | string | SHA-256 hashed phone number | |
| tag | array[object] | ||
| tag | string | ||
| tag | string |
curl --request POST \ --url 'https://qa3-ao.adara.com/api/1.1/req/{endpointOwnerId}/{clientId}' \ --header 'Authorization: {Authorization}' \ --data '{ "data_requested": [ "{array[string]...}" ], "user": { "adara_id": 20001, "client": { "client_id": 1, "client_name": "{string}", "guid": "{string}", "guid_sha256": "{string}", "loyalty_id": "{string}", "pnr": { "pnr_id": "{string}", "timestamp": "{string}" }, "tms_id": "{string}" }, "email_md5": "{string}", "email_sha1": "{string}", "email_sha256": "{string}", "mobile": { "android": { "ad_id": "{string}" }, "ios": { "idfa": "{string}" } }, "phone_sha256": "{string}", "tag_manager_ids": [ { "tag_id": "{string}", "tag_manager_id": "{string}" } ] }}'OK
| ApiResponse | object | ||
| response | object | Container for the response information | |
| signals | array[object] | Array of signal code data for the requested signal(s) | |
| signal | string | Signal code identifier for the requested signal | |
| value | string | Returned signal value for the specified user identifier. Depending on the signal code, the valuecan be an integer (such as 1 to 5 for a quintile form)or a raw decimal number | |
| status | string | Indicates status of the response |
Created
{"status": "EINVALID", "error": { "message": "Invalid Request" } }
{ "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }
Forbidden
Not Found
{ "response": { "signals": [ { "signal_code": "UUS_TVS_1", "value": "Prefer Long Trip" } ] }, "status": "OK"}Provides score value for the requested signal(s)
| clientId | integer | clientId | |
| endpointOwnerId | integer | endpointOwnerId |
APIRequest
| ApiRequest | object | ||
| data | array[string] | Listof signal code identifiers. At least one item is required Enum: | |
| user | object | Container for user identifiers for a single request. At least one user ID is required | |
| adara | int64 | ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync | |
| client | object | The Client ID specifies the client for which the Endpoint Owner is making the request | |
| client | int32 | This is the unique ADARA generated ID assigned for each client of the Endpoint Owner. It is only required when a user identifier contained in the clientobject is passed | |
| client | string | Name of the client | |
| guid | string | Client's User GUID. This is a first party user identifier that does not apply tothe other user id classifications. This can be used for the Client's first party cookie id or an internal customer id | |
| guid | string | ||
| loyalty | string | Client's Loyalty IDfor the user, such as the frequent flyer or rewards number | |
| pnr | object | ||
| pnr | string | Passenger Name Record(PNR) | |
| timestamp | string | Date of the PNR record. The required format is yyyy-MM-dd | |
| tms | string | Client’s Tag Management SystemIDfor the user | |
| email | string | MD5 hashed lower-cased email. | |
| email | string | SHA1 hashed lower-cased email | |
| email | string | SHA256 hashed lower-cased email. This is preferred emailhashing | |
| mobile | object | ||
| android | object | Container for Android mobile application IDs | |
| ad | string | Android AdvertisingID | |
| ios | object | Container for iOS mobile application IDs | |
| idfa | string | iOS Identifier for Advertisers (IDFA/IFA) | |
| phone | string | SHA-256 hashed phone number | |
| tag | array[object] | ||
| tag | string | ||
| tag | string |
curl --request POST \ --url 'https://qa3-ao.adara.com/api/req/{endpointOwnerId}/{clientId}' \ --header 'Authorization: {Authorization}' \ --data '{ "data_requested": [ "{array[string]...}" ], "user": { "adara_id": 20001, "client": { "client_id": 1, "client_name": "{string}", "guid": "{string}", "guid_sha256": "{string}", "loyalty_id": "{string}", "pnr": { "pnr_id": "{string}", "timestamp": "{string}" }, "tms_id": "{string}" }, "email_md5": "{string}", "email_sha1": "{string}", "email_sha256": "{string}", "mobile": { "android": { "ad_id": "{string}" }, "ios": { "idfa": "{string}" } }, "phone_sha256": "{string}", "tag_manager_ids": [ { "tag_id": "{string}", "tag_manager_id": "{string}" } ] }}'OK
| ApiResponse | object | ||
| response | object | Container for the response information | |
| signals | array[object] | Array of signal code data for the requested signal(s) | |
| signal | string | Signal code identifier for the requested signal | |
| value | string | Returned signal value for the specified user identifier. Depending on the signal code, the valuecan be an integer (such as 1 to 5 for a quintile form)or a raw decimal number | |
| status | string | Indicates status of the response |
Created
{"status": "EINVALID", "error": { "message": "Invalid Request" } }
{ "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }
Forbidden
Not Found
{ "response": { "signals": [ { "signal_code": "UUS_TVS_1", "value": "Prefer Long Trip" } ] }, "status": "OK"}