API

Name: API
Brand: WebAsk
SKU: 70
Rating: 5 (5 reviews)

Содержание

Общая информация

Домен API: https://api.webask.io/
Формат возвращаемых данных: JSON

Сгенерировать API-ключ можно в соответствующем разделе из аккаунта, - https://app.webask.io/account/api

Обратите внимание, что к запросам нужно дописывать ключ

Authorization: Bearer [токен]

Получить список опросов

https://api.webask.io/api/service/quiz get

Результат ответа

{
"id": "ID опроса",
"name": "название",
"url_shared": "адрес опроса",
"is_published": true,
"folder": {
"id": 384,
"workspace_id": 384,
"user_id": 12,
"name": "Мои опросы",
"pos": 1,
"is_default": true,
"created_at": "2022-04-01T08:37:14.000000Z",
"updated_at": "2022-04-27T15:46:27.000000Z",
"deleted_at": null
}
}

Получить данные определенного опроса

https://api.webask.io/api/service/quiz/{id} get

Результат ответа

{
"id": "ID опроса",
"answer_count": "количество ответов",
"name": "название",
"url_shared": "адрес опроса",
"widgets": "виджет",
"hidden_options": "скрытая переменная",
"folder": {
"id": 384,
"workspace_id": 384,
"user_id": 12,
"name": "Мои опросы",
"pos": 1,
"is_default": true,
"created_at": "2022-04-01T08:37:14.000000Z",
"updated_at": "2022-04-27T15:46:27.000000Z",
"deleted_at": null
}
}

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

https://api.webask.io/api/service/quiz/{id}/answers get

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

limit - type: integer; default: 20;
offset - type: integer; default: 20;
date - type: date_format: Y-m-d;

Результат ответа

[
{
"id": 4813,
"visit_id": 46139,
"date": "2023-08-24T12:51:33.466162",
"date_start": "2023-08-24T12:51:33.466162",
"date_end": "2023-08-24T12:51:28.275591",
"is_complete": true,
"extra_fields": null,
"answers": [
{
"type": "yesno",
"rowId": "3ec8521a-3af8-4fec-b11e-7409d38eab33",
"title": "yes nо",
"result": [
{
"uuid": "adbe1d5f-29e2-468c-863b-5b136a519ad1",
"label": "Да"
}
],
"max_val": null,
"hidden_options": []
},
{
"type": "slider",
"rowId": "87a748c3-43e5-4ecc-bba2-413deb908864",
"title": "ползунок",
"result": null,
"max_val": null,
"hidden_options": []
},
{
"type": "file",
"rowId": "0753c3d8-3898-458c-9de1-32f7a6efc89b",
"title": "укеукеуке",
"result": null,
"max_val": null,
"hidden_options": []
},
{
"type": "userInfo",
"title": null,
"result": {
"ip": "5.76.136.157",
"browser": "Chrome",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.4844.84 Safari/537.36",
"password_number": null
}
}
],
"over_upload_limit": false
},
{
"id": 4812,
"visit_id": 46137,
"date": "2023-08-24T16:43:20.07436",
"date_start": "2023-08-24T16:43:20.07436",
"date_end": "2023-08-24T16:43:15.686992",
"extra_fields": null,
"is_complete": false,
"answers": [
{
"type": "yesno",
"rowId": "3ec8521a-3af8-4fec-b11e-7409d38eab33",
"title": "yes но",
"result": [
{
"uuid": "adbe1d5f-29e2-468c-863b-5b136a519ad1",
"label": "Да"
}
],
"max_val": null,
"hidden_options": []
},
{
"type": "slider",
"rowId": "87a748c3-43e5-4ecc-bba2-413deb908864",
"title": "ползунок",
"result": null,
"max_val": null,
"hidden_options": []
},
{
"type": "file",
"rowId": "0753c3d8-3898-458c-9de1-32f7a6efc89b",
"title": "укеукеуке",
"result": null,
"max_val": null,
"hidden_options": []
},
{
"type": "userInfo",
"title": null,
"result": {
"ip": "178.90.32.141",
"browser": "Chrome",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36",
"password_number": null
}
}
],
"over_upload_limit": false
},
{
"id": 4811,
"visit_id": 46136,
"date": "2023-08-24T16:47:05.660563",
"date_start": "2023-08-24T16:47:05.660563",
"date_end": "2023-08-24T16:46:59.852849",
"extra_fields": null,
"is_complete": true,
"answers": [
{
"type": "slider",
"rowId": "87a748c3-43e5-4ecc-bba2-413deb908864",
"title": "ползунок",
"result": 57,
"max_val": null,
"hidden_options": []
},
{
"type": "userInfo",
"title": null,
"result": {
"ip": "178.90.32.141",
"browser": "Chrome",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36",
"password_number": null
}
}
],
"over_upload_limit": false
}
]

