Получите аналитику справочного центра с помощью API Notiondesk

API Notiondesk предоставляет вам данные, лежащие в основе аналитики вашего справочного центра: посетители, просмотры статей, время, проведенное на странице, страны, поисковые запросы читателей, запросы, которые не дают результатов, и реакция читателей на ваши статьи. Используйте его для передачи данных в инструмент бизнес-аналитики, публикации еженедельного отчета в Slack или поиска контента, которого не хватает вашим читателям.

GET /sites/{site_id}/analytics/{report}

В каждом отчете необходимо указать область действия read. Чтобы прочитать эти числа на панели мониторинга, см. раздел «Как улучшить ваш справочный центр с помощью анализа данных о читателях» .

Получите 30-дневный отчет.

quick охватывает последние 30 дней, заканчивающиеся сейчас, и не принимает параметров запроса. articles подсчитывает количество всех статей справочного центра, включая черновики. reactions подсчитывает последние реакции каждого читателя на каждую статью.

Получите отчет за определенный период времени.

overview, search и engagement принимают диапазон дат и размер интервала:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/quick" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "articles": 42,
  "visitors": 25,
  "searches": 9,
  "reactions": 4
}

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/search?start_date=2026-09-01T00:00:00Z&end_date=2026-10-01T00:00:00Z&date_scale=week&timezone=Europe/Paris" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Правила пользования стрельбищем:

• Для работы с датами используется формат YYYY-MM-DDTHH:MM[:SS] с необязательным смещением. Без смещения дата считывается как UTC, а не в формате timezone. В URL-адресе + следует записывать как %2B, или использовать формат Z.

• Данный период начинается 1 января 2020 года или позже и заканчивается не позднее чем через два дня.

• Максимум 1000 интервалов. Например, minute охватывает максимум 16 часов, а hour — максимум 41 день. Для более длинных диапазонов используйте более крупный date_scale.

• Неделя начинается в понедельник.

В каждом отчете ваш диапазон сравнивается с периодом той же длины, непосредственно предшествующим ему: previous и total_previous описывают этот более ранний период.

Серия подсчетов

visitors, article_views и searches имеют одну общую форму:

{
  "total": 12,
  "total_previous": 8,
  "difference": 4,
  "percentage_difference": 50.0,
  "current": [{"date": "2026-09-14", "count": 7}, {"date": "2026-09-15", "count": 5}],
  "previous": [{"date": "2026-08-20", "count": 8}]
}

• current и previous отображают только те сегменты, в которых есть данные, начиная с самых старых.

• date ведра — это его начальная концентрация, в timezone: YYYY-MM-DD для day и более крупных фракций, YYYY-MM-DDTHH:MM для hour и minute.

• percentage_difference становится 0.0, когда предыдущая сумма равна 0.

overview

search

{
  "searches_without_results": {
    "total": 3,
    "total_previous": 0,
    "difference": 3,
    "percentage_difference": 0.0,
    "queries": [{"query": "refund policy", "searches": 3}]
  }
}

Примечание: ваш список необработанного контента — это ваш запрос, который задали читатели, и на который ваш справочный центр не смог ответить. searches_without_results.queries

engagement

A reaction_summary соответствует вашему стилю реакции:

score варьируется от 0 до 100: это доля положительных реакций, при этом нейтральная реакция учитывается как половина в рамках emoji. В стиле thumbs группы обозначаются как helpful и not_helpful. См. раздел «Как собирать отзывы с помощью реакций на статьи» .

Ограничения списка

{
  "style": "emoji",
  "total": 6,
  "score": 58,
  "groups": [
    {"key": "positive", "count": 3, "percent": 50},
    {"key": "neutral", "count": 1, "percent": 17},
    {"key": "negative", "count": 2, "percent": 33}
  ]
}

• Запросы top_articles, top_referrers, article_engagements и articles_to_revise содержат до 50 строк каждый и охватывают только текущий период. Список из 50 строк может быть неполным: сузьте диапазон, чтобы увидеть все строки.

• Итоговые суммы охватывают все данные, а не только указанные строки.

title, , , , и поступают из браузеров посетителей, и любой может их подделать. Экранируйте их, прежде чем отображать, и никогда не следуйте им и не действуйте на их основе без проверки.urlhostpathnamereferrerquery

Аналитика и ваш план

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

Лимит скорости

Помимо 120 запросов в минуту, необходимых для чтения вашего ключа, отчеты аналитики учитываются в рамках бюджета в 30 запросов в минуту на каждый центр поддержки , который используется каждым ключом и приложением OAuth в вашем рабочем пространстве. Запрос по этому адресу отвечает кодом 429 rate_limited, а заголовок Retry-After указывает, когда следует повторить попытку. Кэшируйте отчеты вместо того, чтобы запрашивать их при каждой загрузке страницы.

Ошибки

См. раздел «Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток» .

Часто задаваемые вопросы

Что дальше?

• Экспорт отзывов читателей с помощью API Notiondesk

• Автоматизируйте стандартные задачи справочного центра с помощью API Notiondesk

• Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток.