Module `DataResource.Ga`

module SamplingLevel : sig ... end

module Output : sig ... end

val get : ?⁠base_url:string -> ?⁠etag:string -> ?⁠std_params:GapiService.StandardParameters.t -> ?⁠dimensions:string -> ?⁠filters:string -> ?⁠include_empty_rows:bool -> ?⁠max_results:int -> ?⁠output:Output.t -> ?⁠samplingLevel:SamplingLevel.t -> ?⁠segment:string -> ?⁠sort:string -> ?⁠start_index:int -> ids:string -> start_date:string -> end_date:string -> metrics:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.GaData.t * GapiConversation.Session.t

Returns Analytics data for a view (profile).

parameter base_url: Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

parameter etag: Optional ETag.

parameter std_params: Optional standard parameters.

parameter dimensions: A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

parameter filters: A comma-separated list of dimension or metric filters to be applied to Analytics data.

parameter include_empty_rows: The response will include empty rows if this parameter is set to true, the default is true

parameter max_results: The maximum number of entries to include in this feed.

parameter output: The selected format for the response. Default format is JSON.

parameter samplingLevel: The desired sampling level.

parameter segment: An Analytics segment to be applied to data.

parameter sort: A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.

parameter start_index: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

parameter ids: Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

parameter start_date: Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

parameter end_date: End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.

parameter metrics: A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.