LiSA Social Commerce Customer API (v1.32.1)

Download OpenAPI specification:

Webhooks

Notification Webhook

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.

Create a subscription

Navigate to the Developer page within the LiSA dashboard to configure webhooks for either your Sandbox or Production environment.

Receiving and responding to webhook notifications.

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 — OK
  • 202 — Accepted
  • 204 — No content

If 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.

Test your endpoint

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.

Event types

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.

Schema

Request Body schema: application/json
Any of
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.

Responses

Request samples

Content type
application/json
{}

Find a webhook event

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{}

Find a webhook subscription

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{}

Delete a webhook subscription

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:Unauthorized",
  • "message": "You are not authorized to access the target resource.",
  • "statusCode": 401
}

Find webhook subscriptions

This API endpoint allows you to retrieve information about your webhook subscriptions.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{}

Create a webhook subscription

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.

Authorizations:
ApiKey
Request Body schema: application/json

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:

  • * — Subscribe to all events of all collections.
  • Show:* — Subscribe to all show collection events.
  • Snippet:* — Subscribe to all snippet collection events.
  • Story:* — Subscribe to all story collection events.
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 (basic)

HTTP basic authentication requires clientId (username) and clientSecret (password) to be specified.

Bearer authentication (bearer)

Bearer authentication requires clientSecret (token) to be specified.

No authentication (none)

No authentication required. The endpoint is publicly accessible.

OAuth Client Credentials Flow (oauth)

OAuth2 Client Credentials Flow requires clientId, clientSecret and authUrl to be specified.

webhookUrl
string <url>

The webhook target URL to call upon subscribed events being emitted.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "04a99ca3-00a7-463c-ad44-234e04dca3e0",
  • "client": "lisa",
  • "eventTypes": [
    ],
  • "status": "active",
}

Channels

Delete a channel

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.

Authorizations:
ApiKey
path Parameters
required
Slug (string) or Uuid (string) (ResourceIdOrSlugParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier or slug.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:Unauthorized",
  • "message": "You are not authorized to access the target resource.",
  • "statusCode": 401
}

Find a channel

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.

Authorizations:
ApiKey
path Parameters
required
Slug (string) or Uuid (string) (ResourceIdOrSlugParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier or slug.

Responses

Response samples

Content type
application/json
{}

Update a channel

Updates selected fields for the target channel resource.

Authorizations:
ApiKey
path Parameters
required
Slug (string) or Uuid (string) (ResourceIdOrSlugParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier or slug.

Request Body schema: application/json
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.

  • Key is either a lower-cased language code identifier (LCID Locale ID, e.g. en-us) or *, which acts as a fallback, if no language specific value is specified.
  • Value is a text in a distinct language.

Set value to null to empty the field.

url
string <url>

A URL of a merchants site, where all video content of the channel is accessible.

Set value to null to empty the field.

Responses

Request samples

Content type
application/json
{
  • "name": "Fashion"
}

Response samples

Content type
application/json
{
  • "id": "668d5293-bf80-44d0-907d-20a2d8543fbf",
  • "clientIdentity": {
    },
  • "meta": {
    },
  • "name": "Fashion",
  • "status": "ready",
  • "assets": {},
  • "description": {
    },
  • "highlightedShows": [
    ],
  • "hosts": [
    ],
  • "slug": "fashion",
  • "title": {
    },
  • "useOrOperator": true
}

Create a channel

Create a new channel.

Authorizations:
ApiKey
Request Body schema: application/json
required
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 slug will automatically get created from the channel's name property.

object

The title of the channel.

A map of key-value pairs for multi-lingual texts.

  • Key is either a lower-cased language code identifier (LCID Locale ID, e.g. en-us) or *, which acts as a fallback, if no language specific value is specified.
  • Value is a text in a distinct language.
url
string <url>

The URL where all video content of the channel is accessible.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "668d5293-bf80-44d0-907d-20a2d8543fbf",
  • "clientIdentity": {
    },
  • "meta": {
    },
  • "name": "Fashion",
  • "status": "ready",
  • "assets": {},
  • "description": {
    },
  • "highlightedShows": [
    ],
  • "hosts": [
    ],
  • "slug": "fashion",
  • "title": {
    },
  • "useOrOperator": true
}

Find channels

This API endpoint allows you to retrieve information about channels.

You can apply various filters and sorting options to customize your search for channels.

Authorizations:
ApiKey
query Parameters
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 50.

status
string (FilterChannelStatusParameter)
Enum: "archived" "draft" "processing" "ready"
Example: status=draft

The status to filter resources by.

If omitted, all non-archived items are returned.

Responses

Response samples

Content type
application/json
{}

Count channels

This API endpoint allows you to count channels.

You can apply various filters to customize your search for channels.

Authorizations:
ApiKey
query Parameters
status
string (FilterChannelStatusParameter)
Enum: "archived" "draft" "processing" "ready"
Example: status=draft

The status to filter resources by.

If omitted, all non-archived items are returned.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}

