package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Query : sig ... end
module ProfileInfo : sig ... end
module DataTable : sig ... end
module ColumnHeaders : sig ... end
type t = {
  1. columnHeaders : ColumnHeaders.t list;
    (*

    Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

    *)
  2. containsSampledData : bool;
    (*

    Determines if Analytics data contains samples.

    *)
  3. dataLastRefreshed : int64;
    (*

    The last refreshed time in seconds for Analytics data.

    *)
  4. dataTable : DataTable.t;
  5. id : string;
    (*

    Unique ID for this data response.

    *)
  6. itemsPerPage : int;
    (*

    The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

    *)
  7. kind : string;
    (*

    Resource type.

    *)
  8. profileInfo : ProfileInfo.t;
    (*

    Information for the view (profile), for which the Analytics data was requested.

    *)
  9. query : Query.t;
    (*

    Analytics data request query parameters.

    *)
  10. rows : string list list;
    (*

    Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

    *)
  11. sampleSize : int64;
    (*

    The number of samples used to calculate the result.

    *)
  12. sampleSpace : int64;
    (*

    Total size of the sample space from which the samples were selected.

    *)
  13. totalResults : int;
    (*

    The total number of rows for the query, regardless of the number of rows in the response.

    *)
  14. totalsForAllResults : (string * string) list;
    (*

    Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

    *)
}
val columnHeaders : (t, ColumnHeaders.t list) GapiLens.t
val containsSampledData : (t, bool) GapiLens.t
val dataLastRefreshed : (t, int64) GapiLens.t
val dataTable : (t, DataTable.t) GapiLens.t
val id : (t, string) GapiLens.t
val itemsPerPage : (t, int) GapiLens.t
val kind : (t, string) GapiLens.t
val profileInfo : (t, ProfileInfo.t) GapiLens.t
val query : (t, Query.t) GapiLens.t
val rows : (t, string list list) GapiLens.t
val sampleSize : (t, int64) GapiLens.t
val sampleSpace : (t, int64) GapiLens.t
val totalResults : (t, int) GapiLens.t
val totalsForAllResults : (t, (string * string) list) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct