🍫Choko.Link User API (1.0.0)

Download OpenAPI specification:Download

За допомогою API для користувачів ти можеш автоматизовано отримувати статистику сторінки та повідомлення з форми, на приклад, для інтеграції з твоєю CRM. Ключ унікальний для кожної сторінки. Обмеження запитів - не більше 1 запиту в 10 секунд.

Формат відповіді

Сервер завжди відповідає HTTP-кодом 200. Всі відповіді загорнуті в наступну структуру:

{
    "ok": Boolean, // Чи успішно виконався запит
    "result": Object | Array | null, // Результат виконання
    "error": String | null // Повідомлення про помилку
}

Статистика

Отримання статистики по сторінці та блоках. Ті самі дані, що відображаються в кабінеті в розділі статистики.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"ok": true,
"result": {"block": {"id": "demo",
"type": "page",
"link": "https://choko.link/demo"
},
"views": [{"label": "2024-07-28",
"labelShort": "28",
"total": 0,
"unique": 0
}
],
"geo": [{"label": "Kyiv, UA",
"count": 156
}
]
},
"error": null
}

Сирі дані відвідувань

Отримання сирих даних про відвідування.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"ok": true,
"result": [{"timestamp": 0,
"url": "https://tiktok.com/@choko.link",
"ip": "93.275.205.27",
"ref": "https://l.instagram.com/"
}
],
"error": null
}

Повідомлення

Тримання повідомлень з форми зворотнього зв'язку. Повертає останні 100 повідомлень

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"ok": true,
"result": [{"id": "ansNyeiBMXbf",
"timestamp": 1592776973,
"message": "string",
"formId": "string",
"formTitle": "string",
"fields": [{"id": "fieldRvD-n6x8-_Vc1q18YUKI2name",
"type": "name",
"required": true,
"value": "Помідор"
}
]
}
],
"error": null
}