Products

Find product references

This API endpoint allows you to retrieve product references of all products that are synchronized between LiSA your e-commerce system.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Short clips

Find a short clip

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{}

Find short clips

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.

Authorizations:
ApiKey
query Parameters
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 50.

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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00
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 asc or desc). Key and value must be separated by colon (: / %3A), multiple key-value pairs must be separated by comma (, / %2C).

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 show_id parameter allows you to specify a short-clip's show identifier for filtering records. You can provide either a single show identifier, or multiple separated by a comma.

Specified values are considered a full match when executing the query.

Responses

Response samples

Content type
application/json
{}

Count short clips

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.

Authorizations:
ApiKey
query Parameters
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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00
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 show_id parameter allows you to specify a short-clip's show identifier for filtering records. You can provide either a single show identifier, or multiple separated by a comma.

Specified values are considered a full match when executing the query.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}

Shows

Find RTMP stream keys

This API endpoint allows you to retrieve RTMP stream keys associated with a distinct show

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Count RTMP stream keys

This API endpoint allows you to retrieve the number of RTMP stream keys associated with a show.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}

Find a show

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{}

Find shows

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.

Authorizations:
ApiKey
query Parameters
category
string (FilterCategoryParameter) non-empty
Example: category=women

The category parameter allows you to specify a category slug for filtering records. You can provide either a single category slug, or multiple category slugs separated by a comma.

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 conducted state.

Accepted values for

  • true1, true, yes
  • false0, false, no
creator
string (FilterCreatorParameter) non-empty
Example: creator=jane.doe

The creator parameter allows you to specify a creator's username for filtering records. You can provide either a single username, or multiple separated by a comma.

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 date parameter allows you to specify a date range for filtering records. You can provide two date values separated by a comma, where each value can be in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

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:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00

To filter records within a specific date range, use the date parameter as follows:

  • ?date=1619827200000 — Filters all records from the epoch timestamp 1619827200000
  • ?date=1619827200000,1630656000000 — Filters records from the epoch timestamp 1619827200000 to 1630656000000
  • ?date=,1630656000000 — Filters all records until the epoch timestamp 1630656000000

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 250.

live
string (FilterShowLiveParameter)
Enum: "0" "1" "false" "no" "true" "yes"

Filter shows by their live state.

Accepted values for

  • true1, true, yes
  • false0, false, no
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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00
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 asc or desc). Key and value must be separated by colon (: / %3A), multiple key-value pairs must be separated by comma (, / %2C).

status
string (FilterShowStatusParameter)
Enum: "archived" "draft" "ready"

Filter shows by their status.

Allowed values:

  • archived — Archived shows.
  • draft — Shows in draft mode.
  • ready — Published shows.

Multiple values can be provided as a comma-separated list.

tag
string (FilterTagParameter) non-empty
Example: tag=casual

The tag parameter allows you to specify a tag slug for filtering records. You can provide either a single tag slug, or multiple tag slugs separated by a comma.

Specified values are considered a full match when executing the query.

Responses

Response samples

Content type
application/json
{}

Count shows

This API endpoint allows you to retrieve the number of shows available.

You can apply various filters to customize your search for shows.

Authorizations:
ApiKey
query Parameters
category
string (FilterCategoryParameter) non-empty
Example: category=women

The category parameter allows you to specify a category slug for filtering records. You can provide either a single category slug, or multiple category slugs separated by a comma.

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 conducted state.

Accepted values for

  • true1, true, yes
  • false0, false, no
creator
string (FilterCreatorParameter) non-empty
Example: creator=jane.doe

The creator parameter allows you to specify a creator's username for filtering records. You can provide either a single username, or multiple separated by a comma.

Specified values are considered a full match when executing the query.

date
string (FilterShowDateParameter)

Filter shows by their scheduled date.

The date parameter allows you to specify a date range for filtering records. You can provide two date values separated by a comma, where each value can be in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

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:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00

To filter records within a specific date range, use the date parameter as follows:

  • ?date=1619827200000 — Filters all records from the epoch timestamp 1619827200000
  • ?date=1619827200000,1630656000000 — Filters records from the epoch timestamp 1619827200000 to 1630656000000
  • ?date=,1630656000000 — Filters all records until the epoch timestamp 1630656000000

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 live state.

Accepted values for

  • true1, true, yes
  • false0, false, no
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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00
status
string (FilterShowStatusParameter)
Enum: "archived" "draft" "ready"

Filter shows by their status.

Allowed values:

  • archived — Archived shows.
  • draft — Shows in draft mode.
  • ready — Published shows.

Multiple values can be provided as a comma-separated list.

tag
string (FilterTagParameter) non-empty
Example: tag=casual

The tag parameter allows you to specify a tag slug for filtering records. You can provide either a single tag slug, or multiple tag slugs separated by a comma.

Specified values are considered a full match when executing the query.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}

Snippets

Find snippets

This API endpoint allows you to retrieve information about snippets.

