com.kaltura.client.services.AnalyticsService Maven / Gradle / Ivy

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.AnalyticsFilter;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.ReportResponse;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

/**
 * api for getting analytics data
 * 
 * @param filter the analytics query filter
 * @param pager the analytics query result pager
 */
public class AnalyticsService {
	
	public static class QueryAnalyticsBuilder extends RequestBuilder {
		
		public QueryAnalyticsBuilder(AnalyticsFilter filter, FilterPager pager) {
			super(ReportResponse.class, "analytics", "query");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static QueryAnalyticsBuilder query(AnalyticsFilter filter)  {
		return query(filter, null);
	}

	/**
	 * report query action allows to get a analytics data for specific query
	  dimensions, metrics and filters.
	 * 
	 * @param filter the analytics query filter
	 * @param pager the analytics query result pager
	 */
    public static QueryAnalyticsBuilder query(AnalyticsFilter filter, FilterPager pager)  {
		return new QueryAnalyticsBuilder(filter, pager);
	}
}