Multi-Offer API endpoint
Use the Multi-offer API endpoint to fetch a comprehensive list of available offers for users at any given moment, with the option to specify types or subtypes for targeted retrieval.
GET https://iql.zendrive.com/iql/v1/ads/driver_id/<user_id>
Publishers can call this API to retrieve a list of all the offers available to users at any point in time. Publishers can also send a type/subtype in the request to retrieve specific types of offer available for the user.
Path Parameters
user_id
String
Unique identifier of the driver
Query Parameters
type
String
Filters the offers belonging to the given Insurance type.
Accepted values are auto_insurance and non_auto_insurance
subtype
String
Comma separated values of Insurance subtypes.
Accepted values are telematics, affiliate, and drive.
max
String
Max number of offers to be returned in response.
{
"driver_info": {
"publisher_app_name": "test_app",
"driver_id": "test_driver"
},
"offers": [
{
"id": "ad_123bajdh354",
"type": "auto_insurance",
"subtype": "telematics",
"created_at_timestamp": 1544506334000,
"expiry_timestamp": 1944506334000,
"details": {
"insurer_name": "Progressive",
"logo_url": "https://iql.zendrive.com/iql/v2/ad_unit/ad1/logo?dim_x=1000&dim_y=1000",
"title": "Your discount is waiting!",
"body": {
"text": "You qualify for an exclusive discount from our partner XYZ. You will get:",
"bullets": [
"Covered in minutes"
]
},
"button_text": "Get your discount!",
"button_click_url": <click_url>,
"legal": {
"disclaimers": {
"current_customer": "disclaimer for customers.",
"generic": "disclaimer for customers"
},
"privacy_policy_url": "https://www.privacy.com/",
"terms_and_conditions_url": "https://www.term_and_conditions.com"
}
}
},
{
"id": "ad_123bajdh354",
"type": "auto_insurance",
"subtype": "telematics",
"created_at_timestamp": 1544506334000,
"expiry_timestamp": 1944506334000,
"details": {
"insurer_name": "Progressive",
"logo_url": <logo_url>,
"title": "Your discount is waiting!",
"body": {
"text": "You qualify for an exclusive discount from our partner XYZ. You will get:",
"bullets": [
"Quick and personalized rates"
]
},
"button_text": "Get your discount!",
"button_click_url": <click_url>,
"legal": {
"disclaimers": {
"current_customer": "disclaimer",
"generic": "disclaimer"
},
"privacy_policy_url": "https://www.privacy.com/",
"terms_and_conditions_url": "https://www.term_and_conditions.com"
}
}
}
]
}
Sample Response Payload
{
"driver_info": {
"publisher_app_name": "test_app",
"driver_id": "test_driver"
},
"offers": [
{
"id": "ad_123bajdh354",
"type": "auto_insurance",
"subtype": "telematics",
"created_at_timestamp": 1544506334000,
"expiry_timestamp": 1944506334000,
"details": {
"insurer_name": "Progressive",
"logo_url": "https://iql.zendrive.com/iql/v2/ad_unit/ad1/logo?dim_x=1000&dim_y=1000",
"title": "Your discount is waiting!",
"body": {
"text": "You qualify for an exclusive discount from our partner XYZ. You will get:",
"bullets": [
"Covered in minutes"
]
},
"button_text": "Get your discount!",
"button_click_url": <click_url>,
"legal": {
"disclaimers": {
"current_customer": "disclaimer for customers.",
"generic": "disclaimer for customers"
},
"privacy_policy_url": "https://www.privacy.com/",
"terms_and_conditions_url": "https://www.term_and_conditions.com"
}
}
},
{
"id": "ad_123bajdh354",
"type": "auto_insurance",
"subtype": "telematics",
"created_at_timestamp": 1544506334000,
"expiry_timestamp": 1944506334000,
"details": {
"insurer_name": "Progressive",
"logo_url": <logo_url>,
"title": "Your discount is waiting!",
"body": {
"text": "You qualify for an exclusive discount from our partner XYZ. You will get:",
"bullets": [
"Quick and personalized rates"
]
},
"button_text": "Get your discount!",
"button_click_url": <click_url>,
"legal": {
"disclaimers": {
"current_customer": "disclaimer",
"generic": "disclaimer"
},
"privacy_policy_url": "https://www.privacy.com/",
"terms_and_conditions_url": "https://www.term_and_conditions.com"
}
}
}
]
}
Response Fields
driver_info.publisher_app_name
Name of the application
String
driver_info.driver_id
Unique identifier for the driver
String
offers[i].id
Unique identifier for the ad
String
offers[i].type
Offer type: auto_insurance/ non_auto_insurance
String
offers[i].subtype
Offer subtype: telematics/drive/affiliate
String
offers[i].created_at_timestamp
EPOCH timestamp at which the offer was created for the user
Integer
offers[i].expiry_timestamp
EPOCH timestamp at which the offer will expire
Integer
offers[i].details.insurer_name
Insurer's name
String
offers[i].details.logo_url
The URL of the insurer's logo
String (URL)
offers[i].details.title
Title of the ad
String
offers[i].details.body.text
Body text of the ad unit. Length up to 325 characters
String
offers[i].details.body.bullets
Description of the offer in bullet points
String Array
offers[i].details.button_text
Text for button in the ad unit
String
offers[i].details.button_click_url
This is the ad click redirection URL, which will take the user to the Insurer's landing page.
String (URL)
offers[i].details.legal.disclaimers.current_customer
Customer-specific disclaimer text associated with an offer.
String
offers[i].details.legal.disclaimers.generic
Generic disclaimer text associated with an offer.
String
offers[i].details.legal.privacy_policy_url
URL of insurer’s privacy policy page
String (URL)
offers[i].details.legal.terms_and_conditions_url
URL of insurer’s Terms and Conditions page.
String (URL)