Signal and Event APIs1.1

Adara

API documentation for Signal & Event

Servers

Choose a server to use:

https://qa3-ao.adara.com

https://ao.adara.com

Authentication

apiKey apiKey

Fields

Key	In
Authorization	Header

Auth Api

Authenticates user based on client and endpoint id provided, returns authorization code on success

POST /api/1.1/auth

Auth

Request Body

authRequest

AuthRequest	object	Authorization Model	required
user	object	Container for user identifiers fora single request. At least one user ID is required	required
client_id	int32	This required ID uniquely identifies each Client of the Integrating Partner. The identifier(s) will be generated and provided by ADARA	required
endpoint_owner	int32	This required ID uniquely identifies each Integrating Partner.The identifier will be generated and provided by ADARA	required

Example Request

​x
 
curl --request POST \ --url https://qa3-ao.adara.com/api/1.1/auth \ --data '{  "user": {    "client_id": 3,    "endpoint_owner": 99  }}'
Copy

Responses

200 201 401 403 404

string string optional

Example Response

200 OK

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Authenticates user based on client and endpoint id provided, returns authorization code on success

POST /api/auth

Auth

Request Body

authRequest

AuthRequest	object	Authorization Model	required
user	object	Container for user identifiers fora single request. At least one user ID is required	required
client_id	int32	This required ID uniquely identifies each Client of the Integrating Partner. The identifier(s) will be generated and provided by ADARA	required
endpoint_owner	int32	This required ID uniquely identifies each Integrating Partner.The identifier will be generated and provided by ADARA	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url https://qa3-ao.adara.com/api/auth \ --data '{  "user": {    "client_id": 3,    "endpoint_owner": 99  }}'
Copy

Responses

200 201 401 403 404

string string optional

Example Response

200 OK

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Event Api

Records event(feedback) provided by customer

POST /api/1.1/events/{endpointOwnerId}/{clientId}

Auth

Path Params

clientId	integer	clientId	required
endpointOwnerId	integer	endpointOwnerId	required

Request Body

eventRequest

EventApiRequest	object		required
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	optional
event_data	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	optional
event_name	string	Event name required for each event	optional
event_schema	array[string]	An array of strings representing column labels for additional event data	optional
event_ts	string	Timestamp of the event. In date/time format "yyyy-MM-dd HH:mm:ss"in UTC timezone. Required	optional
offer_id	string	Event name required for each event	optional
signal_code	string	Signal associated with theevent. Required for each event	optional
user	object	Container for user identifiers for a single request. At least one user ID is required	required
adara_id	int64	ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync	optional
client	object	The Client ID specifies the client for which the Endpoint Owner is making the request	required
client_id	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	required
client_name	string	Name of the client	optional
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	optional
guid_sha256	string		optional
loyalty_id	string	Client's Loyalty IDfor the user, such as the frequent flyer or rewards number	optional
pnr	object		optional
pnr_id	string	Passenger Name Record(PNR)	optional
timestamp	string	Date of the PNR record. The required format is yyyy-MM-dd	optional
tms_id	string	Client’s Tag Management SystemIDfor the user	optional
email_md5	string	MD5 hashed lower-cased email.	optional
email_sha1	string	SHA1 hashed lower-cased email	optional
email_sha256	string	SHA256 hashed lower-cased email. This is preferred emailhashing	optional
mobile	object		optional
android	object	Container for Android mobile application IDs	optional
ad_id	string	Android AdvertisingID	optional
ios	object	Container for iOS mobile application IDs	optional
idfa	string	iOS Identifier for Advertisers (IDFA/IFA)	optional
phone_sha256	string	SHA-256 hashed phone number	optional
tag_manager_ids	array[object]		required
tag_id	string		optional
tag_manager_id	string		optional

Example Request

xxxxxxxxxx
 
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}"      }    ]  }}'
Copy

Responses

200 201 400 401 403 404

No response body

Example Response

200 OK

201 Created

400 {"status": "EINVALID", "error": { "message": "Invalid Request" } }

401 { "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }

403 Forbidden

404 Not Found

xxxxxxxxxx
 
No response
Copy

Records event(feedback) provided by customer

POST /api/events/{endpointOwnerId}/{clientId}

Auth

Path Params

clientId	integer	clientId	required
endpointOwnerId	integer	endpointOwnerId	required

Request Body

eventRequest

EventApiRequest	object		required
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	optional
event_data	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	optional
event_name	string	Event name required for each event	optional
event_schema	array[string]	An array of strings representing column labels for additional event data	optional
event_ts	string	Timestamp of the event. In date/time format "yyyy-MM-dd HH:mm:ss"in UTC timezone. Required	optional
offer_id	string	Event name required for each event	optional
signal_code	string	Signal associated with theevent. Required for each event	optional
user	object	Container for user identifiers for a single request. At least one user ID is required	required
adara_id	int64	ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync	optional
client	object	The Client ID specifies the client for which the Endpoint Owner is making the request	required
client_id	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	required
client_name	string	Name of the client	optional
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	optional
guid_sha256	string		optional
loyalty_id	string	Client's Loyalty IDfor the user, such as the frequent flyer or rewards number	optional
pnr	object		optional
pnr_id	string	Passenger Name Record(PNR)	optional
timestamp	string	Date of the PNR record. The required format is yyyy-MM-dd	optional
tms_id	string	Client’s Tag Management SystemIDfor the user	optional
email_md5	string	MD5 hashed lower-cased email.	optional
email_sha1	string	SHA1 hashed lower-cased email	optional
email_sha256	string	SHA256 hashed lower-cased email. This is preferred emailhashing	optional
mobile	object		optional
android	object	Container for Android mobile application IDs	optional
ad_id	string	Android AdvertisingID	optional
ios	object	Container for iOS mobile application IDs	optional
idfa	string	iOS Identifier for Advertisers (IDFA/IFA)	optional
phone_sha256	string	SHA-256 hashed phone number	optional
tag_manager_ids	array[object]		required
tag_id	string		optional
tag_manager_id	string		optional

Example Request

xxxxxxxxxx
 
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}"      }    ]  }}'
Copy

