Kaltura Analytics - Data Retrieval API

The Kaltura Analytics Data Retrieval API provides a simple but powerful tool to query data programmatically using the standards of the Kaltura API, such as authentication, client libraries, etc.

Endpoint

http://www.kaltura.com/api_v3/index.php?service=analytics&action=getData

Input

ParamDescriptionExpected ValuesMandatory
startDatethe start date from which to fetch the dataa date and time with the format yyyyMMdd-HH24:mi:ss(red star)
endDatethe end date until which to fetch the dataa date and time with the format yyyyMMdd-HH24:mi:ss(red star)
partnerIdthe id of the partner who owns the dataa valid partner id (an integer)(red star)
metricsa comma separated list of metrics

playImpression,playRequested,play,estimatedMinutesWatched,

averageViewDuration,playThrough25,playThrough50,

playThrough75,playThrough100,playRatio,averageViewDropOff,

segmentsWatched,percentageWatched,uniqueKnownUsers,

uniquePlayerSessionId,uniqueVideos,view,dvrView,peakView,

peakDvrView,bufferingTime,averageActualBitrate,

loadToPlayTime

(red star)
dimensionsa comma separated list of dimensions

partner,entry,knownUserId,device,operatingSystem,browser,

country,city,syndicationDomain,syndicationURL,application,

category,playbackContext,day,hour,minute,10sec,streamingProtocol,

expectedQuality,uiConfID

 
filtersa comma separated list of filters  
paginationindex, number of rows

2 comma separated numbers [i,n], such as i >= 0 and n > 0.

Example: the value 0,20 will cause the API to return the first 20 rows

 
sortinga comma separated list of sorting fields

supported dimension/metrics to sort the results by. each field can be

prepended with + or - to denote ascending or descending sorting

 
timezoneOffsetthe timezone offset from UTC (GMT)Any integer value of an offset between UTC-12 and UTC+14 
In This Article
Was this article helpful?
Thank you for your feedback!