kendra_get_snapshots: Retrieves search metrics data
In paws.analytics: 'Amazon Web Services' Analytics Services

kendra_get_snapshots

R Documentation

Retrieves search metrics data

Description

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

See https://www.paws-r-sdk.com/docs/kendra_get_snapshots/ for full documentation.

Usage

kendra_get_snapshots(
  IndexId,
  Interval,
  MetricType,
  NextToken = NULL,
  MaxResults = NULL
)

Arguments

`IndexId`	[required] The identifier of the index to get search metrics data.
`Interval`	[required] 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.
`MetricType`	[required] 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.
`NextToken`	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.
`MaxResults`	The maximum number of returned data for the metric.