Signal and Event APIs 1.1 Adara

API documentation for Signal & Event

Server

https://qa3-ao.adara.com

https://ao.adara.com

Authentication

Fields

Key	In
Authorization	Header

Auth Api

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

Auth

Request Body

authRequest

AuthRequest	object	Authorization Model
user	object	Container for user identifiers fora single request. At least one user ID is 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
endpoint_owner	int32	This required ID uniquely identifies each Integrating Partner.The identifier will be generated and provided by ADARA

POST /api/1.1/auth

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

Responses

200

string string

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Response

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

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

Auth

Request Body

authRequest

AuthRequest	object	Authorization Model
user	object	Container for user identifiers fora single request. At least one user ID is 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
endpoint_owner	int32	This required ID uniquely identifies each Integrating Partner.The identifier will be generated and provided by ADARA

POST /api/auth

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

Responses

200

string string

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Response

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

Event Api

POST

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

POST

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

Records event(feedback) provided by customer

Auth

Path Params

clientId	integer	clientId
endpointOwnerId	integer	endpointOwnerId

Request Body

eventRequest

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

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

 
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

No response body

201

Created

400

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

401

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

403

Forbidden

404

Not Found

Response

 
No response
Copy

Records event(feedback) provided by customer

Auth

Path Params

clientId	integer	clientId
endpointOwnerId	integer	endpointOwnerId

Request Body

eventRequest

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

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

 
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

No response body

201

Created

400

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

401

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

403

Forbidden

404

Not Found

Response

 
No response
Copy

Signal Api

POST

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

POST

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

Provides score value for the requested signal(s)

Auth

Path Params

clientId	integer	clientId
endpointOwnerId	integer	endpointOwnerId

Request Body

APIRequest

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

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

 
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

ApiResponse	object
response1 field	object	Container for the response information
signals	array[object]	Array of signal code data for the requested signal(s)
signal_code	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

201

Created

400

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

401

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

403

Forbidden

404

Not Found

Response

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

Provides score value for the requested signal(s)

Auth

Path Params

clientId	integer	clientId
endpointOwnerId	integer	endpointOwnerId

Request Body

APIRequest

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

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

 
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

ApiResponse	object
response1 field	object	Container for the response information
signals	array[object]	Array of signal code data for the requested signal(s)
signal_code	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

201

Created

400

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

401

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

403

Forbidden

404

Not Found

Response

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

Signal and Event APIs 1.1Adara

Authentication

Auth Api

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

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

Event Api

Records event(feedback) provided by customer

Records event(feedback) provided by customer

Signal Api

Provides score value for the requested signal(s)

Provides score value for the requested signal(s)

Signal and Event APIs 1.1 Adara