/
v3.0.11Get access

getBanner

Retrieve banner contents for a specific component slug

Request parameters:

Name
DescriptionTypeValuesDefault
slug
Component slug identifierstring | number--
country
Country code used for global filteringstring--
useWebp
Whether to return WebP versions of imagesbooleantrue / false-
platform
Platform namestring"desktop" / "mobile"-

Call example:

getBanner({
  slug: 'home-banner',
  country: 'AM',
  useWebp: false,
  platform: 'desktop'
})

Response parameters:

NameDescriptionTypeValues
target
Link target attribute: "_blank", "_self", "_parent", or "_top"string-
title
Display title of the bannerstring-
src_type
Type of the media source (e.g. "image")string-
src
Path to the banner image assetstring-
href
URL the banner links to when clickedstring-