Sign in
V3 > Statistics

Retention per percent.

Get retention per percent for the provided media, if anything else is provided, a 404 error will be raised. The returned collection contains a list of percents [0-99], each percent contains a hit count and a normalized value.

get/2/vod/statistics/{media}/retention

Path parameters

mediastring required

The Media unique identifier

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.

Response

OK

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

Result of the HTTP request

Example response

{
  "result": "success",
  "data": [
    {
      "segment_percent": 99,
      "hits_count": 12345.6,
      "normalized_value": 99.9
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.