Skip to main content

Fetch Banner settings by region

To fetch your banner regions settings is simple, you just have to send a GET request to our API to the endpoint:

https://api.platform.illow.io/open-api/v1/banner-regions/:siteId
info

Don't forget to include your Access Key in the X-API-Key header of all your requests.

info

Don't forget to replace the URL parameters: :siteId with your site ID.

Request Path

PropertyTypeRequired?Description
siteIdstringYesThe company site ID

You will receive a JSON object with this format

Response Body

Format: JSON

PropertyTypeDescription
usRegion ObjectObject format to update banner information by regions for USA.
glRegion ObjectObject format to update banner information by regions for the rest of the World
euRegion ObjectObject format to update banner information by regions for EU.
siteIdstringThe company site ID

Region Object

PropertyTypeDescription
defaultstringA type of default banner for the region in case you do not have a specific one assigned for that Country/State
regionsListCountry object with its corresponding banner

List Country or State Object

PropertyTypeDescription
ISO Country/State codestringThe type of banner you want to display in that region

Examples

{
"us": {
"regions": {
"ca": "ccpaBanner",
"va": "fullyCompliantBanner",
"co": "fullyCompliantBanner",
"in": "fullyCompliantBanner",
"ut": "ccpaBanner"
},
"default": "fullyCompliantBanner"
},
"gl": {
"regions": {
"br": "gdprBanner",
"uy": "gdprBanner",
"mx": "fullyCompliantBanner",
"co": "fullyCompliantBanner",
"au": "fullyCompliantBanner",
"nz": "fullyCompliantBanner",
"ca": "gdprBanner",
"ph": "fullyCompliantBanner",
"jp": "fullyCompliantBanner",
"tr": "gdprBanner",
"th": "gdprBanner",
"kr": "gdprBanner",
"pe": "fullyCompliantBanner"
},
"default": "fullyCompliantBanner"
},
"eu": {
"regions": {
"ru": "fullyCompliantBanner",
"ch": "gdprBanner",
"gb": "gdprBanner"
},
"default": "gdprBanner"
},
"siteId": "df74637d-0a49-4db4-80db-785d44db2551"
}

Interactive API Reference

Take a look at our interactive Swagger Site!