Sign in
V3 > Statistics

Top media.

Get a list of media for the requested period, sorted by viewers count.

get/2/vod/statistics/{channel}/media/top

Path parameters

channelstring required

Query parameters

fromstring nullable

<note><strong>Date</strong>: any accepted <a href="https://www.php.net/manual/fr/datetime.formats.date.php" target="_blank">PHP date format</a></note> <note><strong>Timestamp</strong>: a Timestamp</note> <note><strong>Time interval</strong>: a positive or negative interval with pattern: <pre>/+|-\d+[YyMdhims]/</pre>

<table> <thead> <tr> <td>symbol</td> <td>description</td> </tr> </thead> <tbody> <tr> <td>Y|y</td> <td>Year</td> </tr> <tr> <td>M</td> <td>Month</td> </tr> <tr> <td>d</td> <td>Day</td> </tr> <tr> <td>h</td> <td>Hour</td> </tr> <tr> <td>i|m</td> <td>Minute</td> </tr> <tr> <td>s</td> <td>Second</td> </tr> </tbody> </table> </note>
Example:+10d
tostring nullable

<note><strong>Date</strong>: any accepted <a href="https://www.php.net/manual/fr/datetime.formats.date.php" target="_blank">PHP date format</a></note> <note><strong>Timestamp</strong>: a Timestamp</note> <note><strong>Time interval</strong>: a positive or negative interval with pattern: <pre>/+|-\d+[YyMdhims]/</pre>

<table> <thead> <tr> <td>symbol</td> <td>description</td> </tr> </thead> <tbody> <tr> <td>Y|y</td> <td>Year</td> </tr> <tr> <td>M</td> <td>Month</td> </tr> <tr> <td>d</td> <td>Day</td> </tr> <tr> <td>h</td> <td>Hour</td> </tr> <tr> <td>i|m</td> <td>Minute</td> </tr> <tr> <td>s</td> <td>Second</td> </tr> </tbody> </table> </note>
Example:+10d
topinteger nullable

Limit the response size to the top N results.

return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

Changed in 1 of the 15 revisions of this API.2

  • f11860e74a002See the full diff
    • ○

      for the path request parameter channel, the type was generalized from integer to string

      request-parameter-type-generalized

    • ○

      removed subschema #2 from the response body allOf list for the response status

      response-body-all-of-removed

    This revision also has 19 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog