Update 30 May 2018: This blog refers to API version 2, which has been succeeded by API version v3. We recommend that you use API version v3 as part of your video workflow. You can currently access account bandwidth usage in the VdoCipher Dashboard. Please let us know at support@vdocipher.com if you would like to check bandwidth usage using API v3.

We provide data on your video usage streaming in terms of the bandwidth used and the total storage billed for the day. These data are deducted from the plan you have purchased. Account usage is updated daily at 5 am UTC everyday. The data granularity is 1 day. So on 3rd Feb 2016 at 5am, usage data for the complete day of 2nd Feb 2016 will be avilable. Currently, we are not collecting hourly data for the usage.

We have added two APIs to allow you to monitor your streaming usage using simple HTTP requests and create business relevant decisions based on these data. These data can also be downloaded from your account page when you log in to your vdocipher account.

Note that high usage or going over your allotted quota of bandwidth or storage does not stop your videos being streamed. We continuously monitor your usage and let you know in advance of any suspiciously high usage in your account.

Daily account usage:

You can obtain usage reports for your account on a daily basis.

Request
URL: https://api.vdocipher.com/v2/usage
Query Param: ?startdate=YYYY-MM-DD&enddate=YYYY-MM-DD
Method: POST
PostData: clientSecretKey=API_SECRET_KEY

Response
Content-Type: application/json

[
{date: 'YYYY-MM-DD' , bandwidth: ''},
{date: 'YYYY-MM-DD' , bandwidth: ''},
....
]

API can only return data of upto 60 days at maximum starting at the start date. startdate and enddate provided are the inclusive boundaries i.e. data will include both these dates.

Video specific usage:

You can also query usage report for one specific video over a range of days.

Request
URL: https://api.vdocipher.com/v2/videousage
Query Param: ?startdate=YYYY-MM-DD&enddate=YYYY-MM-DD&video=xxxxxx
Method: POST
PostData: clientSecretKey=API_SECRET_KEY

Response
Content-type: application/json

[
{date: 'YYYY-MM-DD' , bandwidth: ''},
{date: 'YYYY-MM-DD' , bandwidth: ''},
....
]

API_SECRET_KEY can be obtained from your dashboard config.