
Мова 🇺🇦 Українська
Початок роботи
Документація
Агрегація
Журнали аудиту
Блокування за коментарем
Перевірка заблокованих коментарів
Коментарі
Конфігурації доменів
Шаблони електронних листів
Журнал подій
Пости стрічки
Позначення коментаря
Хештеги
Модератори
Лічильник сповіщень
Сповіщення
Сторінки
Очікувані вебхук-події
Конфігурації питань
Результати питань
Агрегація результатів питань
SSO-користувачі
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Орендарі
Тікети
Завантаження зображення
Прогрес значків користувача
Значки користувача
Сповіщення користувача
Стани присутності користувачів
Пошук користувачів
Користувачі
Голоси
FastComments Python SDK
Це офіційний Python SDK для FastComments.
Офіційний Python SDK для API FastComments
Репозиторій
Встановлення 
PyPI
pip install fastcomments
Зміст бібліотеки
Ця бібліотека містить два модулі: згенерований клієнт API та основну бібліотеку Python, яка містить написані вручну утиліти, що полегшують роботу з API, включно з підтримкою SSO.
Публічні та захищені API
Для клієнта API існує два класи, DefaultApi та PublicApi. DefaultApi містить методи, що вимагають вашого API-ключа, а PublicApi містить виклики API, які можна виконувати безпосередньо з браузера/мобільного пристрою тощо без автентифікації.
Швидкий старт 
Використання автентифікованих API (DefaultApi)
Важливо: Ви повинні встановити свій API-ключ у Configuration перед виконанням автентифікованих запитів. Якщо ви цього не зробите, запити завершаться з помилкою 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Створіть та налаштуйте клієнт API
config = Configuration()
config.host = "https://fastcomments.com/api"
# ОБОВ'ЯЗКОВО: Встановіть свій API-ключ (отримайте його з панелі керування FastComments)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Створіть екземпляр API з налаштованим клієнтом
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Тепер ви можете виконувати автентифіковані виклики API
try:
# Приклад: додати SSO-користувача
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Поширені помилки:
# - 401: API-ключ відсутній або недійсний
# - 400: Перевірка запиту не пройшла
Використання публічних API (PublicApi)
Публічні кінцеві точки не потребують автентифікації:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
Використання SSO (Єдиний вхід)
SDK включає утиліти для генерації захищених SSO токенів:
from sso import FastCommentsSSO, SecureSSOUserData
# Створіть дані користувача
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Створіть екземпляр SSO з вашим секретом API
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Згенеруйте SSO-токен
sso_token = sso.create_token()
# Використайте цей токен у фронтенді або передайте в виклики API
print(f"SSO Token: {sso_token}")
Для простого SSO (менш безпечно, для тестування):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Типові проблеми
- 401 "missing-api-key" error: Переконайтеся, що ви встановили
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}перед створенням екземпляра DefaultApi. - Wrong API class: Використовуйте
DefaultApiдля автентифікованих запитів на боці сервера,PublicApiдля клієнтських/публічних запитів. - Import errors: Переконайтеся, що ви імпортуєте з правильного модуля:
- Клієнт API:
from client import ... - Утиліти SSO:
from sso import ...
- Клієнт API:
Примітки 
Ідентифікатори трансляцій
Ви побачите, що в деяких викликах API потрібно передавати broadcast_id. Коли ви отримуватимете події, ви отримаєте цей ідентифікатор назад, тож знатимете, що слід ігнорувати подію, якщо ви плануєте оптимістично застосовувати зміни на клієнті (а ймовірно саме так ви й захочете зробити, оскільки це забезпечує найкращий досвід). Передавайте сюди UUID. Ідентифікатор має бути достатньо унікальним, щоб не з'явитися двічі в одній сесії браузера.
Вимоги 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
Агрегувати 
Агрегує документи, групуючи їх (якщо надано groupBy) та застосовуючи кілька операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregationResponse
Приклад

Отримати журнали аудиту 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| limit | number | query | Ні | |
| skip | number | query | Ні | |
| order | string | query | Ні | |
| after | number | query | Ні | |
| before | number | query | Ні |
Відповідь
Повертає: GetAuditLogs200Response
Приклад

Заблокувати через коментар (публічно) 
Параметри
| Назва | Тип | Location | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: BlockFromCommentPublic200Response
Приклад

Розблокувати коментар (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UnBlockCommentPublic200Response
Приклад

Перевірені коментарі на блокування 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentIds | string | query | Так | Список ідентифікаторів коментарів, розділених комами. |
| sso | string | query | Ні |
Відповідь
Повертає: CheckedCommentsForBlocked200Response
Приклад

Заблокувати користувача за коментарем 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: BlockFromCommentPublic200Response
Приклад

Створити коментар (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateCommentPublic200Response
Приклад

Видалити коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| isLive | boolean | query | Ні |
Відповідь
Повертає: DeleteComment200Response
Приклад

Видалити коментар (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: DeleteCommentPublic200Response
Приклад

Видалити голос за коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| voteId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: DeleteCommentVote200Response
Приклад

Позначити коментар 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagComment200Response
Приклад

Отримати коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetComment200Response
Приклад

Отримати текст коментаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: GetCommentText200Response
Приклад

Отримати імена користувачів, які голосували за коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| dir | integer | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentVoteUserNames200Response
Приклад

Отримати коментарі 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | integer | query | Ні | |
| limit | integer | query | Ні | |
| skip | integer | query | Ні | |
| asTree | boolean | query | Ні | |
| skipChildren | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні | |
| contextUserId | string | query | Ні | |
| hashTag | string | query | Ні | |
| parentId | string | query | Ні | |
| direction | string | query | Ні |
Відповідь
Повертає: GetComments200Response
Приклад

Отримати коментарі (публічно) 
req tenantId urlId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| page | integer | query | Ні | |
| direction | string | query | Ні | |
| sso | string | query | Ні | |
| skip | integer | query | Ні | |
| skipChildren | integer | query | Ні | |
| limit | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| countChildren | boolean | query | Ні | |
| fetchPageForCommentId | string | query | Ні | |
| includeConfig | boolean | query | Ні | |
| countAll | boolean | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| modules | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeNotificationCount | boolean | query | Ні | |
| asTree | boolean | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| useFullTranslationIds | boolean | query | Ні | |
| parentId | string | query | Ні | |
| searchText | string | query | Ні | |
| hashTags | array | query | Ні | |
| userId | string | query | Ні | |
| customConfigStr | string | query | Ні | |
| afterCommentId | string | query | Ні | |
| beforeCommentId | string | query | Ні |
Відповідь
Повертає: GetCommentsPublic200Response
Приклад

Заблокувати коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: LockComment200Response
Приклад

Закріпити коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: PinComment200Response
Приклад

Зберегти коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: SaveComment200Response
Приклад

Масове збереження коментарів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: SaveComment200Response
Приклад

Встановити текст коментаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetCommentText200Response
Приклад

Розблокувати користувача за коментарем 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: UnBlockCommentPublic200Response
Приклад

Зняти позначку з коментаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagComment200Response
Приклад

Розблокувати коментар 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: LockComment200Response
Приклад

Відкріпити коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: PinComment200Response
Приклад

Оновити коментар 
Parameters
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| isLive | boolean | query | Ні |
Response
Повертає: FlagCommentPublic200Response
Приклад

Проголосувати за коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: VoteComment200Response
Приклад

Додати конфігурацію домену 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddDomainConfig200Response
Приклад

Видалити конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Відповідь
Повертає: DeleteDomainConfig200Response
Приклад

Отримати конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domain | string | path | Так |
Відповідь
Повертає: GetDomainConfig200Response
Приклад

Отримати конфігурації доменів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetDomainConfigs200Response
Приклад

Часткове оновлення конфігурації домену 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domainToUpdate | string | path | Так |
Відповідь
Повертає: GetDomainConfig200Response
Приклад

Замінити конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domainToUpdate | string | path | Так |
Відповідь
Повертає: GetDomainConfig200Response
Приклад

Створити шаблон електронного листа 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateEmailTemplate200Response
Приклад

Видалити шаблон електронного листа 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Видалити помилку рендерингу шаблону листа 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| errorId | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати шаблон електронного листа 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetEmailTemplate200Response
Приклад

Отримати визначення шаблонів електронних листів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: GetEmailTemplateDefinitions200Response
Приклад

Отримати помилки рендерингу шаблонів листів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplateRenderErrors200Response
Приклад

Отримати шаблони електронних листів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplates200Response
Приклад

Відтворити шаблон електронного листа 
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| locale | string | query | Ні |
Відповідь
Повертає: RenderEmailTemplate200Response
Приклад

Оновити шаблон електронного листа 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати журнал подій 
req tenantId urlId userIdWS
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Так |
Відповідь
Повертає: GetEventLog200Response
Приклад

Отримати глобальний журнал подій 
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
Відповідь
Повертає: GetEventLog200Response
Приклад

Створити допис у стрічці 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| broadcastId | string | query | Ні | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| skipDupCheck | boolean | query | Ні |
Відповідь
Повертає: CreateFeedPost200Response
Приклад

Створити допис у стрічці (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateFeedPostPublic200Response
Приклад

Видалити допис у стрічці (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: DeleteFeedPostPublic200Response
Приклад

Отримати пости стрічки 
req tenantId afterId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні |
Відповідь
Повертає: GetFeedPosts200Response
Приклад

Отримати пости стрічки (публічно) 
req tenantId afterId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні | |
| sso | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeUserInfo | boolean | query | Ні |
Відповідь
Повертає: GetFeedPostsPublic200Response
Приклад

Отримати статистику постів стрічки 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetFeedPostsStats200Response
Приклад

Отримати реакції користувача (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserReactsPublic200Response
Приклад

Зреагувати на допис у стрічці (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ReactFeedPostPublic200Response
Приклад

Оновити допис у стрічці 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Оновити допис у стрічці (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateFeedPostPublic200Response
Приклад

Позначити коментар (публічно) 
Параметри
| Name | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| isFlagged | boolean | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Додати хештег 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | No |
Відповідь
Повертає: AddHashTag200Response
Приклад

Масове додавання хештегів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ні |
Відповідь
Повертає: AddHashTagsBulk200Response
Приклад

Видалити хештег 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tag | string | path | Так | |
| tenantId | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати хештеги 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | number | query | Ні |
Відповідь
Повертає: GetHashTags200Response
Приклад

Часткове оновлення хештегу 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tag | string | path | Так | |
| tenantId | string | query | Ні |
Відповідь
Повертає: PatchHashTag200Response
Приклад

Створити модератора 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateModerator200Response
Приклад

Видалити модератора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sendEmail | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати модератора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetModerator200Response
Приклад

Отримати модераторів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetModerators200Response
Приклад

Надіслати запрошення 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| fromName | string | query | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Оновити модератора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Видалити лічильник сповіщень 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати кешований лічильник сповіщень 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetCachedNotificationCount200Response
Приклад

Отримати лічильник сповіщень 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні |
Відповідь
Повертає: GetNotificationCount200Response
Приклад

Отримати сповіщення 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetNotifications200Response
Приклад

Оновити сповіщення 
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Додати сторінку 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddPageAPIResponse
Приклад

Видалити сторінку 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: DeletePageAPIResponse
Приклад

Отримати сторінку за URL-ID 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetPageByURLIdAPIResponse
Приклад

Отримати сторінки 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetPagesAPIResponse
Приклад

Часткове оновлення сторінки 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: PatchPageAPIResponse
Приклад

Видалити очікувану вебхук-подію 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати кількість очікуваних вебхук-подій 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEventCount200Response
Приклад

Отримати очікувані вебхук-події 
Параметри
| Name | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEvents200Response
Приклад

Створити конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateQuestionConfig200Response
Приклад

Видалити конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionConfig200Response
Приклад

Отримати конфігурації питань 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionConfigs200Response
Приклад

Оновити конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Створити результат питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateQuestionResult200Response
Приклад

Видалити результат питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати результат питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionResult200Response
Приклад

Отримати результати питань 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetQuestionResults200Response
Приклад

Оновити результат питання 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Агрегувати результати питань 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| timeBucket | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: AggregateQuestionResults200Response
Приклад

Масова агрегація результатів питань 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: BulkAggregateQuestionResults200Response
Приклад

Поєднати коментарі з результатами питань 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Відповідь
Повертає: CombineCommentsWithQuestionResults200Response
Приклад

Додати SSO-користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | параметр запиту | Так |
Відповідь
Повертає: AddSSOUserAPIResponse
Приклад

Видалити SSO-користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | boolean | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: DeleteSSOUserAPIResponse
Приклад

Отримати SSO-користувача за email 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| string | path | Так |
Відповідь
Повертає: GetSSOUserByEmailAPIResponse
Приклад

Отримати SSO-користувача за ID 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetSSOUserByIdAPIResponse
Приклад

Отримати SSO-користувачів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
Відповідь
Повертає: GetSSOUsers200Response
Приклад

Часткове оновлення SSO-користувача 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Відповідь
Повертає: PatchSSOUserAPIResponse
Приклад

Замінити SSO-користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Відповідь
Повертає: PutSSOUserAPIResponse
Приклад

Створити підписку 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateSubscriptionAPIResponse
Приклад

Видалити підписку 
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: DeleteSubscriptionAPIResponse
Приклад

Отримати підписки 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: GetSubscriptionsAPIResponse
Приклад

Оновити підписку 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: UpdateSubscriptionAPIResponse
Приклад

Отримати щоденне використання орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetTenantDailyUsages200Response
Приклад

Створити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantPackage200Response
Приклад

Видалити пакет орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати пакет орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantPackage200Response
Приклад

Отримати пакети орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantPackages200Response
Приклад

Замінити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Оновити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Створити користувача орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantUser200Response
Приклад

Видалити користувача орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | string | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати користувача орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantUser200Response
Приклад

Отримати користувачів орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantUsers200Response
Приклад

Замінити користувача орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Надіслати посилання для входу 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| redirectURL | string | query | Ні |
Response
Повертає: FlagCommentPublic200Response
Example

Оновити користувача орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Створити орендаря 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Повертає: CreateTenant200Response
Приклад

Видалити орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Отримати орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenant200Response
Приклад

Отримати орендарів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| meta | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenants200Response
Приклад

Оновити орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

Змінити стан тікета 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: ChangeTicketState200Response
Приклад

Створити тікет 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так |
Відповідь
Повертає: CreateTicket200Response
Приклад

Отримати тікет 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: GetTicket200Response
Приклад

Отримати тікети 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| state | number | query | Ні | |
| skip | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: GetTickets200Response
Приклад

Завантажити зображення 
Завантажити та змінити розмір зображення
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| sizePreset | string | query | Ні | Параметр розміру: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | Ні | Ідентифікатор сторінки, з якої відбувається завантаження, для конфігурації |
Відповідь
Повертає: UploadImageResponse
Приклад

Отримати прогрес значка користувача за ID 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetUserBadgeProgressById200Response
Приклад

Отримати прогрес значка користувача за ID користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | path | Так |
Відповідь
Повертає: GetUserBadgeProgressById200Response
Приклад

Отримати список прогресу значків користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetUserBadgeProgressList200Response
Приклад

Створити значок користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateUserBadge200Response
Приклад

Видалити значок користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: UpdateUserBadge200Response
Приклад

Отримати значок користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUserBadge200Response
Приклад

Отримати значки користувача 
Параметри
| Name | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| badgeId | string | query | Ні | |
| type | number | query | Ні | |
| displayedOnComments | boolean | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Response
Повертає: GetUserBadges200Response
Приклад

Оновити значок користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: UpdateUserBadge200Response
Приклад

Отримати лічильник сповіщень користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotificationCount200Response
Приклад

Отримати сповіщення користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: GetUserNotifications200Response
Приклад

Скинути лічильник сповіщень користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotifications200Response
Приклад

Скинути сповіщення користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ResetUserNotifications200Response
Приклад

Оновити статус підписки користувача на коментарі 
Увімкнути або вимкнути сповіщення для певного коментаря.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| notificationId | string | path | Так | |
| optedInOrOut | string | path | Так | |
| commentId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatus200Response
Приклад

Оновити статус підписки користувача на сторінкові сповіщення 
Увімкнення або вимкнення сповіщень для сторінки. Коли користувачі підписані на сторінку, сповіщення створюються для нових кореневих коментарів, а також
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| url | string | query | Так | |
| pageTitle | string | query | Так | |
| subscribedOrUnsubscribed | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatus200Response
Приклад

Оновити статус сповіщення користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| notificationId | string | path | Так | |
| newStatus | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatus200Response
Приклад

Отримати стани присутності користувачів 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Відповідь
Повертає: GetUserPresenceStatuses200Response
Приклад

Пошук користувачів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| usernameStartsWith | string | query | Ні | |
| mentionGroupIds | array | query | Ні | |
| sso | string | query | Ні | |
| searchSection | string | query | Ні |
Відповідь
Повертає: SearchUsers200Response
Приклад

Отримати користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetUser200Response
Приклад

Створити голос 
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Так | |
| direction | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: VoteComment200Response
Приклад

Видалити голос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Відповідь
Повертає: DeleteCommentVote200Response
Приклад

Отримати голоси 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetVotes200Response
Приклад

Отримати голоси для користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: GetVotesForUser200Response
Приклад

Потрібна допомога?
Якщо ви зіткнулися з будь-якими проблемами або маєте питання щодо Python SDK, будь ласка:
Участь
Внески вітаються! Будь ласка, відвідайте репозиторій GitHub для отримання вказівок щодо внесків.