Opened Widget

This event should be fired for any page on which a widget is loaded or rendered.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
{
  "uid": "d284fb3c-5c29-e316-ed71-8ce7852f8e50", //required, any unique string that tracks the user currently browsing
  "parentURL": "https://referral-url.com", //optional but recommended, the URL on which the user loaded the widget
  "API_KEY": "abcdefg", //required, the Pixlee ACCOUNT PRIVATE API KEY
  "widget": "Horizontal", //optional but recommended, the style of widget. recommended options are Horizontal, Photowall, Mosaic, Coverflow, Vertical.
  "album_id": 12345, //required, the Pixlee album id from which you are displaying content
  "photos": "134827,34824,234957" //'album_photo_id's joined with a comma
}
Query Params
string
required

Account Private API Key (can also be api_key)

string

Distinct user hash for the visitor. Must be at least 5 characters for the event to be processed.

uri

Page URL where the event occurred. (Recommended)

string

Browser fingerprint used to resolve the visitor device.

string

Client IP address.

string

Widget type or layout name.

Pixlee album ID. Accepts an integer or numeric string.

string

Comma-separated list of album photo IDs displayed in the widget.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json