Responses

200 201 400 401 403 404

No response body

Example Response

200 OK

201 Created

400 {"status": "EINVALID", "error": { "message": "Invalid Request" } }

401 { "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }

403 Forbidden

404 Not Found

xxxxxxxxxx
 
No response
Copy

Signal Api

Provides score value for the requested signal(s)

POST /api/1.1/req/{endpointOwnerId}/{clientId}

Auth

Path Params

clientId	integer	clientId	required
endpointOwnerId	integer	endpointOwnerId	required

Request Body

APIRequest

ApiRequest	object		required
data_requested	array[string]	Listof signal code identifiers. At least one item is required	required
user	object	Container for user identifiers for a single request. At least one user ID is required	required
adara_id	int64	ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync	optional
client	object	The Client ID specifies the client for which the Endpoint Owner is making the request	required
client_id	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	required
client_name	string	Name of the client	optional
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	optional
guid_sha256	string		optional
loyalty_id	string	Client's Loyalty IDfor the user, such as the frequent flyer or rewards number	optional
pnr	object		optional
pnr_id	string	Passenger Name Record(PNR)	optional
timestamp	string	Date of the PNR record. The required format is yyyy-MM-dd	optional
tms_id	string	Client’s Tag Management SystemIDfor the user	optional
email_md5	string	MD5 hashed lower-cased email.	optional
email_sha1	string	SHA1 hashed lower-cased email	optional
email_sha256	string	SHA256 hashed lower-cased email. This is preferred emailhashing	optional
mobile	object		optional
android	object	Container for Android mobile application IDs	optional
ad_id	string	Android AdvertisingID	optional
ios	object	Container for iOS mobile application IDs	optional
idfa	string	iOS Identifier for Advertisers (IDFA/IFA)	optional
phone_sha256	string	SHA-256 hashed phone number	optional
tag_manager_ids	array[object]		required
tag_id	string		optional
tag_manager_id	string		optional

Example Request

xxxxxxxxxx
 
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}"      }    ]  }}'
Copy

Responses

200 201 400 401 403 404

ApiResponse	object
response	object	Container for the response information	optional
signals	array[object]	Array of signal code data for the requested signal(s)	optional
signal_code	string	Signal code identifier for the requested signal	optional
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	optional
status	string	Indicates status of the response	optional

Example Response

200 OK

201 Created

400 {"status": "EINVALID", "error": { "message": "Invalid Request" } }

401 { "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }

403 Forbidden

404 Not Found

xxxxxxxxxx
 
{ "response": {  "signals": [   {    "signal_code": "UUS_TVS_1",    "value": "Prefer Long Trip"   }  ] }, "status": "OK"}
Copy

Provides score value for the requested signal(s)

POST /api/req/{endpointOwnerId}/{clientId}

Auth

Path Params

clientId	integer	clientId	required
endpointOwnerId	integer	endpointOwnerId	required

Request Body

APIRequest

ApiRequest	object		required
data_requested	array[string]	Listof signal code identifiers. At least one item is required	required
user	object	Container for user identifiers for a single request. At least one user ID is required	required
adara_id	int64	ADARA User ID. This is the id ADARA passes to Integrating Partner through a user id sync	optional
client	object	The Client ID specifies the client for which the Endpoint Owner is making the request	required
client_id	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	required
client_name	string	Name of the client	optional
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	optional
guid_sha256	string		optional
loyalty_id	string	Client's Loyalty IDfor the user, such as the frequent flyer or rewards number	optional
pnr	object		optional
pnr_id	string	Passenger Name Record(PNR)	optional
timestamp	string	Date of the PNR record. The required format is yyyy-MM-dd	optional
tms_id	string	Client’s Tag Management SystemIDfor the user	optional
email_md5	string	MD5 hashed lower-cased email.	optional
email_sha1	string	SHA1 hashed lower-cased email	optional
email_sha256	string	SHA256 hashed lower-cased email. This is preferred emailhashing	optional
mobile	object		optional
android	object	Container for Android mobile application IDs	optional
ad_id	string	Android AdvertisingID	optional
ios	object	Container for iOS mobile application IDs	optional
idfa	string	iOS Identifier for Advertisers (IDFA/IFA)	optional
phone_sha256	string	SHA-256 hashed phone number	optional
tag_manager_ids	array[object]		required
tag_id	string		optional
tag_manager_id	string		optional

Example Request

xxxxxxxxxx
 
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}"      }    ]  }}'
Copy

Responses

200 201 400 401 403 404

ApiResponse	object
response	object	Container for the response information	optional
signals	array[object]	Array of signal code data for the requested signal(s)	optional
signal_code	string	Signal code identifier for the requested signal	optional
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	optional
status	string	Indicates status of the response	optional

Example Response

200 OK

201 Created

400 {"status": "EINVALID", "error": { "message": "Invalid Request" } }

401 { "status": "ENOAUTH", "error": { "message": "Not Authenticated" } }

403 Forbidden

404 Not Found

xxxxxxxxxx
 
{ "response": {  "signals": [   {    "signal_code": "UUS_TVS_1",    "value": "Prefer Long Trip"   }  ] }, "status": "OK"}
Copy