get-metric-data

Описание

Получает исторические метрики данных из указанного экземпляра Amazon Connect.

Описание каждой исторической метрики см. в разделе «Определения метрик» в руководстве администратора Amazon Connect.

Примечание

Рекомендуется использовать API GetMetricDataV2. Он предоставляет большую гибкость, возможности и возможность запроса более длинных временных диапазонов, чем GetMetricData. Используйте его для получения исторических метрик агента и контактов за последние 3 месяца с различными интервалами. Вы также можете использовать его для создания пользовательских панелей мониторинга для измерения исторической производительности очередей и агентов. Например, вы можете отслеживать количество входящих контактов за последние 7 дней, разбивая данные по дням, чтобы увидеть, как изменился объем контактов в каждый день недели.

См. также: Документация API AWS

get-metric-data является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе аргумент --query должен извлекать данные из результатов следующих выражений запроса: MetricResults

Синтаксис

  get-metric-data
--instance-id <value>
--start-time <value>
--end-time <value>
--filters <value>
[--groupings <value>]
--historical-metrics <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--instance-id (строка)

Идентификатор экземпляра Amazon Connect. Вы можете найти ID экземпляра в Amazon Resource Name (ARN) экземпляра.

--start-time (отметка времени)

Отметка времени в формате эпохи Unix, с которой начинается период отчётности для получения исторических данных метрик. Время должно быть указано кратно 5 минутам, например, 10:05, 10:10, 10:15.

Начальное время не может быть ранее, чем за 24 часа до момента запроса. Исторические метрики доступны только за последние 24 часа.

--end-time (отметка времени)

Отметка времени в формате эпохи Unix, до которой заканчивается период отчётности для получения исторических данных метрик. Время должно быть указано кратно 5 минутам, например, 11:00, 11:05, 11:10 и должно быть позже, чем отметка времени начала.

Диапазон времени между начальным и конечным временем должен быть менее 24 часов.

--filters (структура)

Очереди (до 100) или каналы для фильтрации возвращаемых метрик. Данные метрик извлекаются только для ресурсов, связанных с очередями или каналами, включёнными в фильтр. В одном запросе можно указать как ID очередей, так и их ARN. Поддерживаются каналы VOICE, CHAT и TASK.

RoutingStepExpression не является допустимым фильтром для GetMetricData, и мы рекомендуем переключиться на GetMetricDataV2 для более актуальных функций.

Примечание

Чтобы отфильтровать по Queues, укажите ID/ARN очереди, а не её название.

Queues -> (список)

Очереди для фильтрации метрик. Необходимо указать хотя бы одну очередь и до 100 очередей на запрос. API GetCurrentMetricsData в частности требует очередь, когда вы включаете Filter в свой запрос.

(строка)

Channels -> (список)

Канал для фильтрации метрик.

(строка)

RoutingProfiles -> (список)

Список до 100 ID или ARN профилей маршрутизации.

(строка)

RoutingStepExpressions -> (список)

Список выражений в качестве фильтра, где выражение — это объект шага в критериях маршрутизации.

(строка)

Сокращённый синтаксис:

Queues=string,string,Channels=string,string,RoutingProfiles=string,string,RoutingStepExpressions=string,string

Синтаксис JSON:

{
  "Queues": ["string", ...],
  "Channels": ["VOICE"|"CHAT"|"TASK"|"EMAIL", ...],
  "RoutingProfiles": ["string", ...],
  "RoutingStepExpressions": ["string", ...]
}

--groupings (список)

Группировка, применяемая к возвращаемым метрикам. Например, при группировке по очереди возвращаемые метрики группируются по очереди. Возвращаемые значения применяются к метрикам каждой очереди, а не агрегируются для всех очередей.

Если группировка не указана, возвращается сводка метрик для всех очередей.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  QUEUE
  CHANNEL
  ROUTING_PROFILE
  ROUTING_STEP_EXPRESSION

--historical-metrics (список)

Метрики для получения. Укажите имя, единицу измерения и статистику для каждой метрики. Доступны следующие исторические метрики. Описание каждой метрики см. в разделе «Определение метрик» в руководстве администратора Amazon Connect.

Примечание

Этот API не поддерживает метрику входящих контактов (нет метрики CONTACTS_INCOMING, отсутствующей в документированном списке).

ABANDON_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

AFTER_CONTACT_WORK_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

API_CONTACTS_HANDLED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CALLBACK_CONTACTS_HANDLED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_ABANDONED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_AGENT_HUNG_UP_FIRST

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_CONSULTED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_HANDLED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_HANDLED_INCOMING

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_HANDLED_OUTBOUND

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_HOLD_ABANDONS

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_MISSED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_QUEUED

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_TRANSFERRED_IN

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_TRANSFERRED_OUT

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Единица измерения: КОЛИЧЕСТВО

Статистика: СУММА

HANDLE_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

HOLD_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

INTERACTION_AND_HOLD_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

INTERACTION_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

OCCUPANCY

Единица измерения: ПРОЦЕНТ

Статистика: СРЕДНЕЕ

QUEUE_ANSWER_TIME

Единица измерения: СЕКУНДЫ

Статистика: СРЕДНЕЕ

QUEUED_TIME

Единица измерения: СЕКУНДЫ

Статистика: МАКСИМАЛЬНОЕ

SERVICE_LEVEL

Можно включить до 20 метрик SERVICE_LEVEL в запросе.

Единица измерения: ПРОЦЕНТ

Статистика: СРЕДНЕЕ

Порог: Для ThresholdValue, введите целое число от 1 до 604800 (включительно) в секундах. Для Comparison, вы должны ввести LT (для «Меньше чем»).

(структура)

Содержит информацию об исторической метрике. Описание каждой метрики см. в разделе «Определения метрик» в руководстве администратора Amazon Connect.

Name -> (строка)

Имя метрики.

Threshold -> (структура)

Порог метрики, используемый с метриками уровня обслуживания.

Comparison -> (строка)

Тип сравнения. Поддерживаются только сравнения «меньше чем» (LT).

ThresholdValue -> (двойное значение)

Значение порога для сравнения.

Statistic -> (строка)

Статистика метрики.

Unit -> (строка)

Единица измерения метрики.

Сокращённый синтаксис:

Name=string,Threshold={Comparison=string,ThresholdValue=double},Statistic=string,Unit=string ...

Синтаксис JSON:

[
  {
    "Name": "CONTACTS_QUEUED"|"CONTACTS_HANDLED"|"CONTACTS_ABANDONED"|"CONTACTS_CONSULTED"|"CONTACTS_AGENT_HUNG_UP_FIRST"|"CONTACTS_HANDLED_INCOMING"|"CONTACTS_HANDLED_OUTBOUND"|"CONTACTS_HOLD_ABANDONS"|"CONTACTS_TRANSFERRED_IN"|"CONTACTS_TRANSFERRED_OUT"|"CONTACTS_TRANSFERRED_IN_FROM_QUEUE"|"CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"|"CONTACTS_MISSED"|"CALLBACK_CONTACTS_HANDLED"|"API_CONTACTS_HANDLED"|"OCCUPANCY"|"HANDLE_TIME"|"AFTER_CONTACT_WORK_TIME"|"QUEUED_TIME"|"ABANDON_TIME"|"QUEUE_ANSWER_TIME"|"HOLD_TIME"|"INTERACTION_TIME"|"INTERACTION_AND_HOLD_TIME"|"SERVICE_LEVEL",
    "Threshold": {
      "Comparison": "LT",
      "ThresholdValue": double
    },
    "Statistic": "SUM"|"MAX"|"AVG",
    "Unit": "SECONDS"|"COUNT"|"PERCENT"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON. Невозможно передавать произвольные двоичные данные с помощью значения JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее обрезаемого ответа.

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя AWS CLI.

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в руководстве пользователя AWS CLI.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет выведен пример YAML-ввода, который можно использовать с --cli-input-yaml. Если указано значение output, это проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что бинарные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а бинарные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего бинарному блоку fileb:// всегда будет обрабатываться как бинарный и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Вывод

NextToken -> (string)

Если есть дополнительные результаты, это маркер для следующего набора результатов.

Токен истекает через 5 минут с момента его создания. В последующих запросах, использующих токен, должны использоваться те же параметры запроса, что и в запросе, который сгенерировал токен.

MetricResults -> (list)

Информация об исторических метриках.

Если группировка не указана, возвращается сводка данных метрик.

(структура)

Содержит информацию об исторических метриках, полученных.

Dimensions -> (структура)

Измерение для метрик.

Queue -> (структура)

Информация о очереди, для которой возвращаются метрики.

Id -> (string)

Идентификатор очереди.

Arn -> (string)

Amazon Resource Name (ARN) очереди.

Channel -> (string)

Канал, используемый для группировки и фильтрации.

RoutingProfile -> (структура)

Информация о профиле маршрутизации, назначенном пользователю.

Id -> (string)

Идентификатор профиля маршрутизации.

Arn -> (string)

Amazon Resource Name (ARN) профиля маршрутизации.

RoutingStepExpression -> (string)

Выражение шага в критериях маршрутизации.

Collections -> (list)

Набор метрик.

(структура)

Содержит данные для исторической метрики.

Metric -> (структура)

Информация о метрике.

Name -> (string)

Название метрики.

Threshold -> (структура)

Порог для метрики, используемой с метриками уровня сервиса.

Comparison -> (string)

Тип сравнения. Поддерживаются только сравнения «меньше» (LT).

ThresholdValue -> (double)

Значение порога для сравнения.

Statistic -> (string)

Статистика для метрики.

Unit -> (string)

Единица измерения для метрики.

Value -> (double)

Значение метрики.