Download OpenAPI specification:
Webhooks are a powerful mechanism that empowers customers to respond to a wide range of events, including changes in content items and creator interactions. This capability enables a seamless and nearly real-time integration with a customer's website or mobile app, enhancing their ability to stay up-to-date with the latest changes and interactions.
With webhooks, customers can effortlessly implement their own messaging or caching systems without the need for continuous polling to check for updates. Instead, updates are pushed directly to them as soon as they occur, ensuring that their content hubs remain consistently up to date and their customers get notified about relevant events.
Navigate to the Developer page within the LiSA dashboard to configure webhooks for either your Sandbox or Production environment.
Create an API endpoint on your server that can handle incoming HTTP POST
requests. The webhook data will be transmitted in JSON
format within the body of the POST
request.
Your server must respond with one of the following HTTP status codes:
200
— OK202
— Accepted204
— No contentIf an endpoint cannot be reached or if your server does not respond with an HTTP status code of 200
, 202
or 204
, the webhook notification will be temporarily paused, and an automatic retry to send the notification will occur after a short delay.
If a webhook notification fails three times, the webhook subscription will be temporarily suspended and flagged with a warning on the developer page.
To confirm the response status code, you can use the Test button on the Developer page. A successful test is indicated by a 200
status code, while any other response unexpected code will result in a test failure.
Collection | Action | Description |
---|---|---|
Show | create |
A new show is created. |
Show | delete |
A show is either archived or removed. |
Show | publish |
A show is published. |
Show | start |
A show live stream is started. |
Show | stop |
A show live stream is stopped. |
Show | unpublish |
A show is unpublished. |
Show | update |
A show is modified. |
Snippet | create |
A new snippet is created. |
Snippet | delete |
A snippet is either archived or removed. |
Snippet | publish |
A snippet is published. |
Snippet | unpublish |
A snippet is unpublished. |
Snippet | update |
A snippet is modified. |
Story | create |
A new story is created. |
Story | delete |
A story is either archived or removed. |
Story | publish |
A story is published. |
Story | unpublish |
A story is unpublished. |
Story | update |
A story is modified. |
Webhooks are frequently enhanced with additional collections and actions. Your server should respond to the particular collections and actions that you identify and acknowledge.
required | object An accurate description of the fields that have been either removed or updated with the current change. |
required | object (ComposedShow) The show object after creation/modification or before removal. |
eventDate required | string <date-time> The date on which the webhook event was sent. |
eventType required | string Enum: "Show:*" "Show:create" "Show:delete" "Show:publish" "Show:start" "Show:stop" "Show:unpublish" "Show:update" The distinct type of this event. |
client required | string <^(\*|[a-z]+(-[a-z]+)*)$> The distinct, universally unique client identifier. |
id required | string <uuid> A universally unique identifier. |
{- "id": "305419d6-de10-457d-9cf3-d300f5f65a2c",
- "change": {
- "removed": [
- "meta.archivedAt",
- "meta.archivedBy"
], - "updated": {
- "meta.modifiedAt": "2021-06-23T10:15:00.000Z"
}
}, - "client": "lisa",
- "detail": {
- "id": "fc8787b2-2bb0-4598-b730-a1a9d78b0358",
- "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "modifiedAt": "2021-06-23T10:15:00.000Z"
}, - "name": "SUMMER10",
- "status": "ready",
- "accessToken": "e7c39c61-f087-4c20-b9d7-31ee949e6dec",
- "accessibility": "public",
- "assets": {
- "card": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "teaser": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "conducted": true,
- "date": "2023-06-23T10:15:00.000Z",
- "description": {
- "*": "Join Rosie and Holly to shop the must-buys you love, now at up to 50% off! Be quick, these looks won't last long"
}, - "features": {
- "carousel": {
- "enabled": true,
- "items": [
- {
- "highlighted": true,
- "itemId": "70a516fc-abca-4a20-8587-ae403416cb26",
- "position": 1,
- "sold": false,
- "visible": true,
- "type": "product",
- "itemData": {
- "brand": {
- "*": "Just an Ordinary Winery"
}, - "description": {
- "*": "Experience the allure of our 2007 California Pinot Noir. With a captivating ruby hue, velvety texture, and rich flavors of cherry and raspberry, this vintage embodies the essence of fine winemaking. Perfect for intimate dinners and social gatherings.",
- "fr": "Découvrez l'attrait de notre Pinot Noir californien de 2007. Avec sa robe rubis captivante, sa texture veloutée et ses saveurs riches de cerise et de framboise, ce millésime incarne l'essence de l'art de la vinification. Parfait pour des dîners intimes et des rassemblements sociaux."
}, - "hasStock": true,
- "id": "70a516fc-abca-4a20-8587-ae403416cb26",
- "mainImage": {
- "height": 1920,
- "width": 1080
}, - "name": "2007 California Pinot Noir",
- "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 89.99,
- "salePrice": 69.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 9,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 7.78
}
}, - "reference": "5618787973",
- "storeOverrides": [
- {
- "hasStock": true,
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 119.99,
- "salePrice": 92.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 11.99,
- "measureUnit": "l",
- "measureValue": 1.29,
- "value": 10
}
}, - "store": "ca",
}
], - "title": {
- "*": "2007 California Pinot Noir",
- "fr": "Pinot Noir de Californie 2007"
}, - "variants": [
- {
- "hasStock": true,
- "id": "b353b793-2d76-4d15-87be-5e66ab62f4c4",
- "mainImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 49.99,
- "salePrice": 39.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 4.5,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 8.89
}
}, - "reference": "2762742728",
- "storeOverrides": [
- {
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 66.99,
- "salePrice": 52.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 5.99,
- "measureUnit": "l",
- "measureValue": 1.32,
- "value": 11.68
}
}, - "store": "ca"
}
], - "title": {
- "*": "2007 California Pinot Noir - 3 x 750ml",
- "fr": "Pinot Noir de Californie 2007 - 3 x 750ml"
}, - "variations": [
- {
- "type": "size",
- "value": {
- "*": "3 x 750ml"
}
}
]
}
]
}
}
]
}, - "chat": {
- "enabled": true
}
}, - "hosts": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "live": false,
- "options": {
- "addToCalendar": true,
- "backgroundColor": "transparent",
- "carouselReplay": true,
- "carouselReplayEvents": true,
- "chatReplay": true,
- "countdown": true,
- "hostAvatars": true,
- "language": "en",
- "share": true,
- "showDate": true,
- "videoOutput": [
- "portrait"
], - "videoProfile": "720p_2",
- "enableReplayAt": "2023-08-01T08:00:00.000Z"
}, - "preRecorded": false,
- "preview": {
- "enabled": true,
- "token": "e0abfb8c-fd55-4243-8c53-feca74fb877a"
}, - "promotion": [
- "alert"
], - "rtmpDestinations": [
- null
], - "streams": [
- {
- "id": "51e54b51-56ef-46a3-8623-c616d8a55de8",
- "end": "2023-01-19T18:00:00.000Z",
- "metrics": {
- "durationInMs": 2700000,
- "numberOfEmojis": 1811,
- "numberOfMessages": 802,
- "numberOfViewers": 3523
}, - "recordings": [
- {
- "id": "2c4f057e-8da3-4ac3-a10b-22af5826520c",
- "orientation": "portrait",
- "poster": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "startAt": 0,
- "subtitles": [
- {
- "language": "en",
}
], - "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}
], - "shortClips": [
- {
- "assets": {
- "medium": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}, - "small": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}, - "id": "75b890f0-58a3-4c2f-bec4-ec4c8505b405",
- "orientation": "portrait",
}
], - "start": "2023-01-19T18:45:00.000Z",
- "type": "live"
}
], - "title": {
- "*": "Must-buys you love"
}, - "views": {
- "preShow": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Must-buys you love"
}, - "teaser": {
- "*": "Join Lisa when she reveals new drops you will absolutely love!"
}, - "options": {
- "backgroundColor": "#e1498c"
}
}, - "replay": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Watch the replay"
}, - "teaser": {
- "*": "Watch Lisa as she revealed new drops you do not want to miss out on!"
}, - "options": {
- "backgroundColor": "#c35fc9"
}
}
}
}, - "eventDate": "2021-06-23T10:15:00.000Z",
- "eventType": "Show:create"
}
Verifying the origin and content of a previously transmitted webhook is possible by initiating a request to the source, utilizing the event's id
property.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "id": "305419d6-de10-457d-9cf3-d300f5f65a2c",
- "change": {
- "removed": [
- "meta.archivedAt",
- "meta.archivedBy"
], - "updated": {
- "meta.modifiedAt": "2021-06-23T10:15:00.000Z"
}
}, - "client": "lisa",
- "detail": {
- "id": "fc8787b2-2bb0-4598-b730-a1a9d78b0358",
- "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "modifiedAt": "2021-06-23T10:15:00.000Z"
}, - "name": "SUMMER10",
- "status": "ready",
- "accessToken": "e7c39c61-f087-4c20-b9d7-31ee949e6dec",
- "accessibility": "public",
- "assets": {
- "card": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "teaser": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "conducted": true,
- "date": "2023-06-23T10:15:00.000Z",
- "description": {
- "*": "Join Rosie and Holly to shop the must-buys you love, now at up to 50% off! Be quick, these looks won't last long"
}, - "features": {
- "carousel": {
- "enabled": true,
- "items": [
- {
- "highlighted": true,
- "itemId": "70a516fc-abca-4a20-8587-ae403416cb26",
- "position": 1,
- "sold": false,
- "visible": true,
- "type": "product",
- "itemData": {
- "brand": {
- "*": "Just an Ordinary Winery"
}, - "description": {
- "*": "Experience the allure of our 2007 California Pinot Noir. With a captivating ruby hue, velvety texture, and rich flavors of cherry and raspberry, this vintage embodies the essence of fine winemaking. Perfect for intimate dinners and social gatherings.",
- "fr": "Découvrez l'attrait de notre Pinot Noir californien de 2007. Avec sa robe rubis captivante, sa texture veloutée et ses saveurs riches de cerise et de framboise, ce millésime incarne l'essence de l'art de la vinification. Parfait pour des dîners intimes et des rassemblements sociaux."
}, - "hasStock": true,
- "id": "70a516fc-abca-4a20-8587-ae403416cb26",
- "mainImage": {
- "height": 1920,
- "width": 1080
}, - "name": "2007 California Pinot Noir",
- "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 89.99,
- "salePrice": 69.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 9,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 7.78
}
}, - "reference": "5618787973",
- "storeOverrides": [
- {
- "hasStock": true,
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 119.99,
- "salePrice": 92.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 11.99,
- "measureUnit": "l",
- "measureValue": 1.29,
- "value": 10
}
}, - "store": "ca",
}
], - "title": {
- "*": "2007 California Pinot Noir",
- "fr": "Pinot Noir de Californie 2007"
}, - "variants": [
- {
- "hasStock": true,
- "id": "b353b793-2d76-4d15-87be-5e66ab62f4c4",
- "mainImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 49.99,
- "salePrice": 39.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 4.5,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 8.89
}
}, - "reference": "2762742728",
- "storeOverrides": [
- {
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 66.99,
- "salePrice": 52.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 5.99,
- "measureUnit": "l",
- "measureValue": 1.32,
- "value": 11.68
}
}, - "store": "ca"
}
], - "title": {
- "*": "2007 California Pinot Noir - 3 x 750ml",
- "fr": "Pinot Noir de Californie 2007 - 3 x 750ml"
}, - "variations": [
- {
- "type": "size",
- "value": {
- "*": "3 x 750ml"
}
}
]
}
]
}
}
]
}, - "chat": {
- "enabled": true
}
}, - "hosts": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "live": false,
- "options": {
- "addToCalendar": true,
- "backgroundColor": "transparent",
- "carouselReplay": true,
- "carouselReplayEvents": true,
- "chatReplay": true,
- "countdown": true,
- "hostAvatars": true,
- "language": "en",
- "share": true,
- "showDate": true,
- "videoOutput": [
- "portrait"
], - "videoProfile": "720p_2",
- "enableReplayAt": "2023-08-01T08:00:00.000Z"
}, - "preRecorded": false,
- "preview": {
- "enabled": true,
- "token": "e0abfb8c-fd55-4243-8c53-feca74fb877a"
}, - "promotion": [
- "alert"
], - "rtmpDestinations": [
- null
], - "streams": [
- {
- "id": "51e54b51-56ef-46a3-8623-c616d8a55de8",
- "end": "2023-01-19T18:00:00.000Z",
- "metrics": {
- "durationInMs": 2700000,
- "numberOfEmojis": 1811,
- "numberOfMessages": 802,
- "numberOfViewers": 3523
}, - "recordings": [
- {
- "id": "2c4f057e-8da3-4ac3-a10b-22af5826520c",
- "orientation": "portrait",
- "poster": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "startAt": 0,
- "subtitles": [
- {
- "language": "en",
}
], - "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}
], - "shortClips": [
- {
- "assets": {
- "medium": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}, - "small": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}, - "id": "75b890f0-58a3-4c2f-bec4-ec4c8505b405",
- "orientation": "portrait",
}
], - "start": "2023-01-19T18:45:00.000Z",
- "type": "live"
}
], - "title": {
- "*": "Must-buys you love"
}, - "views": {
- "preShow": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Must-buys you love"
}, - "teaser": {
- "*": "Join Lisa when she reveals new drops you will absolutely love!"
}, - "options": {
- "backgroundColor": "#e1498c"
}
}, - "replay": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Watch the replay"
}, - "teaser": {
- "*": "Watch Lisa as she revealed new drops you do not want to miss out on!"
}, - "options": {
- "backgroundColor": "#c35fc9"
}
}
}
}, - "eventDate": "2021-06-23T10:15:00.000Z",
- "eventType": "Show:create"
}
This API endpoint allows you to retrieve detailed information about a single webhook subscription based on its unique identifier (resourceId
).
You can access specific subscription details, including event types, target URL, and any other relevant information associated with the subscription.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "id": "04a99ca3-00a7-463c-ad44-234e04dca3e0",
- "eventTypes": [
- "Show:*",
- "Story:publish",
- "Story:unpublish"
], - "status": "active",
}
This API endpoint allows you to remove a previously registered webhook subscription based on its unique identifier (resourceId
).
When a subscription is removed, the notification service will stop sending webhook payloads to the specified target URL for the subscribed event types.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "code": "Http:Unauthorized",
- "message": "You are not authorized to access the target resource.",
- "statusCode": 401
}
This API endpoint allows you to retrieve information about your webhook subscriptions.
{- "items": [
- {
- "id": "04a99ca3-00a7-463c-ad44-234e04dca3e0",
- "eventTypes": [
- "Show:*",
- "Story:publish",
- "Story:unpublish"
], - "status": "active",
}
]
}
This endpoint allows you to register a webhook subscription, specifying the webhook event types they want to listen for, the target URL where webhook payloads should be delivered, and any required authentication settings to secure the webhook communication.
The request should include a JSON object with the following parameters:
eventTypes | Array of strings (WebhookEventType) Items Enum: "*" "Show:*" "Show:create" "Show:delete" "Show:publish" "Show:start" "Show:stop" "Show:unpublish" "Show:update" "Snippet:*" "Snippet:create" "Snippet:delete" "Snippet:publish" "Snippet:unpublish" "Snippet:update" "Story:*" "Story:create" "Story:delete" "Story:publish" "Story:unpublish" "Story:update" An array of distinct webhook event types. The event types allows for wildcards to either subscribe to ALL events or all events of a collection:
|
ApiCredentialsAwsSigV4 (object) or ApiCredentialsBasicAuth (object) or ApiCredentialsBearer (object) or ApiCredentialsNone (object) or ApiCredentialsOAuth (object) The distinct authentication mechanism to apply when calling the webhook URL. HTTP basic authentication (
| |
webhookUrl | string <url> The webhook target URL to call upon subscribed events being emitted. |
{- "eventTypes": [
- "*"
], - "credentials": {
- "authType": "oauth",
- "clientId": "client-id",
- "clientSecret": "secure-client-secret"
},
}
{- "id": "04a99ca3-00a7-463c-ad44-234e04dca3e0",
- "client": "lisa",
- "eventTypes": [
- "Show:*",
- "Story:publish",
- "Story:unpublish"
], - "status": "active",
}
Deleting a channel doesn't remove it from the database. If the target channel's status
is one of draft
, processing
or ready
it will get scheduled for removal. Unless it gets removed upon repeated DELETE
request, the channel will remain archived
for another 30 days.
During that period customers can restore the channel. Otherwise, the channel's status
is set to removed
automatically, once the retention period expires.
If the target channel's status
is archived
, it's status
is set to removed
. From that state it can no longer be restored, and it will no longer appear anywhere.
required | Slug (string) or Uuid (string) (ResourceIdOrSlugParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier or slug. |
{- "code": "Http:Unauthorized",
- "message": "You are not authorized to access the target resource.",
- "statusCode": 401
}
This API endpoint allows you to retrieve detailed information about a single channel resource based on its unique identifier or slug (resourceIdOrSlug
).
You can access specific show details, including channel description, date of publication, media assets, and any other relevant information associated with the channel.
required | Slug (string) or Uuid (string) (ResourceIdOrSlugParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier or slug. |
{- "assets": {
- "landscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "portrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "thumbnail": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "description": {
- "*": "Dive into a world of style, trends, and inspiration with our Fashion Channel. Your one-stop hub for all things chic, from runway glam to streetwear cool. Get ready to elevate your fashion game!"
}, - "highlightedShows": [
- "42ed48a3-0930-4411-9eaf-e54287a7fc31",
- "6cb084a8-1bc9-4e19-b09c-632696c1d6fc"
], - "hosts": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "id": "668d5293-bf80-44d0-907d-20a2d8543fbf",
- "slug": "fashion",
- "title": {
- "*": "Fashion"
},
}
Updates selected fields for the target channel resource.
required | Slug (string) or Uuid (string) (ResourceIdOrSlugParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier or slug. |
name | string A name used for internal reference. |
slug | string The distinct slug of the channel. |
object The title of the channel. A map of key-value pairs for multi-lingual texts.
Set value to | |
url | string <url> A URL of a merchants site, where all video content of the channel is accessible. Set value to |
{- "name": "Fashion"
}
{- "id": "668d5293-bf80-44d0-907d-20a2d8543fbf",
- "clientIdentity": {
- "client": "lisa",
- "seller": "brand"
}, - "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "createdBy": {
- "id": "44325844-7bac-42e6-b58f-0674d3fb714d",
- "username": "lisa"
}, - "modifiedAt": "2021-06-23T10:15:00.000Z",
- "modifiedBy": {
- "id": "44325844-7bac-42e6-b58f-0674d3fb714d",
- "username": "lisa"
}
}, - "name": "Fashion",
- "status": "ready",
- "assets": {
- "landscape": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}, - "portrait": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}, - "thumbnail": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}
}, - "description": {
- "*": "Dive into a world of style, trends, and inspiration with our Fashion Channel. Your one-stop hub for all things chic, from runway glam to streetwear cool. Get ready to elevate your fashion game!"
}, - "highlightedShows": [
- {
- "id": "42ed48a3-0930-4411-9eaf-e54287a7fc31"
}, - {
- "id": "6cb084a8-1bc9-4e19-b09c-632696c1d6fc"
}
], - "hosts": [
- {
- "id": "a32e998c-17af-4c60-b709-66f294615d78",
- "username": "liz.erd"
}
], - "slug": "fashion",
- "title": {
- "*": "Fashion"
}, - "useOrOperator": true
}
Create a new channel.
name required | string A name used for internal reference. |
slug | string <^[a-z0-9]+(-[a-z0-9]+)*$> The distinct slug of the channel. If omitted, the |
object The title of the channel. A map of key-value pairs for multi-lingual texts.
| |
url | string <url> The URL where all video content of the channel is accessible. |
{- "name": "Fashion",
- "slug": "fashion",
- "title": {
- "*": "Fashion"
},
}
{- "id": "668d5293-bf80-44d0-907d-20a2d8543fbf",
- "clientIdentity": {
- "client": "lisa",
- "seller": "brand"
}, - "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "createdBy": {
- "id": "44325844-7bac-42e6-b58f-0674d3fb714d",
- "username": "lisa"
}, - "modifiedAt": "2021-06-23T10:15:00.000Z",
- "modifiedBy": {
- "id": "44325844-7bac-42e6-b58f-0674d3fb714d",
- "username": "lisa"
}
}, - "name": "Fashion",
- "status": "ready",
- "assets": {
- "landscape": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}, - "portrait": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}, - "thumbnail": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}
}, - "description": {
- "*": "Dive into a world of style, trends, and inspiration with our Fashion Channel. Your one-stop hub for all things chic, from runway glam to streetwear cool. Get ready to elevate your fashion game!"
}, - "highlightedShows": [
- {
- "id": "42ed48a3-0930-4411-9eaf-e54287a7fc31"
}, - {
- "id": "6cb084a8-1bc9-4e19-b09c-632696c1d6fc"
}
], - "hosts": [
- {
- "id": "a32e998c-17af-4c60-b709-66f294615d78",
- "username": "liz.erd"
}
], - "slug": "fashion",
- "title": {
- "*": "Fashion"
}, - "useOrOperator": true
}
This API endpoint allows you to retrieve information about channels.
You can apply various filters and sorting options to customize your search for channels.
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
limit | number <int32> (ScrollingLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
status | string (FilterChannelStatusParameter) Enum: "archived" "draft" "processing" "ready" Example: status=draft The status to filter resources by. If omitted, all non- |
{- "items": [
- {
- "assets": {
- "landscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "portrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "thumbnail": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "description": {
- "*": "Dive into a world of style, trends, and inspiration with our Fashion Channel. Your one-stop hub for all things chic, from runway glam to streetwear cool. Get ready to elevate your fashion game!"
}, - "highlightedShows": [
- "42ed48a3-0930-4411-9eaf-e54287a7fc31",
- "6cb084a8-1bc9-4e19-b09c-632696c1d6fc"
], - "hosts": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "id": "668d5293-bf80-44d0-907d-20a2d8543fbf",
- "slug": "fashion",
- "title": {
- "*": "Fashion"
},
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to count channels.
You can apply various filters to customize your search for channels.
status | string (FilterChannelStatusParameter) Enum: "archived" "draft" "processing" "ready" Example: status=draft The status to filter resources by. If omitted, all non- |
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}
This API endpoint allows you to retrieve product references of all products that are synchronized between LiSA your e-commerce system.
{- "items": [
- "7ab10323-d3e7-4ea0-bdca-66020eafe82f"
]
}
This API endpoint allows you to retrieve detailed information about a single short-clip resource based on its unique identifier (resourceId
).
You can access specific short-clip details, including short-clip video URLs, and any other relevant information associated with the short-clip.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "id": "75b890f0-58a3-4c2f-bec4-ec4c8505b405",
- "assets": {
- "medium": {
- "durationInMs": 8000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 640,
- "sizeInBytes": 713630,
- "width": 360
}, - "small": {
- "durationInMs": 8000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 256,
- "sizeInBytes": 79078,
- "width": 144
}
}, - "meta": {
- "createdAt": "2024-12-20T08:37:18.274Z",
- "modifiedAt": "2024-12-20T08:37:40.814Z"
}, - "orientation": "portrait",
- "recordingId": "a92f0020-a19a-4081-aa2c-6f8e3debdb22",
- "showId": "e7c39c61-f087-4c20-b9d7-31ee949e6dec",
- "startTimeInMs": 779564
}
This API endpoint allows you to retrieve information about live short clips.
You can apply various filters and sorting options to customize your search for shows.
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
limit | number <int32> (ScrollingLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
modified_since | string (FilterShortClipModifiedSinceParameter) Filter short-clips by their date of last modification. Only short-clips that have been modified after the provided date will be included in the response. The
Accepted formats:
|
sort | string (ScrollingSortParameter) Example: sort=date%3Adesc%2Cname%3Aasc The sort order of the items to return. It accepts a URL-encoded series of key-value pairs, with key being the desired field to sort by and value being the desired order (either |
orientation | string (FilterShortClipOrientationParameter) Enum: "landscape" "portrait" Filter short-clips by their orientation. |
show_id | string (FilterShortClipShowIdParameter) non-empty Example: show_id=11b6bfae-2fd7-4e2c-b9d4-c9c0e961e6e8 The Specified values are considered a full match when executing the query. |
{- "items": [
- {
- "id": "75b890f0-58a3-4c2f-bec4-ec4c8505b405",
- "assets": {
- "medium": {
- "durationInMs": 8000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 640,
- "sizeInBytes": 713630,
- "width": 360
}, - "small": {
- "durationInMs": 8000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 256,
- "sizeInBytes": 79078,
- "width": 144
}
}, - "meta": {
- "createdAt": "2024-12-20T08:37:18.274Z",
- "modifiedAt": "2024-12-20T08:37:40.814Z"
}, - "orientation": "portrait",
- "recordingId": "a92f0020-a19a-4081-aa2c-6f8e3debdb22",
- "showId": "e7c39c61-f087-4c20-b9d7-31ee949e6dec",
- "startTimeInMs": 779564
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to retrieve the number of short clips available.
You can apply various filters to customize your search for short clips.
modified_since | string (FilterShortClipModifiedSinceParameter) Filter short-clips by their date of last modification. Only short-clips that have been modified after the provided date will be included in the response. The
Accepted formats:
|
orientation | string (FilterShortClipOrientationParameter) Enum: "landscape" "portrait" Filter short-clips by their orientation. |
show_id | string (FilterShortClipShowIdParameter) non-empty Example: show_id=11b6bfae-2fd7-4e2c-b9d4-c9c0e961e6e8 The Specified values are considered a full match when executing the query. |
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}
This API endpoint allows you to retrieve RTMP stream keys associated with a distinct show
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "items": [
- {
- "rtmpUrl": "rtmp://rtmp.hello-lisa.com/live/A0j5ptIcqnI2CQHd3zbQjUcgR58rbYH",
- "streamKey": "A0j5ptIcqnI2CQHd3zbQjUcgR58rbYH"
}
]
}
This API endpoint allows you to retrieve the number of RTMP stream keys associated with a show.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}
This API endpoint allows you to retrieve detailed information about a single show resource based on its unique identifier (resourceId
).
You can access specific show details, including show description, date and time, creators, and any other relevant information associated with the show.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "id": "fc8787b2-2bb0-4598-b730-a1a9d78b0358",
- "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "modifiedAt": "2021-06-23T10:15:00.000Z"
}, - "name": "SUMMER10",
- "status": "ready",
- "accessToken": "e7c39c61-f087-4c20-b9d7-31ee949e6dec",
- "accessibility": "public",
- "assets": {
- "card": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "teaser": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "conducted": true,
- "date": "2023-06-23T10:15:00.000Z",
- "description": {
- "*": "Join Rosie and Holly to shop the must-buys you love, now at up to 50% off! Be quick, these looks won't last long"
}, - "features": {
- "carousel": {
- "enabled": true,
- "items": [
- {
- "highlighted": true,
- "itemId": "70a516fc-abca-4a20-8587-ae403416cb26",
- "position": 1,
- "sold": false,
- "visible": true,
- "type": "product",
- "itemData": {
- "brand": {
- "*": "Just an Ordinary Winery"
}, - "description": {
- "*": "Experience the allure of our 2007 California Pinot Noir. With a captivating ruby hue, velvety texture, and rich flavors of cherry and raspberry, this vintage embodies the essence of fine winemaking. Perfect for intimate dinners and social gatherings.",
- "fr": "Découvrez l'attrait de notre Pinot Noir californien de 2007. Avec sa robe rubis captivante, sa texture veloutée et ses saveurs riches de cerise et de framboise, ce millésime incarne l'essence de l'art de la vinification. Parfait pour des dîners intimes et des rassemblements sociaux."
}, - "hasStock": true,
- "id": "70a516fc-abca-4a20-8587-ae403416cb26",
- "mainImage": {
- "height": 1920,
- "width": 1080
}, - "name": "2007 California Pinot Noir",
- "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 89.99,
- "salePrice": 69.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 9,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 7.78
}
}, - "reference": "5618787973",
- "storeOverrides": [
- {
- "hasStock": true,
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 119.99,
- "salePrice": 92.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 11.99,
- "measureUnit": "l",
- "measureValue": 1.29,
- "value": 10
}
}, - "store": "ca",
}
], - "title": {
- "*": "2007 California Pinot Noir",
- "fr": "Pinot Noir de Californie 2007"
}, - "variants": [
- {
- "hasStock": true,
- "id": "b353b793-2d76-4d15-87be-5e66ab62f4c4",
- "mainImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 49.99,
- "salePrice": 39.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 4.5,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 8.89
}
}, - "reference": "2762742728",
- "storeOverrides": [
- {
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 66.99,
- "salePrice": 52.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 5.99,
- "measureUnit": "l",
- "measureValue": 1.32,
- "value": 11.68
}
}, - "store": "ca"
}
], - "title": {
- "*": "2007 California Pinot Noir - 3 x 750ml",
- "fr": "Pinot Noir de Californie 2007 - 3 x 750ml"
}, - "variations": [
- {
- "type": "size",
- "value": {
- "*": "3 x 750ml"
}
}
]
}
]
}
}
]
}, - "chat": {
- "enabled": true
}
}, - "hosts": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "live": false,
- "options": {
- "addToCalendar": true,
- "backgroundColor": "transparent",
- "carouselReplay": true,
- "carouselReplayEvents": true,
- "chatReplay": true,
- "countdown": true,
- "hostAvatars": true,
- "language": "en",
- "share": true,
- "showDate": true,
- "videoOutput": [
- "portrait"
], - "videoProfile": "720p_2",
- "enableReplayAt": "2023-08-01T08:00:00.000Z"
}, - "preRecorded": false,
- "preview": {
- "enabled": true,
- "token": "e0abfb8c-fd55-4243-8c53-feca74fb877a"
}, - "promotion": [
- "alert"
], - "rtmpDestinations": [
- null
], - "streams": [
- {
- "id": "51e54b51-56ef-46a3-8623-c616d8a55de8",
- "end": "2023-01-19T18:00:00.000Z",
- "metrics": {
- "durationInMs": 2700000,
- "numberOfEmojis": 1811,
- "numberOfMessages": 802,
- "numberOfViewers": 3523
}, - "recordings": [
- {
- "id": "2c4f057e-8da3-4ac3-a10b-22af5826520c",
- "orientation": "portrait",
- "poster": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "startAt": 0,
- "subtitles": [
- {
- "language": "en",
}
], - "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}
], - "shortClips": [
- {
- "assets": {
- "medium": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}, - "small": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}, - "id": "75b890f0-58a3-4c2f-bec4-ec4c8505b405",
- "orientation": "portrait",
}
], - "start": "2023-01-19T18:45:00.000Z",
- "type": "live"
}
], - "title": {
- "*": "Must-buys you love"
}, - "views": {
- "preShow": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Must-buys you love"
}, - "teaser": {
- "*": "Join Lisa when she reveals new drops you will absolutely love!"
}, - "options": {
- "backgroundColor": "#e1498c"
}
}, - "replay": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Watch the replay"
}, - "teaser": {
- "*": "Watch Lisa as she revealed new drops you do not want to miss out on!"
}, - "options": {
- "backgroundColor": "#c35fc9"
}
}
}
}
This API endpoint allows you to retrieve information about live shows and their replays.
You can apply various filters and sorting options to customize your search for shows.
category | string (FilterCategoryParameter) non-empty Example: category=women The Specified values are considered a full match when executing the query. |
channel | string <^[a-z0-9]+(-[a-z0-9]+)*$> (FilterChannelParameter) non-empty Example: channel=my-slug The distinct channel slug to filter records by. |
conducted | string (FilterShowConductedParameter) Enum: "0" "1" "false" "no" "true" "yes" Filter shows by their Accepted values for
|
creator | string (FilterCreatorParameter) non-empty Example: creator=jane.doe The Specified values are considered a full match when executing the query. |
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
date | string (FilterShowDateParameter) Filter shows by their scheduled date. The
The first value represents the lower threshold, and the second one is the upper threshold. At least one of these values must be specified. Accepted formats:
To filter records within a specific date range, use the
Note: If only one date value is provided, it will be treated as either the lower or upper threshold, depending on its position in the parameter. |
limit | number <int32> (FilterShowLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
live | string (FilterShowLiveParameter) Enum: "0" "1" "false" "no" "true" "yes" Filter shows by their Accepted values for
|
modified_since | string (FilterShowModifiedSinceParameter) Filter shows by their date of last modification. Only shows that have been modified after the provided date will be included in the response. The
Accepted formats:
|
sort | string (ScrollingSortParameter) Example: sort=date%3Adesc%2Cname%3Aasc The sort order of the items to return. It accepts a URL-encoded series of key-value pairs, with key being the desired field to sort by and value being the desired order (either |
status | string (FilterShowStatusParameter) Enum: "archived" "draft" "ready" Filter shows by their status. Allowed values:
Multiple values can be provided as a comma-separated list. |
tag | string (FilterTagParameter) non-empty Example: tag=casual The Specified values are considered a full match when executing the query. |
{- "items": [
- {
- "id": "fc8787b2-2bb0-4598-b730-a1a9d78b0358",
- "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "modifiedAt": "2021-06-23T10:15:00.000Z"
}, - "name": "SUMMER10",
- "status": "ready",
- "accessToken": "e7c39c61-f087-4c20-b9d7-31ee949e6dec",
- "accessibility": "public",
- "assets": {
- "card": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionLandscape": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "promotionPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "teaser": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "conducted": true,
- "date": "2023-06-23T10:15:00.000Z",
- "description": {
- "*": "Join Rosie and Holly to shop the must-buys you love, now at up to 50% off! Be quick, these looks won't last long"
}, - "features": {
- "carousel": {
- "enabled": true,
- "items": [
- {
- "highlighted": true,
- "itemId": "70a516fc-abca-4a20-8587-ae403416cb26",
- "position": 1,
- "sold": false,
- "visible": true,
- "type": "product",
- "itemData": {
- "brand": {
- "*": "Just an Ordinary Winery"
}, - "description": {
- "*": "Experience the allure of our 2007 California Pinot Noir. With a captivating ruby hue, velvety texture, and rich flavors of cherry and raspberry, this vintage embodies the essence of fine winemaking. Perfect for intimate dinners and social gatherings.",
- "fr": "Découvrez l'attrait de notre Pinot Noir californien de 2007. Avec sa robe rubis captivante, sa texture veloutée et ses saveurs riches de cerise et de framboise, ce millésime incarne l'essence de l'art de la vinification. Parfait pour des dîners intimes et des rassemblements sociaux."
}, - "hasStock": true,
- "id": "70a516fc-abca-4a20-8587-ae403416cb26",
- "mainImage": {
- "height": 1920,
- "width": 1080
}, - "name": "2007 California Pinot Noir",
- "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 89.99,
- "salePrice": 69.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 9,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 7.78
}
}, - "reference": "5618787973",
- "storeOverrides": [
- {
- "hasStock": true,
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 119.99,
- "salePrice": 92.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 11.99,
- "measureUnit": "l",
- "measureValue": 1.29,
- "value": 10
}
}, - "store": "ca",
}
], - "title": {
- "*": "2007 California Pinot Noir",
- "fr": "Pinot Noir de Californie 2007"
}, - "variants": [
- {
- "hasStock": true,
- "id": "b353b793-2d76-4d15-87be-5e66ab62f4c4",
- "mainImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 49.99,
- "salePrice": 39.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 4.5,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 8.89
}
}, - "reference": "2762742728",
- "storeOverrides": [
- {
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 66.99,
- "salePrice": 52.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 5.99,
- "measureUnit": "l",
- "measureValue": 1.32,
- "value": 11.68
}
}, - "store": "ca"
}
], - "title": {
- "*": "2007 California Pinot Noir - 3 x 750ml",
- "fr": "Pinot Noir de Californie 2007 - 3 x 750ml"
}, - "variations": [
- {
- "type": "size",
- "value": {
- "*": "3 x 750ml"
}
}
]
}
]
}
}
]
}, - "chat": {
- "enabled": true
}
}, - "hosts": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "live": false,
- "options": {
- "addToCalendar": true,
- "backgroundColor": "transparent",
- "carouselReplay": true,
- "carouselReplayEvents": true,
- "chatReplay": true,
- "countdown": true,
- "hostAvatars": true,
- "language": "en",
- "share": true,
- "showDate": true,
- "videoOutput": [
- "portrait"
], - "videoProfile": "720p_2",
- "enableReplayAt": "2023-08-01T08:00:00.000Z"
}, - "preRecorded": false,
- "preview": {
- "enabled": true,
- "token": "e0abfb8c-fd55-4243-8c53-feca74fb877a"
}, - "promotion": [
- "alert"
], - "rtmpDestinations": [
- null
], - "streams": [
- {
- "id": "51e54b51-56ef-46a3-8623-c616d8a55de8",
- "end": "2023-01-19T18:00:00.000Z",
- "metrics": {
- "durationInMs": 2700000,
- "numberOfEmojis": 1811,
- "numberOfMessages": 802,
- "numberOfViewers": 3523
}, - "recordings": [
- {
- "id": "2c4f057e-8da3-4ac3-a10b-22af5826520c",
- "orientation": "portrait",
- "poster": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "startAt": 0,
- "subtitles": [
- {
- "language": "en",
}
], - "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}
], - "shortClips": [
- {
- "assets": {
- "medium": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}, - "small": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}, - "id": "75b890f0-58a3-4c2f-bec4-ec4c8505b405",
- "orientation": "portrait",
}
], - "start": "2023-01-19T18:45:00.000Z",
- "type": "live"
}
], - "title": {
- "*": "Must-buys you love"
}, - "views": {
- "preShow": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Must-buys you love"
}, - "teaser": {
- "*": "Join Lisa when she reveals new drops you will absolutely love!"
}, - "options": {
- "backgroundColor": "#e1498c"
}
}, - "replay": {
- "assets": {
- "coverPortrait": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "title": {
- "*": "Watch the replay"
}, - "teaser": {
- "*": "Watch Lisa as she revealed new drops you do not want to miss out on!"
}, - "options": {
- "backgroundColor": "#c35fc9"
}
}
}
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to retrieve the number of shows available.
You can apply various filters to customize your search for shows.
category | string (FilterCategoryParameter) non-empty Example: category=women The Specified values are considered a full match when executing the query. |
channel | string <^[a-z0-9]+(-[a-z0-9]+)*$> (FilterChannelParameter) non-empty Example: channel=my-slug The distinct channel slug to filter records by. |
conducted | string (FilterShowConductedParameter) Enum: "0" "1" "false" "no" "true" "yes" Filter shows by their Accepted values for
|
creator | string (FilterCreatorParameter) non-empty Example: creator=jane.doe The Specified values are considered a full match when executing the query. |
date | string (FilterShowDateParameter) Filter shows by their scheduled date. The
The first value represents the lower threshold, and the second one is the upper threshold. At least one of these values must be specified. Accepted formats:
To filter records within a specific date range, use the
Note: If only one date value is provided, it will be treated as either the lower or upper threshold, depending on its position in the parameter. |
live | string (FilterShowLiveParameter) Enum: "0" "1" "false" "no" "true" "yes" Filter shows by their Accepted values for
|
modified_since | string (FilterShowModifiedSinceParameter) Filter shows by their date of last modification. Only shows that have been modified after the provided date will be included in the response. The
Accepted formats:
|
status | string (FilterShowStatusParameter) Enum: "archived" "draft" "ready" Filter shows by their status. Allowed values:
Multiple values can be provided as a comma-separated list. |
tag | string (FilterTagParameter) non-empty Example: tag=casual The Specified values are considered a full match when executing the query. |
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}
This API endpoint allows you to retrieve information about snippets.
You can apply various filters and sorting options to customize your search for snippets.
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
limit | number <int32> (ScrollingLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
modified_since | string (FilterSnippetModifiedSinceParameter) Filter snippets by their date of last modification. Only snippets that have been modified after the provided date will be included in the response. The
Accepted formats:
|
sort | string (ScrollingSortParameter) Example: sort=date%3Adesc%2Cname%3Aasc The sort order of the items to return. It accepts a URL-encoded series of key-value pairs, with key being the desired field to sort by and value being the desired order (either |
product_reference | string (FilterProductReferenceParameter) non-empty Example: product_reference=abc The product reference(s) to filter records by. This can be either a single product reference or a comma-separated list of product references. Specified values are considered a full match when executing the query. Attention! This parameter expects the specification of a product reference ID. This is the unique ID from the customer's e-commerce system. Not to be confused with the LiSA-internal product ID. Since product reference IDs may contain special characters, please make sure to specify product reference values in URL encoded form. |
show_id | string <uuid> (FilterShowIdParameter) Example: show_id=3203d9eb-e87b-49cc-9090-90d0db301a8e The distinct show identifier to filter records by. Please specify the entire show UUID v4 show identifier. |
{- "items": [
- {
- "id": "GxPIPeFP7c",
- "endTimeInMs": 300000,
- "language": "en",
- "lastModifiedAt": "2021-06-23T10:15:00.000Z",
- "name": "Show 0c190189: [7db6a8de, 4985384d]",
- "productReferences": [
- "7db6a8de",
- "4985384d"
], - "previewImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "width": 1080
}, - "showId": "0c190189-7b7f-4f9d-92ad-32d8dfda16ac",
- "snippetIdeaId": "f0e5c1b9-0a78-4e9e-bf8d-8b6e9a2e3c70",
- "startTimeInMs": 415000,
- "video": {
- "durationInMs": 115000,
- "height": 1920,
- "width": 1080
}, - "videoFallback": {
- "durationInMs": 115000,
- "height": 1920,
- "width": 1080
}
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to retrieve the number of snippets available.
You can apply various filters to customize your search for snippets.
modified_since | string (FilterSnippetModifiedSinceParameter) Filter snippets by their date of last modification. Only snippets that have been modified after the provided date will be included in the response. The
Accepted formats:
|
product_reference | string (FilterProductReferenceParameter) non-empty Example: product_reference=abc The product reference(s) to filter records by. This can be either a single product reference or a comma-separated list of product references. Specified values are considered a full match when executing the query. Attention! This parameter expects the specification of a product reference ID. This is the unique ID from the customer's e-commerce system. Not to be confused with the LiSA-internal product ID. Since product reference IDs may contain special characters, please make sure to specify product reference values in URL encoded form. |
show_id | string <uuid> (FilterShowIdParameter) Example: show_id=3203d9eb-e87b-49cc-9090-90d0db301a8e The distinct show identifier to filter records by. Please specify the entire show UUID v4 show identifier. |
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}
This API endpoint allows you to retrieve detailed information about a single sticker resource based on its unique identifier (resourceId
).
You can access specific show details, including sticker description, date of publication, media assets, and any other relevant information associated with the sticker.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "id": "d4a7c0f5-1b9f-4d3c-8a3c-9b6b0f9d2e8b",
- "name": "Easter Egg Voucher",
- "actionBehavior": "modal",
- "actionTarget": {
- "*": "EASTER15"
}, - "activation": {
- "badgeSubtitle": {
- "*": "Coming soon, keep watching!"
}, - "badgeSubtitleIdle": {
- "*": "Voucher dropping any time!"
}, - "cardText": {
- "*": "A surprise is almost here! We'd love for you to stay and share it."
}, - "cardTitle": {
- "*": "Just a moment!"
}, - "durationInSec": 120,
- "effectOnExpiry": "confetti",
- "isEnabled": true,
- "isExpired": false,
- "startedAt": "2021-06-23T10:15:00Z"
}, - "assets": {
- "badgeThumbnail": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "expiry": {
- "badgeSubtitle": {
- "*": "Coming soon, keep watching!"
}, - "badgeSubtitleIdle": {
- "*": "Voucher dropping any time!"
}, - "cardText": {
- "*": "A surprise is almost here! We'd love for you to stay and share it."
}, - "cardTitle": {
- "*": "Just a moment!"
}, - "durationInSec": 120,
- "effectOnExpiry": "confetti",
- "isEnabled": true,
- "isExpired": false,
- "startedAt": "2021-06-23T10:15:00Z"
}, - "badgeSubtitle": {
- "*": "Drop at any time!"
}, - "badgeTitle": {
- "*": "Easter Egg"
}, - "cardDisclaimer": {
- "*": "Copy this voucher code and use it by 8pm tonight to get 15 % off any product that is shared during this livestream today."
}, - "cardText": {
- "*": "Claim your voucher and add it to your cart."
}, - "cardTitle": {
- "*": "Easter Egg: Voucher for 15 % off"
}, - "mediaItemId": "3f7c8f1c-1a7e-4b8f-9c1b-1c6e7e8f9a0b",
- "mediaItemType": "live",
- "isEnabled": true,
- "isPublished": true,
- "publishedAt": "2021-06-23T10:15:00Z",
- "stickerDetails": {
- "ctaBehavior": "addToCart",
- "voucherCode": "EASTER15",
- "voucherDiscountLabel": {
- "*": "15%"
}, - "voucherDiscountType": "percentage",
- "voucherDiscountValue": 15,
- "voucherExpiresAt": "2025-04-01T00:00:00.000Z"
}, - "stickerType": "voucher"
}
Updates selected fields for the target sticker resource.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
isActivationTimerEnabled | boolean Set
|
isPublished | boolean The published state of the sticker. Set value to |
{- "isPublished": true
}
{- "id": "d4a7c0f5-1b9f-4d3c-8a3c-9b6b0f9d2e8b",
- "clientIdentity": {
- "client": "lisa"
}, - "meta": {
- "createdAt": "2021-06-23T10:15:00.000Z",
- "createdBy": {
- "id": "44325844-7bac-42e6-b58f-0674d3fb714d",
- "username": "lisa"
}, - "modifiedAt": "2021-06-23T10:15:00.000Z",
- "modifiedBy": {
- "id": "44325844-7bac-42e6-b58f-0674d3fb714d",
- "username": "lisa"
}
}, - "name": "Easter Egg Voucher",
- "status": "ready",
- "actionBehavior": "modal",
- "actionTarget": {
- "*": "EASTER15"
}, - "activation": {
- "badgeSubtitle": {
- "*": "Coming soon, keep watching!"
}, - "badgeSubtitleIdle": {
- "*": "Voucher dropping any time!"
}, - "cardText": {
- "*": "A surprise is almost here! We'd love for you to stay and share it."
}, - "cardTitle": {
- "*": "Just a moment!"
}, - "durationInSec": 120,
- "effectOnExpiry": "confetti",
- "isEnabled": true,
- "isExpired": false,
- "startedAt": "2021-06-23T10:15:00Z"
}, - "assets": {
- "badgeThumbnail": {
- "id": "429cdc90-1ec6-4eb8-ac3e-f7a35ba4e5ae",
- "sizeInBytes": 1234567,
- "type": "image"
}
}, - "expiry": {
- "badgeSubtitle": {
- "*": "Coming soon, keep watching!"
}, - "badgeSubtitleIdle": {
- "*": "Voucher dropping any time!"
}, - "cardText": {
- "*": "A surprise is almost here! We'd love for you to stay and share it."
}, - "cardTitle": {
- "*": "Just a moment!"
}, - "durationInSec": 120,
- "effectOnExpiry": "confetti",
- "isEnabled": true,
- "isExpired": false,
- "startedAt": "2021-06-23T10:15:00Z"
}, - "badgeSubtitle": {
- "*": "Drop at any time!"
}, - "badgeTitle": {
- "*": "Easter Egg"
}, - "cardDisclaimer": {
- "*": "Copy this voucher code and use it by 8pm tonight to get 15 % off any product that is shared during this livestream today."
}, - "cardText": {
- "*": "Claim your voucher and add it to your cart."
}, - "cardTitle": {
- "*": "Easter Egg: Voucher for 15 % off"
}, - "mediaItemId": "3f7c8f1c-1a7e-4b8f-9c1b-1c6e7e8f9a0b",
- "mediaItemType": "live",
- "isEnabled": true,
- "isLocked": true,
- "isPublished": true,
- "publishedAt": "2021-06-23T10:15:00Z",
- "stickerDetails": {
- "ctaBehavior": "addToCart",
- "voucherCode": "EASTER15",
- "voucherDiscountLabel": {
- "*": "15%"
}, - "voucherDiscountType": "percentage",
- "voucherDiscountValue": 15,
- "voucherExpiresAt": "2025-04-01T00:00:00.000Z"
}, - "stickerType": "voucher"
}
This API endpoint allows you to retrieve information about stickers.
You can apply various filters and sorting options to customize your search for stickers.
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
limit | number <int32> (ScrollingLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
media_item_id | string (FilterStickerMediaItemidParameter) Filter stickers by their associated media item ID(s). Only stickers that are associated with the provided media item ID(s) will be included in the response. |
modified_since | string (FilterStickerModifiedSinceParameter) Filter stickers by their date of last modification. Only stickers that have been modified after the provided date will be included in the response. The
Accepted formats:
|
{- "items": [
- {
- "id": "d4a7c0f5-1b9f-4d3c-8a3c-9b6b0f9d2e8b",
- "name": "Easter Egg Voucher",
- "actionBehavior": "modal",
- "actionTarget": {
- "*": "EASTER15"
}, - "activation": {
- "badgeSubtitle": {
- "*": "Coming soon, keep watching!"
}, - "badgeSubtitleIdle": {
- "*": "Voucher dropping any time!"
}, - "cardText": {
- "*": "A surprise is almost here! We'd love for you to stay and share it."
}, - "cardTitle": {
- "*": "Just a moment!"
}, - "durationInSec": 120,
- "effectOnExpiry": "confetti",
- "isEnabled": true,
- "isExpired": false,
- "startedAt": "2021-06-23T10:15:00Z"
}, - "assets": {
- "badgeThumbnail": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}
}, - "expiry": {
- "badgeSubtitle": {
- "*": "Coming soon, keep watching!"
}, - "badgeSubtitleIdle": {
- "*": "Voucher dropping any time!"
}, - "cardText": {
- "*": "A surprise is almost here! We'd love for you to stay and share it."
}, - "cardTitle": {
- "*": "Just a moment!"
}, - "durationInSec": 120,
- "effectOnExpiry": "confetti",
- "isEnabled": true,
- "isExpired": false,
- "startedAt": "2021-06-23T10:15:00Z"
}, - "badgeSubtitle": {
- "*": "Drop at any time!"
}, - "badgeTitle": {
- "*": "Easter Egg"
}, - "cardDisclaimer": {
- "*": "Copy this voucher code and use it by 8pm tonight to get 15 % off any product that is shared during this livestream today."
}, - "cardText": {
- "*": "Claim your voucher and add it to your cart."
}, - "cardTitle": {
- "*": "Easter Egg: Voucher for 15 % off"
}, - "mediaItemId": "3f7c8f1c-1a7e-4b8f-9c1b-1c6e7e8f9a0b",
- "mediaItemType": "live",
- "isEnabled": true,
- "isPublished": true,
- "publishedAt": "2021-06-23T10:15:00Z",
- "stickerDetails": {
- "ctaBehavior": "addToCart",
- "voucherCode": "EASTER15",
- "voucherDiscountLabel": {
- "*": "15%"
}, - "voucherDiscountType": "percentage",
- "voucherDiscountValue": 15,
- "voucherExpiresAt": "2025-04-01T00:00:00.000Z"
}, - "stickerType": "voucher"
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to count stickers.
You can apply various filters to customize your search for stickers.
media_item_id | string (FilterStickerMediaItemidParameter) Filter stickers by their associated media item ID(s). Only stickers that are associated with the provided media item ID(s) will be included in the response. |
modified_since | string (FilterStickerModifiedSinceParameter) Filter stickers by their date of last modification. Only stickers that have been modified after the provided date will be included in the response. The
Accepted formats:
|
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}
This API endpoint allows you to retrieve detailed information about a single story resource based on its unique identifier (resourceId
).
You can access specific show details, including story description, date of publication, media assets, and any other relevant information associated with the story.
resourceId required | string <uuid> (ResourceIdParameter) Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e The universally unique resource identifier. |
{- "creator": {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}, - "description": {
- "*": "Zoé shows you how to dress in style this summer."
}, - "durationInMs": 15000,
- "id": "d5f2f6d9-afeb-4ef3-9339-48fe61a2b5f1",
- "image": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "isPublished": true,
- "isOnline": true,
- "name": "Summer is here!",
- "products": [
- {
- "brand": {
- "*": "Just an Ordinary Winery"
}, - "description": {
- "*": "Experience the allure of our 2007 California Pinot Noir. With a captivating ruby hue, velvety texture, and rich flavors of cherry and raspberry, this vintage embodies the essence of fine winemaking. Perfect for intimate dinners and social gatherings.",
- "fr": "Découvrez l'attrait de notre Pinot Noir californien de 2007. Avec sa robe rubis captivante, sa texture veloutée et ses saveurs riches de cerise et de framboise, ce millésime incarne l'essence de l'art de la vinification. Parfait pour des dîners intimes et des rassemblements sociaux."
}, - "hasStock": true,
- "id": "70a516fc-abca-4a20-8587-ae403416cb26",
- "mainImage": {
- "height": 1920,
- "width": 1080
}, - "name": "2007 California Pinot Noir",
- "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 89.99,
- "salePrice": 69.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 9,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 7.78
}
}, - "reference": "5618787973",
- "storeOverrides": [
- {
- "hasStock": true,
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 119.99,
- "salePrice": 92.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 11.99,
- "measureUnit": "l",
- "measureValue": 1.29,
- "value": 10
}
}, - "store": "ca",
}
], - "title": {
- "*": "2007 California Pinot Noir",
- "fr": "Pinot Noir de Californie 2007"
}, - "variants": [
- {
- "hasStock": true,
- "id": "b353b793-2d76-4d15-87be-5e66ab62f4c4",
- "mainImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 49.99,
- "salePrice": 39.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 4.5,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 8.89
}
}, - "reference": "2762742728",
- "storeOverrides": [
- {
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 66.99,
- "salePrice": 52.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 5.99,
- "measureUnit": "l",
- "measureValue": 1.32,
- "value": 11.68
}
}, - "store": "ca"
}
], - "title": {
- "*": "2007 California Pinot Noir - 3 x 750ml",
- "fr": "Pinot Noir de Californie 2007 - 3 x 750ml"
}, - "variations": [
- {
- "type": "size",
- "value": {
- "*": "3 x 750ml"
}
}
]
}
]
}
], - "title": {
- "*": "Summer is here!"
}, - "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}
This API endpoint enables you to access a collection of story badges.
A story badge represents a compilation of individual stories, organized based on criteria such as the creators of the stories or the channels they belong to.
channel | string <^[a-z0-9]+(-[a-z0-9]+)*$> (FilterChannelParameter) non-empty Example: channel=my-slug The distinct channel slug to filter records by. |
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
group_by required | string (BadgeSourceTypeParameter) Enum: "category" "channel" "creator" Example: group_by=creator Indicator, how badge items should be grouped. |
limit | number <int32> (ScrollingLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
{- "items": [
- {
- "displayName": "Jon Doe",
- "isLive": false,
- "items": [
- {
- "id": "d5f2f6d9-afeb-4ef3-9339-48fe61a2b5f1",
- "creators": [
- {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}
], - "durationInMs": 15000,
- "hasStickers": true,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "image": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "width": 1080
}, - "publishedAt": "2021-06-23T10:15:00.000Z",
- "title": {
- "*": "Summer is here!"
}, - "type": "story",
- "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "width": 1080
}
}
], - "sourceId": "11707567-24de-4acd-8bc4-a9015d2b8b7c",
- "sourceType": "creator"
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to retrieve information about stories.
You can apply various filters and sorting options to customize your search for stories.
channel | string <^[a-z0-9]+(-[a-z0-9]+)*$> (FilterChannelParameter) non-empty Example: channel=my-slug The distinct channel slug to filter records by. |
cursor | string (ScrollingCursorParameter) Example: cursor=eyJsaW1pdCI6MTAsInBhZ2UiOjJ9 The cursor to fetch the next batch of items in a consecutive item list request |
limit | number <int32> (ScrollingLimitParameter) >= 1 Example: limit=20 The number of items to return. The maximum allowed value is |
{- "items": [
- {
- "creator": {
- "displayName": "Jon Doe",
- "id": "5d3c8bd0-85da-493f-b531-91107ad110ac",
- "username": "john.doe",
- "traits": [
- {
- "key": "originUserId",
- "value": "8233892327"
}
]
}, - "description": {
- "*": "Zoé shows you how to dress in style this summer."
}, - "durationInMs": 15000,
- "id": "d5f2f6d9-afeb-4ef3-9339-48fe61a2b5f1",
- "image": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "isPublished": true,
- "isOnline": true,
- "name": "Summer is here!",
- "products": [
- {
- "brand": {
- "*": "Just an Ordinary Winery"
}, - "description": {
- "*": "Experience the allure of our 2007 California Pinot Noir. With a captivating ruby hue, velvety texture, and rich flavors of cherry and raspberry, this vintage embodies the essence of fine winemaking. Perfect for intimate dinners and social gatherings.",
- "fr": "Découvrez l'attrait de notre Pinot Noir californien de 2007. Avec sa robe rubis captivante, sa texture veloutée et ses saveurs riches de cerise et de framboise, ce millésime incarne l'essence de l'art de la vinification. Parfait pour des dîners intimes et des rassemblements sociaux."
}, - "hasStock": true,
- "id": "70a516fc-abca-4a20-8587-ae403416cb26",
- "mainImage": {
- "height": 1920,
- "width": 1080
}, - "name": "2007 California Pinot Noir",
- "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 89.99,
- "salePrice": 69.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 9,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 7.78
}
}, - "reference": "5618787973",
- "storeOverrides": [
- {
- "hasStock": true,
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 119.99,
- "salePrice": 92.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 11.99,
- "measureUnit": "l",
- "measureValue": 1.29,
- "value": 10
}
}, - "store": "ca",
}
], - "title": {
- "*": "2007 California Pinot Noir",
- "fr": "Pinot Noir de Californie 2007"
}, - "variants": [
- {
- "hasStock": true,
- "id": "b353b793-2d76-4d15-87be-5e66ab62f4c4",
- "mainImage": {
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 1234567,
- "width": 1080
}, - "price": {
- "currencyCode": "USD",
- "currencySymbol": "$",
- "price": 49.99,
- "salePrice": 39.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 4.5,
- "measureUnit": "l",
- "measureValue": 1,
- "value": 8.89
}
}, - "reference": "2762742728",
- "storeOverrides": [
- {
- "price": {
- "currencyCode": "CAD",
- "currencySymbol": "$",
- "price": 66.99,
- "salePrice": 52.99,
- "unitPrice": {
- "baseUnit": "l",
- "baseValue": 5.99,
- "measureUnit": "l",
- "measureValue": 1.32,
- "value": 11.68
}
}, - "store": "ca"
}
], - "title": {
- "*": "2007 California Pinot Noir - 3 x 750ml",
- "fr": "Pinot Noir de Californie 2007 - 3 x 750ml"
}, - "variations": [
- {
- "type": "size",
- "value": {
- "*": "3 x 750ml"
}
}
]
}
]
}
], - "title": {
- "*": "Summer is here!"
}, - "video": {
- "durationInMs": 15000,
- "hash": "UjKJcTXE%i%M~9bxK7tdjes;5Rb[-3wIX9O,",
- "height": 1920,
- "sizeInBytes": 123456789,
- "width": 1080
}
}
], - "scrolling": {
- "cursor": "eyJsaW1pdCI6MTAsInBhZ2UiOjJ9",
- "limit": 25,
- "numItemsTotal": 81
}
}
This API endpoint allows you to retrieve the number of stories available.
You can apply various filters to customize your search for stories.
channel | string <^[a-z0-9]+(-[a-z0-9]+)*$> (FilterChannelParameter) non-empty Example: channel=my-slug The distinct channel slug to filter records by. |
{- "code": "Http:BadRequest",
- "message": "Username is taken already.",
- "statusCode": 400,
- "issues": [
- {
- "code": "custom",
- "message": "Username is taken already.",
- "path": [
- "username"
]
}
]
}