Скрытые переменные

Получить скрытую переменную

https://api.webask.io/api/service/quiz/{id}/hidden/options get

Отправить скрытую переменную

https://api.webask.io/api/service/quiz/{id}/hidden/options/create post

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

{
"name": "productType",
"value": "clientShop"
}

Обновить скрытую переменную

https://api.webask.io/api/service/quiz/{id}/hidden/options/update/{id} post

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

{
"name": "productType",
"value": "clientShop"
}

Удалить скрытую переменную

https://api.webask.io/api/service/quiz/{id}/hidden/options/delete/{id} post

Параметры скрытых переменных в вопросах Получить скрытую переменную в вопросе

https://api.webask.io/api/service/quiz/{id}/widgets/hidden/options get

Отправить скрытую переменную в вопросе

https://api.webask.io/api/service/quiz/{id}/widgets/hidden/options/create post

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

{
"name": "productType",
"value": "clientShop",
"widget_uuid": "c63b9a88-2f1b-4735-a7ab-0b5fd84c90c2"
}

Обновить скрытую переменную в вопросе

https://api.webask.io/api/service/quiz/{id}/widgets/hidden/options/update/{opt_id} post

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

{
"name": "productType",
"value": "clientShop"
}

Удалить скрытую переменную в вопросе

https://api.webask.io/api/service/quiz/{id}/widgets/hidden/delete/{opt_id} post

Управление опросами

Добавить заметку к опросу

https://api.webask.io/api/service/quiz/{id}/note post

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

{
"notes": "Текст заметки (максимум 1000 символов)"
}

Результат ответа

{
"status": true,
"notes": "Текст заметки"
}

Дублировать опрос

https://api.webask.io/api/service/quiz/{id}/duplicate post

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

{
"name": "Название копии (опционально)"
}

Результат ответа

{
"status": true,
"quiz": {
"id": 123,
"name": "Копия: Название опроса",
"url_shared": "https://example.com/abc123",
"is_published": false,
"created_at": "2024-01-01T12:00:00Z",
"updated_at": "2024-01-01T12:00:00Z",
"folder": {
"id": 1,
"name": "Моя папка"
}
}
}

Переименовать опрос

https://api.webask.io/api/service/quiz/{id}/rename post

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

{
"name": "Новое название опроса"
}

Результат ответа

{
"status": true,
"name": "Новое название опроса"
}

Сделать опрос шаблоном

https://api.webask.io/api/service/quiz/{id}/template post

Результат ответа

{
"status": true
}

Архивировать/разархивировать опрос

https://api.webask.io/api/service/quiz/{id}/archive post

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

{
"archive": true
}

Результат ответа

{
"status": true,
"archive_at": "2024-01-01T12:00:00Z",
"is_archived": true
}

Переместить опрос в другую папку

https://api.webask.io/api/service/quiz/{id}/move post

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

{
"folder_id": 5
}

Результат ответа

{
"status": true,
"folder_id": 5,
"folder": {
"id": 5,
"name": "Новая папка"
}
}

Удалить опрос

https://api.webask.io/api/service/quiz/{id} delete

Результат ответа

{
"status": true
}

Получить архивные опросы

https://api.webask.io/api/service/quiz/archived get

Результат ответа

[
{
"id": 123,
"name": "Архивный опрос",
"url_shared": "https://example.com/abc123",
"is_published": false,
"created_at": "2024-01-01T12:00:00Z",
"updated_at": "2024-01-01T12:00:00Z",
"archive_at": "2024-01-02T12:00:00Z",
"folder": {
"id": 1,
"name": "Моя папка"
}
}
]

