UGC Techdocs
  • Introduction
  • Guides
    • Analytics
      • Tracking UGC on Adobe Analytics
      • Tracking Widget interactions with Google Analytics
    • Direct Uploader
      • How to add Custom Data to Direct Uploader
      • How to capture Custom Data on Direct Uploader
      • How to automatically tag data on Direct Uploader
      • How to Customize error messages on Direct Uploader
      • How to Track Direct Uploader form submissions with Google Analytics (Universal & GA 4)
    • Data Templates
      • Creating a Data Template
    • Rights via Registration
      • Capture Custom Data on Rights by Registration Form
      • Styling Rights via Registration Form
    • REST API
      • Caching REST API results for optimization
      • Posting content into Nosto via Tile API
      • Posting images into Nosto via Tile API
    • Onsite Widgets (2.0)
      • Blank Canvas
        • How to Use the Blank Canvas to Create a Twitter Count Widget
        • Creating an Auto-Scrolling Carousel using Blank Canvas
        • Creating Gallery Widget by Using the Blank Canvas Widget
        • Creating a simple Hover effect using Blank Canvas
        • Creating a Word Cloud using Blank Canvas
        • Creating Your Widget by Using the Blank Canvas
      • Bind your own Events
      • Creating a Grid Widget from Waterfall
      • Create a Q&A Widget using Data Templates
      • Displaying a Widget in a Mobile App
      • Dynamically Specify Products to Display in Widget
      • Dynamically specify what Tile to display in a Widget
      • How to add a title / subtitle to a widget
      • How to localize the load more button on widgets
      • How to overlay existing Google Map with the UGC Map Widget
      • How to use Filter and search in a Widget
      • How to change click on inline tile behaviour to redirect to PDP in a Widget
      • Styling cross-sellers on Grid and Carousel Widgets
      • How to Load External JS and CSS into Widgets
      • Profiling Widget Performance
      • Re-targeting with Widgets and Facebook Pixel
      • Render Widget filters dynamically
      • Styling Carousel Widget
      • Styling Grid Widget
      • Styling Masonry Widget
      • Styling Waterfall Widget
      • Styling Widget Expanded Tile
      • Styling Widget Shopspots
      • Using Web Fonts in Widgets
    • Digital Screens
      • Customizing Carousel Event Screen
      • Customizing Mosaic Event Screen
      • Customizing Scrollwall Event Screen
      • Customizing the Mosaic Event Screen to Have 9 Even Tiles
    • Email
      • Adding Location to an Email Tile
      • Styling the Email Widget
    • Integrations
      • DoubleClick
        • UGC Ads with Nosto and Google DoubleClick
      • Zapier
        • Consuming UGC Webhooks via Zapier
      • Mailchimp
        • Bring Social Content into a Mailchimp Campaign
    • Webhooks
      • Trigger notifications when content is in the moderation queue
  • Widgets
  • API Docs
    • JavaScript API
      • Widgets
        • Introduction
        • API Reference for Content Widgets
        • API Reference for Blank Canvas
        • API Reference for Map Widget
      • Digital Screens
        • Introduction
        • API Reference
    • Content API
      • Reference
    • REST API
      • Reference
        • Filters API
        • Moderation Views API
        • Tags API
        • Terms API
        • Tiles API
        • Users API
        • Widgets API
        • Automation Rules API
        • REST API Reference Widgets style and config
      • Best Practices
    • Webhooks
  • Enterprise Tools
    • Automation Rules
      • Triggers
      • Actions
      • Samples
    • Data Templates
    • User Access Control (UAC)
    • Single Sign On (SSO)
    • Enterprise Admin User Interface (EAUI)
    • Zapier
  • Commerce Tools
    • Product Feeds
    • Widget Implementation
    • Reporting
    • Integrations
      • Google Tag Manager
      • Magento
      • SalesForce Commerce Cloud
      • Shopify
      • Shopify Add To Cart
        • Global Variant Mapping for Add to Cart
        • Customise Add to Cart Widget Experience
  • Analytics
    • Google Analytics 4
      • Getting Started
      • Widgets Events
      • E-commerce Events
      • Email Events
  • Terms of Use
Powered by GitBook
On this page
  • Widgets
  • Properties
  • GET widgets
  • POST widgets
  • GET widgets/:widgetId
  • PUT widgets/:widgetId
  • DELETE widgets/:widgetId

Was this helpful?

  1. API Docs
  2. REST API
  3. Reference

Widgets API

PreviousUsers APINextAutomation Rules API

Last updated 10 months ago

Was this helpful?

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

✔

✔

Widget style config

config

✔

✔

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:

config properties

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.

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.

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

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

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

Properties
style properties
config properties
GET /api/widgets
POST /api/widgets
GET /api/widgets/:widgetId
PUT /api/widgets/:widgetId
DELETE /api/widgets/:widgetId
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
object
object
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)
Gallery (base_gallery)
Waterfall (base_waterfall)
Carousel (base_carousel)