v13

latestOpenAPI 3.0.0raw.githubusercontent.com2023-04-201625158.8 KB
Reports

Get Usage Report

'This report returns a breakdown of video on demand minute usage by day and grouping. It will contain two top-level keys: total and statistics. total will contain the sum of all statistics returned in the report. statistics will contain an entry for each day and grouping. If you do not use the report grouping feature of the API the report will contain only one entry per day. These statistics are collected about once per hour, but there is only one record per day (per grouping). By default this report excludes the current day from the response because it is only partially complete. It is important to note that our service operates in the UTC time zone (including billing periods). All dates and times reported will be in UTC.'

get/reports/vod

Query parameters

fromstring

Start date in the format YYYY-MM-DD (default: 30 days ago)

tostring

End date in the format YYYY-MM-DD (default: today)

groupingstring

A grouping name set in the Create Job operation

Headers

Content-Typestring required

Content-Type: application/json

Zencoder-Api-Keystring required

Your API key

Response

Get account details response.

Example response

{
  "total": {
    "encoded_minutes": 6,
    "billable_minutes": 8
  },
  "statistics": [
    {
      "grouping": "myGroup",
      "collected_on": "2017-03-10",
      "encoded_minutes": 4,
      "billable_minutes": 5
    },
    {
      "grouping": null,
      "collected_on": "2017-03-10",
      "encoded_minutes": 2,
      "billable_minutes": 3
    }
  ]
}