Widgets API

• Properties

  • style properties

  • config properties

• GET /api/widgets

• POST /api/widgets

• GET /api/widgets/:widgetId

• PUT /api/widgets/:widgetId

• DELETE /api/widgets/:widgetId

Widgets

Widgets refer to any touchpoint that can be embedded onto a digital property that is made up of either an "In-Line" or possibly also an "Expanded Tile" view. This endpoint allows you to create widgets and returns an embed code.

Properties

Field	Type	POST	PUT	Definition
id	integer	X	X	Widget ID
widget_type_id	integer	X	X	Widget type id
stack_id	integer	X	X	Widget stack Id
guid	string	X	X	Widget GUID
style	object	✔	✔	Widget style config
config	object	✔	✔	Widget config
filter_id	integer	✔	✔	Content filter for widget
enabled	boolean	✔	✔	Enabled widget
custom_css	string	✔	✔	Custom css for inline tile
lightbox_custom_css	string	✔	✔	Custom css for lightbox
custom_js	string	✔	✔	Custom javascript for inline tile
lightbox_custom_js	string	✔	✔	Custom javascript for lightbox
external_js	string	✔	✔	URL of external js to inject to parent page
embed_code	string	X	X	The widget embed code
gen	integer	X	X	Version of widget
style_name	string	X	X
created	string	X	X	ISO Date Time string
modified	string	X	X	ISO Date Time string
created_at	timestamp	X	X	Moderationview's creation time
updated_at	timestamp	X	X	Moderationview's modification time

style properties

Widget style:

• Gallery (base_gallery)

• Waterfall (base_waterfall)

• Carousel (base_carousel)

• Slideshow (base_slideshow)

• Billboard (base_billboard)

• Feed (base_feed)

• Blank Canvas (base_blankcanvas)

• Map Leaflet (base_map_leaflet)

config properties

• Gallery (base_gallery)

• Waterfall (base_waterfall)

• Carousel (base_carousel)

Back to Top

GET widgets

Retrieves all widget available in the Stack.

Resource URL

https://api.stackla.com/api/widgets

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

No additional request parameters are available.

Back to Top

POST widgets

Creates a new widget in the Stack.

Resource URL

https://api.stackla.com/api/widgets

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

No additional request parameters are available.

Back to Top

GET widgets/:widgetId

Retrieves a specific widget available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/widgets/:widgetId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name	Mandatory	Request type	Description
widgetId	Yes	endpoint	ID of the widget

Back to Top

PUT widgets/:widgetId

Updates a specific widget available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/widgets/:widgetId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name	Mandatory	Request type	Description
widgetId	Yes	endpoint	ID of the widget

Back to Top

DELETE widgets/:widgetId

Deletes a specific widget available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/widgets/:widgetId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name	Mandatory	Request type	Description
widgetId	Yes	endpoint	ID of the widget

Back to Top