package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?dimensions:string -> ?filters:string -> ?max_results:int -> ?sort:string -> ids:string -> metrics:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.RealtimeData.t * GapiConversation.Session.t

Returns real time 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 real time dimensions. E.g., 'rt:medium,rt:city'.

  • parameter filters

    A comma-separated list of dimension or metric filters to be applied to real time data.

  • parameter max_results

    The maximum number of entries to include in this feed.

  • parameter sort

    A comma-separated list of dimensions or metrics that determine the sort order for real time data.

  • parameter ids

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

  • parameter metrics

    A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.