You can apply various filters and sorting options to customize your search for snippets.

Authorizations:
ApiKey
query Parameters
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 50.

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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00
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 asc or desc). Key and value must be separated by colon (: / %3A), multiple key-value pairs must be separated by comma (, / %2C).

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.

Responses

Response samples

Content type
application/json
{}

Count snippets

This API endpoint allows you to retrieve the number of snippets available.

You can apply various filters to customize your search for snippets.

Authorizations:
ApiKey
query Parameters
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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00
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.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}

Stickers

Find a sticker

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "d4a7c0f5-1b9f-4d3c-8a3c-9b6b0f9d2e8b",
  • "name": "Easter Egg Voucher",
  • "actionBehavior": "modal",
  • "actionTarget": {
    },
  • "activation": {
    },
  • "assets": {},
  • "expiry": {
    },
  • "badgeSubtitle": {
    },
  • "badgeTitle": {
    },
  • "cardDisclaimer": {
    },
  • "cardText": {
    },
  • "cardTitle": {
    },
  • "mediaItemId": "3f7c8f1c-1a7e-4b8f-9c1b-1c6e7e8f9a0b",
  • "mediaItemType": "live",
  • "isEnabled": true,
  • "isPublished": true,
  • "publishedAt": "2021-06-23T10:15:00Z",
  • "stickerDetails": {
    },
  • "stickerType": "voucher"
}

Update a sticker

Updates selected fields for the target sticker resource.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Request Body schema: application/json
isActivationTimerEnabled
boolean

Set isActivationTimerEnabled to true to start the activation timer of a sticker.

true is the only accepted value.

isPublished
boolean

The published state of the sticker.

Set value to true to publish a sticker. Set value to false to unpublish a sticker.

Responses

Request samples

Content type
application/json
{
  • "isPublished": true
}

Response samples

Content type
application/json
{
  • "id": "d4a7c0f5-1b9f-4d3c-8a3c-9b6b0f9d2e8b",
  • "clientIdentity": {
    },
  • "meta": {
    },
  • "name": "Easter Egg Voucher",
  • "status": "ready",
  • "actionBehavior": "modal",
  • "actionTarget": {
    },
  • "activation": {
    },
  • "assets": {},
  • "expiry": {
    },
  • "badgeSubtitle": {
    },
  • "badgeTitle": {
    },
  • "cardDisclaimer": {
    },
  • "cardText": {
    },
  • "cardTitle": {
    },
  • "mediaItemId": "3f7c8f1c-1a7e-4b8f-9c1b-1c6e7e8f9a0b",
  • "mediaItemType": "live",
  • "isEnabled": true,
  • "isLocked": true,
  • "isPublished": true,
  • "publishedAt": "2021-06-23T10:15:00Z",
  • "stickerDetails": {
    },
  • "stickerType": "voucher"
}

Find stickers

This API endpoint allows you to retrieve information about stickers.

You can apply various filters and sorting options to customize your search for stickers.

Authorizations:
ApiKey
query Parameters
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 50.

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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "scrolling": {
    }
}

Count stickers

This API endpoint allows you to count stickers.

You can apply various filters to customize your search for stickers.

Authorizations:
ApiKey
query Parameters
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 modified_since parameter allows you to specify a date for filtering records. You can provide a value in one of the following formats:

  • Epoch Timestamp: A 13-digit number representing milliseconds since January 1, 1970, UTC.
  • ISO 8601 Date String: A date and time representation in ISO 8601 format, optionally including fractional seconds and time zone information.

Accepted formats:

  • Epoch Timestamp: 1630656000000
  • ISO 8601 Date String: 2023-09-03 (interpreted as 00:00:00 UTC), 2023-09-03T12:34:56Z, 2023-09-03T12:34:56.123+02:00

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}

Stories

Find a story

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.

Authorizations:
ApiKey
path Parameters
resourceId
required
string <uuid> (ResourceIdParameter)
Example: 3203d9eb-e87b-49cc-9090-90d0db301a8e

The universally unique resource identifier.

Responses

Response samples

Content type
application/json
{}

Find badges

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.

Authorizations:
ApiKey
query Parameters
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 50.

Responses

Response samples

Content type
application/json
{}

Find stories

This API endpoint allows you to retrieve information about stories.

You can apply various filters and sorting options to customize your search for stories.

Authorizations:
ApiKey
query Parameters
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 50.

Responses

Response samples

Content type
application/json
{}

Count stories

This API endpoint allows you to retrieve the number of stories available.

You can apply various filters to customize your search for stories.

Authorizations:
ApiKey
query Parameters
channel
string <^[a-z0-9]+(-[a-z0-9]+)*$> (FilterChannelParameter) non-empty
Example: channel=my-slug

The distinct channel slug to filter records by.

Responses

Response samples

Content type
application/json
{
  • "code": "Http:BadRequest",
  • "message": "Username is taken already.",
  • "statusCode": 400,
  • "issues": [
    ]
}