Для AI-агентов: markdown этой страницы — /docs-content/polls/results.md индекс документации — /llms.txt

Результаты опроса

GET /v1/polls/:pollId/results

Возвращает опрос со счётчиками и выборкой проголосовавших по каждому ответу. В анонимном опросе личности участников недоступны никому.

Итоги закрываются по правилам Битрикс24: при resultsVisible: false счётчики и проценты равны null, voters пуст, votersComplete: false. Правила видимости: объект опроса.

Скоуп: vote. Ограничения ключей — Опросы.

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрpollId (path) Типnumber Обяз.да По умолч.— ОписаниеПоложительный ID прикрепления: поле id из поиска опросов, не voteId
ПараметрvotersLimit (query) Типnumber Обяз.нет По умолч.10 ОписаниеЦелое от 1 до 50: максимум участников в выборке каждого ответа

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/polls/25/results?votersLimit=10" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/polls/25/results?votersLimit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/polls/25/results?votersLimit=10', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/polls/25/results?votersLimit=10', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеОбъект опроса
Полеdata.questions[].answers[].voters Типarray ОписаниеВыборка: {id, name, position, avatarUrl}, последние два поля могут быть null. Для анонимного опроса — []
Полеdata.questions[].answers[].votersComplete Типboolean ОписаниеДля открытого опроса: длина выборки равна счётчику ответа. Для анонимного или при скрытых итогах — всегда false

Для полного списка используйте проголосовавших за ответ. Отчёт Excel и ссылки на итоги не возвращаются, отчёт выгружается в интерфейсе Битрикс24.

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

JSON 
{
  "success": true,
  "data": {
    "id": 25,
    "voteId": 33,
    "status": "active",
    "anonymous": false,
    "allowRevote": true,
    "resultsHidden": false,
    "resultsVisible": true,
    "votersCount": 1,
    "questions": [
      {
        "id": 35,
        "text": "When?",
        "multipleChoice": false,
        "required": false,
        "votesCount": 1,
        "answers": [
          {
            "id": 85,
            "text": "Now",
            "votesCount": 1,
            "percent": 100,
            "voters": [
              { "id": 1317, "name": "Anna Smith", "position": null, "avatarUrl": "https://example.bitrix24.ru/upload/main/avatar.png" }
            ],
            "votersComplete": true
          },
          { "id": 87, "text": "Later", "votesCount": 0, "percent": 0, "voters": [], "votersComplete": true }
        ]
      }
    ],
    "myVote": { "voted": true, "answerIds": [85] },
    "permissions": { "canVote": false, "canRevote": true, "canManage": true }
  }
}

Пример ответа при ошибке

400 — votersLimit больше 50:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid poll parameters."
  }
}

Ошибки

HTTP Код Причина и действие
HTTP400 КодINVALID_PARAMS Причина и действиеpollId не положительное целое число либо votersLimit вне диапазона 1–50
HTTP401 КодTOKEN_MISSING Причина и действиеНет пользовательской сессии Битрикс24
HTTP403 КодSCOPE_DENIED Причина и действиеНет скоупа vote
HTTP403 КодCOWORK_READONLY Причина и действиеОперация запрещена для ключа Коворка «портал только для чтения»
HTTP404 КодPOLL_NOT_FOUND Причина и действиеОпрос не найден или недоступен
HTTP403 КодPOLL_ACCESS_DENIED Причина и действиеБитрикс24 запретил операцию
HTTP422 КодBITRIX_ERROR Причина и действиеБитрикс24 отклонил запрос, например метод недоступен в этой версии

Другие отказы авторизации, лимиты и общие ошибки — Ошибки.

Смотрите также