Module Values.GetSnapshotsRequestSource

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

Sourcetype nonrec t = {
  1. indexId : IndexId.t;
    (*

    The identifier of the index to get search metrics data.

    *)
  2. interval : Interval.t;
    (*

    The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows: THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date. ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday. TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday. THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date. ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month. TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.

    *)
  3. metricType : MetricType.t;
    (*

    The metric you want to retrieve. You can specify only one metric per call. For more information about the metrics you can view, see Gaining insights with search analytics.

    *)
  4. nextToken : NextToken.t option;
    (*

    If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.

    *)
  5. maxResults : Integer.t option;
    (*

    The maximum number of returned data for the metric.

    *)
}
Sourceval context_ : string
Sourceval make : ?nextToken:??? -> ?maxResults:??? -> indexId:IndexId.t -> interval:Interval.t -> metricType:MetricType.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of Integer.t | `String of IndexId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t