Screensaver List

watch.content.screensaver.list

Returns the screensaver artwork to display while the app is idle, ordered by the sequence it should be shown in.

Headers

Header	Value
Authorization	JWT token
ClientID	platform-\<id>-app_version-\<id>

The ClientID header is required. It must have four hyphen-separated components, and the first component must be one of web, roku, firestick, fireos, appletv, ipad, tizen.

Endpoint

GET v2/watch/content/screensavers

Query Parameters

Parameter	Type	Required	Description
`page`	Integer	Optional	Page number of the results. The default value is 1.
`limit`	Integer	Optional	Number of results per page. The default value is 20 and the maximum allowed value is 50.

Response Body

    {
        "count": 8,
        "previous": null,
        "next": null,
        "results": [
            {
                "sequence": 1,
                "background_url": "https://media.indee.tv/screensaver/bg-1.jpg?Expires=...&Signature=...&Key-Pair-Id=...",
                "foreground_url": "https://media.indee.tv/screensaver/fg-1.png?Expires=...&Signature=...&Key-Pair-Id=..."
            }
        ],
        "status_code": "W0000",
        "status_message": "Success"
    }

Field	Type	Description
`count`	Integer	The total count of results without pagination.
`previous`	String	Link to the previous set of results.
`next`	String	Link to the next set of results.
`results`	JSON	The screensaver assets.
`results[].sequence`	Integer	The order in which the asset should be shown.
`results[].background_url`	String	Link to the background image.
`results[].foreground_url`	String	Link to the foreground image, overlaid on the background.
`status_code`	String	The Indee status code for the response.
`status_message`	String	Human readable message describing the response.

Assets configured for the viewer's own audience are returned when present; otherwise the watch product's default screensavers are returned.

Status Codes

Indee status code	HTTP Response Code	Description
W0000	HTTP 200	Success
W0001	HTTP 200	No content
W2000	HTTP 401	Authorization header was either not passed or there was some issue parsing it
W2003	HTTP 401	Invalid auth token
W2009	HTTP 401	ClientID header was either not passed or is malformed
W2101	HTTP 403	API key not authorized to perform this action
W2102	HTTP 451	Request blocked by geofencing for the resolved region
W5001	HTTP 429	Rate limited
W5000	HTTP 500	Unknown server error occurred