# Динамика охвата ключевого слова

Описание

Метод для получения динамики по охвату ключевого слова или фразы. Подойдет для мониторинга упоминания бренда или персоны в Telegram-публикациях. Возвращает суммарное количество просмотров публикаций, в которых встречается искомое ключевое слово за каждый день запрошенного периода.

Метод доступен в "API Search" (на тарифах S и выше)

# Запрос


# URL запроса

GET

https://api.tgstat.ru/words/reach

# Параметры

Параметр Описание Значение по умолчанию Обязательно
token Ваш токен Не задан Да
q Ключевое слово Не задан Да
startDate Период упоминания с (timestamp) Не задан Нет
endDate Период упоминания по (timestamp) Не задан Нет
hideForwards Исключить упоминания в публикациях, являющихся репостами 1 Нет
strongSearch Включить строгий поиск (отключает морфологию и поиск по части слова) 0 Нет
minusWords Список минус слов (разделитель - пробел) Не задан Нет
group Группировка результатов (day, week, month) day Нет

# Ответ


# Структура

{ 
    "status": "ok",
    "response": {
        "items": [      # Массив данных по дням, неделям или месяцам 
            ...
        ]
    }
}

# Пример ответа

{
    "status": "ok",
    "response": {
        "items": [
            {
                "period": "2018-11-04",
                "reach_count": 654
            },
            {
                "period": "2018-11-03",
                "reach_count": 1276
            },
            {
                "period": "2018-11-02",
                "reach_count": 1152
            },
            ...
        ]
    }
}

По умолчанию вернется результат за 10 последних дней. Однако, вы можете указать необходимый период с помощью параметров startDate и endDate, соблюдая при этом ограничения на вашем тарифе.

В зависимости от запрошенного типа группировки group - поле period будет принимать один из форматов:

"Y-m-d"     # для group=day 
"Y-W"       # для group=week
"Y-m"       # для group=month

Y - Порядковый номер года, 4 цифры
m - Порядковый номер месяца с ведущим нулём
d - День месяца, 2 цифры с ведущим нулём 
W - Порядковый номер недели года в соответствии со стандартом ISO-8601; недели начинаются с понедельника
 
# Подробнее о форматах даты http://php.net/manual/ru/function.date.php