Method: analytics.agentPerformances.list

Отображает данные о производительности оператора, доступные звонящему.

Каждый результат представляет собой показатели производительности конкретного агента в конкретной стране. Если для агента недостаточно данных по данной стране, запись о производительности для этой пары агент-страна не возвращается.

HTTP-запрос

GET https://businesscommunications.googleapis.com/v1/analytics/agentPerformances

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры запроса

Параметры
pageSize

integer

Необязательно. Укажите максимальное количество результатов, которые должен вернуть сервер. Сервер может дополнительно ограничить максимальное количество результатов, возвращаемых на одной странице. Если pageSize равно 0, сервер сам определит количество возвращаемых результатов. Максимальное значение pageSize — 1000.

pageToken

string

Необязательный параметр. Значение nextPageToken, возвращаемое из предыдущего запроса List, если таковое имелось.

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Возвращает список результатов работы агентов.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Поля
agentPerformances[]

object ( AgentPerformance )

Список достижений агентов.

nextPageToken

string

Необязательный параметр. Токен пагинации для получения следующей страницы результатов. Если значение равно "", это означает, что дальнейшие результаты по запросу отсутствуют.

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/businesscommunications

Для получения более подробной информации см.OAuth 2.0 Overview .

Производительность агента

Показатели эффективности работы агента в стране.

JSON-представление 
{
  "name": string,
  "displayName": string,
  "countryCode": string,
  "agentUseCase": enum (AgentUseCase),
  "reputation": enum (Reputation),
  "trafficLimit": integer,
  "metricsPeriodEndTime": string,
  "spamTrendDays7": enum (TrendDirection),
  "spamTrendDays28": enum (TrendDirection),
  "agentUnsubscribeReasonMetricsDays7": {
    object (AgentUnsubscribeReasonMetrics)
  },
  "agentUnsubscribeReasonMetricsDays28": {
    object (AgentUnsubscribeReasonMetrics)
  }
}
Поля
name

string

Уникальный идентификатор агента.

Определяется платформой.

displayName

string

Обязательно. Имя, которое агент отображает пользователям. Максимум 40 символов.

После подтверждения личности агента внести изменения невозможно.

countryCode

string

Страновой аспект для заданных показателей эффективности. Указывается в виде кода страны ISO 3166 Alpha-2 . Например, «US» означает Соединенные Штаты Америки.

agentUseCase

enum ( AgentUseCase )

Вариант использования агента

reputation

enum ( Reputation )

Репутация агента в данной стране.

trafficLimit

integer

Ограничение трафика для агента (количество сообщений на пользователя в месяц) в данной стране. Если на агента не распространяются ограничения трафика, значение не будет установлено.

metricsPeriodEndTime

string ( Timestamp format)

Временная метка, обозначающая конец периода, за который были рассчитаны метрики. Метрики, включая репутацию, рассчитываются на основе данных до этой временной метки. Эта временная метка соответствует последней полуночи по тихоокеанскому времени (PT).

Используется RFC 3339, согласно которому сгенерированный вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

spamTrendDays7

enum ( TrendDirection )

Тенденция спама за 7 дней.

spamTrendDays28

enum ( TrendDirection )

Тенденция спама за 28-дневный период.

agentUnsubscribeReasonMetricsDays7

object ( AgentUnsubscribeReasonMetrics )

Показатели причин отписки агентов за 7-дневный период.

agentUnsubscribeReasonMetricsDays28

object ( AgentUnsubscribeReasonMetrics )

Показатели причин отписки агентов за 28-дневный период.

Репутация

Репутация агента в данной стране.

Перечисления
REPUTATION_UNSPECIFIED Репутация не указана.
LOW Низкая репутация.
MEDIUM Средний уровень репутации. Это уровень репутации по умолчанию.
HIGH Высокая репутация.

TrendDirection

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

Перечисления
TREND_DIRECTION_UNSPECIFIED Направление тренда не указано.
DOWN Тенденция к снижению.
NEUTRAL Тенденция не изменилась.
UP Тенденция восходящая.

AgentUnsubscribeReasonMetrics

Метрики причин отписки агента за заданный период.

JSON-представление 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Поля
notSignedUpPercentage

integer

Процент пользователей, выбравших в качестве причины отписки «Не зарегистрирован».

tooManyMessagesPercentage

integer

Процент пользователей, выбравших в качестве причины отписки «Слишком много сообщений».

noLongerInterestedPercentage

integer

Процент пользователей, выбравших в качестве причины отписки «Больше не интересно».

spamPercentage

integer

Процент пользователей, выбравших «Спам» в качестве причины отписки.

otherPercentage

integer

Процент пользователей, выбравших «Другое» в качестве причины отписки.