Navigate

Kaltura API Documentationpartner.getUsage

This API action has been deprecated. If you’re building a new app integration, please consult the usage guides or forums for the more recent API actions to use.

Get usage statistics for a partner

Calculation is done according to partner's package

Additional data returned is a graph points of streaming usage in a time frame

The resolution can be "days" or "months"

Try it out
post https://www.kaltura.com/api_v3/service/partner/action/getUsage

Request Parameters

body:object
SchemaExample
object
month:integer
resolution:string
Enum: DAYS [days], HOURS [hours], MINUTES [minutes], MONTHS [months], TEN_MINUTES [ten_minutes], TEN_SECONDS [ten_seconds], YEARS [years]
year:integer

Response

Success

SchemaExample
object:KalturaPartnerUsage
Percent:number
readOnly


percent of usage out of partner's package. if usageGB is 5 and package is 10GB, this value will be 50


hostingGB:number
readOnly


Partner total hosting in GB on the disk


packageBW:integer
readOnly


package total BW - actually this is usage, which represents BW+storage


reachedLimitDate:integer
readOnly


date when partner reached the limit of his package (timestamp)


usageGB:number
readOnly


total usage in GB - including bandwidth and storage


usageGraph:string
readOnly


a semi-colon separated list of comma-separated key-values to represent a usage graph.


keys could be 1-12 for a year view (1,1.2;2,1.1;3,0.9;...;12,1.4;)


keys could be 1-[28,29,30,31] depending on the requested month, for a daily view in a given month (1,0.4;2,0.2;...;31,0.1;)