Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
GetSnapshots
Recupera datos de métricas de búsqueda. Los datos proporcionan una instantánea de cómo interactúan los usuarios con la aplicación de búsqueda y la eficacia de la aplicación.
Sintaxis de la solicitud
{
"IndexId": "string",
"Interval": "string",
"MaxResults": number,
"MetricType": "string",
"NextToken": "string"
}Parámetros de solicitud
Para obtener información sobre los parámetros que son comunes a todas las acciones, consulteParámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- IndexId
-
El identificador del índice para obtener datos de métricas de búsqueda.
Type: Cadena
Restricciones de longitud: Longitud fija de 36.
Patrón:
[a-zA-Z0-9][a-zA-Z0-9-]*Obligatorio: Sí
- Interval
-
El intervalo de tiempo o la ventana de tiempo para obtener datos de métricas de búsqueda. El intervalo de tiempo utiliza la zona horaria del índice. Puede ver los datos en las siguientes ventanas de tiempo:
-
THIS_WEEK: La semana actual, comenzando el domingo y finalizando el día anterior a la fecha actual. -
ONE_WEEK_AGO: La semana anterior, comenzando el domingo y finalizando el sábado siguiente. -
TWO_WEEKS_AGO: La semana anterior a la semana anterior, comenzando el domingo y finalizando el sábado siguiente. -
THIS_MONTH: El mes en curso, a partir del primer día del mes y finaliza el día anterior a la fecha actual. -
ONE_MONTH_AGO: el último día del mes a partir del primer día del mes y finaliza el último día del mes. -
TWO_MONTHS_AGO: el mes anterior al último mes, a partir del primer día del mes y finaliza el último día del mes.
Type: Cadena
Valores válidos:
THIS_MONTH | THIS_WEEK | ONE_WEEK_AGO | TWO_WEEKS_AGO | ONE_MONTH_AGO | TWO_MONTHS_AGOObligatorio: Sí
-
- MaxResults
-
Número máximo de datos devueltos para la métrica.
Type: Entero
Obligatorio: No
- MetricType
-
La métrica que desea recuperar. Puede especificar solo una métrica por llamada.
Para obtener más información sobre las métricas que puede ver, consulteObtención de información con análisis de búsquedas.
Type: Cadena
Valores válidos:
QUERIES_BY_COUNT | QUERIES_BY_ZERO_CLICK_RATE | QUERIES_BY_ZERO_RESULT_RATE | DOCS_BY_CLICK_COUNT | AGG_QUERY_DOC_METRICS | TREND_QUERY_DOC_METRICSObligatorio: Sí
- NextToken
-
Si la respuesta anterior estaba incompleta (porque hay más datos que recuperar), Amazon Kendra devuelve un token de paginación en la respuesta. Puede utilizar este token de paginación para recuperar el siguiente grupo de datos de métricas de búsqueda.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 800 caracteres.
Obligatorio: No
Sintaxis de la respuesta
{
"NextToken": "string",
"SnapshotsData": [
[ "string" ]
],
"SnapshotsDataHeader": [ "string" ],
"SnapShotTimeFilter": {
"EndTime": number,
"StartTime": number
}
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- NextToken
-
Si la respuesta se trunca, Amazon Kendra devuelve este token, que puede utilizar en una solicitud posterior para recuperar el siguiente conjunto de datos de métricas de búsqueda.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 800 caracteres.
- SnapshotsData
-
Los datos de métricas de búsqueda. Los datos devueltos dependen del tipo de métrica que haya solicitado.
Type: Matriz de matrices de cadenas
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.
- SnapshotsDataHeader
-
Los encabezados de columna de los datos de métricas de búsqueda.
Type: Matriz de cadenas
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.
- SnapShotTimeFilter
-
Fecha y hora del principio y final de la ventana de hora de los datos de métricas de búsqueda.
Tipo: objeto TimeRange
Errores
Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
Código de estado HTTP: 400
- InternalServerException
-
Código de estado HTTP: 500
- InvalidRequestException
-
La entrada a la solicitud no es válida.
Código de estado HTTP: 400
- ResourceNotFoundException
-
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
