Sign in
V3 > Statistics

Viewers and encodings histogram.

Retrieve histogram with general statistics per time bucket, along with breakdown per encoding.

get/2/vod/statistics/{subject}/histogram/encodings

Path parameters

subjectstring required

The Sequence 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
perstring nullable

<note><strong>hour</strong>: Interval of time lasting 60 minutes</note><note><strong>day</strong>: Interval of time lasting 24 hours</note><note><strong>week</strong>: Interval of time lasting 7 days</note><note><strong>month</strong>: Interval of time approximately lasting 30 days</note><note><strong>quarter</strong>: Interval of time lasting approximately 3 months</note><note><strong>year</strong>: Interval of time lasting 12 months</note>

Example:hour
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": {
    "histogram": [
      {
        "key": 1769677200,
        "viewers": 200,
        "unique_viewers": 10,
        "consumption": 1000,
        "viewing_time": 60,
        "encodings": [
          {
            "encoding": "1jhvl2upzafkt",
            "viewers": 200,
            "unique_viewers": 10,
            "consumption": 1000,
            "viewing_time": 60
          }
        ]
      }
    ],
    "encodings_map": [
      {
        "id": "1jhvl2upzafkt",
        "name": "Video optimized for playback"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.