Retrieving Banner Content Item Data

The Banner API implements REST API endpoint that provides the possibility to retrieve Banner content item data available in the storage.

In your development, these resources can help you get relevant information for your Banner content item for all or a specific locale. For example, you can view what page address your banner is linked to or what details are displayed for a specific locale.

Installation

For details on the modules that provide the API functionality and how to install them, see Content Items API.

Retrieving Banner Content Item Data

To retrieve the Banner content item data, send a GET request to the following endpoint:

/content-banners/{content_item_key}

Request sample: GET http://mysprykershop.com/content-banners/br-3 where content-banners is the content item type and br-3 is the key of the Banner content item you want to retrieve.

If the request is successful and the Banner content item with the specified content item key has been found, the endpoint will respond with RestContentBannerResponse.

Sample response:

{
	"data": {
		"type": "content-banners",
		"id": "br-3",
		"attributes": {
			"title": "Cameras Winter Collection",
			"subtitle": "The best cameras in winter 2019",
			"imageUrl": "http://d2s0ynfc62ej12.cloudfront.net/b2c/17360369_3328.jpg",
			"clickUrl": "/en/canon-powershot-n-35",
			"altText": "Best selling cameras in winter"
		},
		"links": {
			"self": "http://mysprykershop.com/content-banners/br-3"
		}
	}
}

• The fields mentioned are all attributes in the response. Type and ID are not mentioned.