Получение данных опросов

Получить сводку опроса

https://api.webask.io/api/service/quiz/{id}/summary get

Результат ответа

{
"status": true,
"summary": {
"all_visited": 150,
"filled_completely": 128,
"started_not_finished": 22,
"completion_rate": 85,
"geography_visits": [
{
"count": 45,
"country": "Россия"
}
],
"visits_devices": [
{
"device": "desktop",
"percent": 65.2
}
],
"all_average_transit_time": "04:18"
}
}

Получить отчет опроса

https://api.webask.io/api/service/quiz/{id}/report post

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

{
"is_complete": true,
"dateFrom": "01.01.2024",
"dateTo": "31.01.2024",
"filled": "completed",
"widgets": [
{
"widget_uuid": "550e8400-e29b-41d4-a716-446655440000",
"type": "choiceSingle",
"operator": "equal",
"value": ["option-uuid-1", "option-uuid-2"]
}
],
"scoreOperator": "greater",
"scoreValue": 80,
"answerCorrect": "correct",
"extraFields": [
{
"name": "field_name",
"value": "field_value"
}
],
"ip": "192.168.1.1",
"country": ["Россия", "Украина"],
"browser": ["Chrome", "Firefox"],
"device": ["desktop", "mobile"],
"tags": ["важный", "требует внимания"]
}

Результат ответа

{
"status": true,
"data": {
"report": [
{
"widget_id": "550e8400-e29b-41d4-a716-446655440000",
"title": "Как вы оцениваете наш сервис?",
"type": "rating",
"count": 150,
"average": 4.2,
"avg_filling_time": 12.5,
"answer_count": 150,
"rowId": "row-123",
"options": "{\"min\":1,\"max\":5,\"step\":1}",
"filtered_data": "{\"1\":5,\"2\":10,\"3\":25,\"4\":60,\"5\":50}"
}
],
"answer_total_count": 150,
"correct_answers": false,
"answer_moderate_count": 5,
"filters": [],
"filters_count": 0,
"answer_hide_count": 3,
"answer_hide_amount": 150.00
}
}

Получить фильтры отчетов

https://api.webask.io/api/service/quiz/{id}/filters/report get

Результат ответа

{
"status": true,
"data": {
"dateFrom": "01.01.2024",
"dateTo": "31.01.2024",
"filled": "completed",
"widgets": [
{
"widget_uuid": "550e8400-e29b-41d4-a716-446655440000",
"type": "choiceSingle",
"operator": "equal",
"value": ["option-uuid-1", "option-uuid-2"]
}
]
}
}

Управление ответами

Скрыть/показать ответ

https://api.webask.io/api/service/quiz/{id}/answer/{answer_id}/hide post

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

{
"is_hide": true
}

Результат ответа

{
"status": true,
"is_hide": true
}

Добавить теги к ответу

https://api.webask.io/api/service/quiz/{id}/answer/{answer_id}/tags post

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

{
"tags": ["важный", "требует внимания", "проблема"]
}

Результат ответа

{
"status": true,
"result": {
"created": [
{
"id": 1,
"name": "важный"
}
],
"attached": [
{
"id": 1,
"name": "важный"
},
{
"id": 2,
"name": "требует внимания"
},
{
"id": 3,
"name": "проблема"
}
],
"detached": [],
"deleted": []
}
}

Коды ошибок

not_found - Ресурс не найден
access_denied - Нет доступа к ресурсу
access_denied_to_folder - Нет доступа к папке
answer_not_found - Ответ не найден
workspace_not_found - Рабочее пространство не найдено
validation_error - Ошибка валидации данных
rate_limit_exceeded - Превышен лимит запросов
unauthorized - Неверный токен авторизации

Мы принимаем предложения по доработке API, свяжитесь с нами

API

Общая информация

Получить список опросов

Получить данные определенного опроса

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

Скрытые переменные

Управление опросами

Получение данных опросов

Управление ответами

Коды ошибок

Читайте также

Не можете найти то, что ищите?

Услуги

Поддержка

Компания

Разделы