Получение статистики API-запросов

Данная команда позволяет получить информацию о количестве и качестве обработанных контактных данных через API сервиса за календарный месяц. Команда может пригодиться, если требуется отслеживать превышение лимитов, установленных в вашем тарифном плане.

Сервис подсчитывает статистику API-запросов с определённой задержкой (до нескольких минут после обработки запроса), поэтому данная команда не позволяет отслеживать изменения статистики в режиме реального времени.

Параметры команды

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

• https://ahunter.ru/site/user/apihistory/stat - URL-команды.
• user=API-токен - API-токен пользователя из личного кабинета.
• output=json - данный параметр сообщает сервису формат, в котором требуется вернуть результат обработки. В отличие от команд стандартизации контактных данных, эта команда поддерживает только JSON формат.
• year=номер года - номер года, за который запрашивается статистика.
• month=номер месяца - календарный номер месяца, за который запрашивается статистика. Нумерация месяцев ведётся, начиная с 1.

Опциональные параметры.

• output=pretty - опция применима только в случае использования JSON формата ответа сервиса. Данная опция требует, чтобы сервис выполнил "красивое" форматирование возвращаемого JSON текста, расставив в нем переносы строк, отступы и пробельное прореживание. Опция может быть полезна при отладке взаимодействия пользовательского приложения с сервисом.

Пример запроса

Ниже приведен пример данного запроса сервису.

В данном запросе используются следующие параметры.

• user=demotoken - сообщает сервису API-токен пользователя.
• output=json|pretty - сообщает сервису о том, что необходимо вернуть ответ в формате JSON, отформатировав его "красиво".
• month=1 и year=2019 – указывают, что запрашивается статистика за январь 2019 года.

Результат запроса в формате JSON

Ниже приведен пример ответа сервиса. Результирующий JSON-ответ получен с использованием опции output=json|pretty, позволяющей выполнить "красивое" форматирование JSON-текста.

    {
      "addresses" : {
        "corrected_amount" : 166,
        "processed_amount" : 167
      },
      "last_request_time" : "2019-01-24T10:43:00.130Z",
      "persons" : {
        "corrected_amount" : 11,
        "processed_amount" : 11
      },
      "phones" : {
        "corrected_amount" : 7,
        "processed_amount" : 7
      },
      "request_process_time" : 1,
      "total_requests_amount" : 185,
      "total_sum" : 500,
      "types" : [
        {
          "amount" : 161,
          "type" : "cleanse\/address"
        },
        {
          "amount" : 11,
          "type" : "cleanse\/person"
        },
        {
          "amount" : 7,
          "type" : "cleanse\/phone"
        },
        {
          "amount" : 6,
          "type" : "fetch\/address"
        }
      ]
    }

Результатом выполнения данной команды является JSON-объект со следующими элементами.

• total_requests_amount - целое число, показывает суммарное количество обработанных API-запросов в течение запрошенного месяца.
• total_sum - стоимость всех обработанных API-запросов в копейках.
• last_request_time - строка, содержащая время последнего обработанного API-запроса в рамках запрошенного месяца. Данная строка возвращается в формате XML Schema dateTime (http://www.w3.org/TR/xmlschema-2/#dateTime).
• addresses - JSON-объект, содержит информацию о количестве обработанных почтовых адресов.
• phones - JSON-объект, содержит информацию о количестве обработанных номеров телефонов.
• persons - JSON-объект, содержит информацию о количестве обработанных ФИО.
• types - JSON-массив, в котором приводится распределение обработанных API-запросов по их типам.
• request_process_time - стандартный элемент, возвращаемый во всех API-командах сервиса, содержит время обработки данного запроса в миллисекундах.

Ниже приведено детальное описание этих элементов.

JSON-объект addresses: статистика обработки адресов

Данный объект содержит суммарное количество обработанных почтовых адресов посредством всех API-команд, принимающих на вход почтовые адреса. Пример такого объекта приведен ниже.

      {
        "corrected_amount" : 166,
        "processed_amount" : 167
      }

Данный объект содержит следующие элементы.

• processed_amount - числовое значение, указывает количество обработанных почтовых адресов.
• corrected_amount - числовое значение, соответствует количеству успешно исправленных почтовых адресов. Успешными считаются данные, по которым сервис вернул непустой результат.

JSON-объект phones: статистика обработки номеров телефонов

Данный объект содержит суммарное количество обработанных номеров телефонов посредством всех API-команд, принимающих на вход номера телефонов. По своей структуре данный объект аналогичен JSON-объекту addresses.

JSON-объект persones: статистика обработки ФИО

Данный объект содержит суммарное количество обработанных ФИО посредством всех API-команд, принимающих на вход фамилии, имена и отчества. По своей структуре данный объект аналогичен JSON-объекту addresses.

JSON-массив types: распределение запросов по типам API-команд

Данный массив содержит однотипные объекты со статистикой по отдельным типам обработанных API-команд. Пример такого объекта приведен ниже.

      {
        "amount" : 161,
        "type" : "cleanse/address"
      }

Данный объект содержит следующие элементы.

• type - строковое название API-команды, статистика которой содержится в данном JSON-объекте.
• amount - элемент числового типа, указывает на количество обработанных сервисом запросов, соответствующих данной API-команде.