API Reference

Ranking Report

post
https://api.luminatedata.com/svm/reports/ranking

Retrieves a list of most-watched titles within custom parameters.

Body Params

Ranking report request body

int32
required
1 to 200

The number of titles to return

string
enum
required

Type of video content, either ‘movie' or 'tv_show'

Allowed:
date
required

First date used in the aggregation of the consumption data. Value must be formatted according to the ISO 8601 date standard (YYYY-MM-DD).

date
required

Last date used in the aggregation of the consumption data. Value must be formatted according to the ISO 8601 date standard (YYYY-MM-DD).

genres
array of strings or null | null

Optional list of genres to filter results by. If not provided, all genres are included. Valid values: "action & adventure", "animation", "comedy", "crime", "documentary", "drama", "family", "fantasy", "horror", "kids", "musical", "mystery", "romance", "science fiction", "thriller", "western".

genres
platforms
array of strings

Filter results by one or more platforms. If not provided, all platforms are included. Valid values: "AMC+", "Apple TV", "Discovery+", "Disney+", "HBO Max", "Hulu", "Netflix", "Paramount+", "Peacock", "Prime Video", "Tubi".

platforms
string
enum
Defaults to minutes_watched

Metric to rank results by. Default is 'minutes_watched', alternative is 'views'.

Allowed:
string | null
enum
Defaults to season

Optional field to distinguish between TV shows and series. 'season' is default.

Allowed:
source
array of strings or null | null

Optional list to filter results by content source. If not provided, both original and non-original content are included. Valid values: "original", "non-original".

source
Responses

Updated 21 days ago

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

Updated 21 days ago