Analytics.query Documentation

Discussion for analytics.query documentation

any word on when this documentation will be out?

particularly, what are valid values for dimensions and metrics?

1 Like

When going to and trying to use different API calls, I was looking for a way to know what valid inputs would be for the different mandatory fields for each query. A list of allowed values would great.

I am trying to accomplish the following report for viewing statistics per logged in viewer:
Filtered on date range, group by video_id

Video ID, Video Name, User ID, User view time, User view duration, Video playback url/ domain (we anticipate that each user will view only from one location - i.e. a specific LMS course or learning microsite)

Hi @lars.jensen,

To obtain the stats you described, you’ll need to use the report.getTable() action with different reportType params.

reportType=12 (SPECIFIC_USER_ENGAGEMENT), will produce the following metrics:


reportType=11__(USER_ENGAGEMENT) will return:


reportType=40__(APP_DOMAIN_UNIQUE_ACTIVE_USERS) will return:

for example:
header application,domain,unique_known_users
data mediaspace,$,14;mediaspace,$ANOTHER_KMS_INSTANCE_DOMAIN,13;Unknown,Unknown,12;kmc,Unknown,5;
totalCount 4

reportType=41__(TOP_SOURCES) will return:

for example:
data Live stream,2,621000,1;Kaltura Capture,1,15000,1;Recorded live stream,1,621000,1;Unknown,1,69000,1;Upload,1,37000,1;

The available report types are documented here:

Of course, for reports that generate many records, you’ll need to use the KalturaFilterPager object and increase the pageSize at each iteration.

Thank you for the very detailed response, Jess! Also - the quoted link is exactly was what I was looking for - I remember seeing this in the past but forgot that these object descriptions exist in the documentation. Thanks!