
Мова 🇺🇦 Українська
Початок роботи
Документація
Агрегація
Журнали аудиту
Аутентифікація
Блокування через коментар
Перевірка заблокованих коментарів
Коментарі
Коментарі користувача
Налаштування доменів
Шаблони електронних листів
Журнал подій
Пости стрічки
Позначення коментаря
GIF
Хештеги
Модерація
Модератори
Кількість сповіщень
Сповіщення
Реакції на сторінці
Сторінки
Очікувані події вебхука
Налаштування питань
Результати запитань
Агрегація результатів запитань
Користувачі SSO
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Орендарі
Тікети
Переклади
Завантажити зображення
Прогрес бейджів користувача
Бейджі користувача
Сповіщення користувача
Стани присутності користувача
Пошук користувачів
Користувачі
Голоси
FastComments SDK для Python
Це офіційний Python SDK для FastComments.
Офіційний Python SDK для API FastComments
Репозиторій
Встановлення 
Встановити з GitHub
Встановіть безпосередньо з тегу випуску (рекомендовано, повністю відтворювально):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Закріпіть тег замість гілки, щоб збірки були детерміновані. Така ж форма працює у requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Кожен позначений GitHub Release також має прикріплене зібране wheel, якщо ви віддаєте перевагу встановленню бінарного артефакту безпосередньо.
Вміст бібліотеки
Ця бібліотека містить два модулі: згенерований API‑клієнт та основну Python‑бібліотеку, що містить написані вручну утиліти для спрощення роботи з API, включно з підтримкою SSO.
Публічні та захищені API
Для API‑клієнта існує три класи, DefaultApi, PublicApi та ModerationApi. DefaultApi містить методи, які вимагають ваш API‑ключ, а PublicApi містить методи, які можна викликати безпосередньо з браузера/мобільного пристрою тощо без автентифікації. ModerationApi надає широку сукупність живих та швидких API модерації. Кожен метод ModerationApi приймає параметр sso і може автентифікуватись за допомогою SSO або cookie сесії FastComments.com.
Швидкий старт 
Використання автентифікованих API (DefaultApi)
Important: Ви повинні встановити ваш API-ключ у Configuration перед виконанням автентифікованих запитів. Якщо ви цього не зробите, запити завершаться помилкою 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Створіть та налаштуйте клієнт API
config = Configuration()
config.host = "https://fastcomments.com"
# ОБОВ’ЯЗКОВО: Встановіть ваш API-ключ (отримайте його у вашій панелі FastComments)
config.api_key = {"api_key": "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("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Загальні помилки:
# - 401: API key відсутній або недійсний
# - 400: Перевірка запиту не вдалася
Використання публічних API (PublicApi)
Публічні кінцеві точки не вимагають автентифікації:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Використання панелі модерації (ModerationApi)
ModerationApi забезпечує роботу панелі модератора. Методи викликаються від імені модератора шляхом передачі токена sso:
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Підрахувати коментарі, що очікують модерації
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Використання SSO (Single Sign-On)
SDK включає утиліти для генерування безпечних SSO токенів:
from sso import FastCommentsSSO, SecureSSOUserData
# Створити дані користувача (id, email та username обов’язкові)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Підписати його вашим API секретом (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Згенерувати SSO токен для передачі у віджет або API виклик
sso_token = sso.create_token()
# Використовуйте цей токен у вашому фронтенді або передайте у API виклики
print(f"SSO Token: {sso_token}")
Для простого SSO (менш безпечного, для тестування):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Поширені проблеми
- 401 "missing-api-key" error: Переконайтеся, що ви встановили
config.api_key = {"api_key": "YOUR_KEY"}перед створенням екземпляра DefaultApi. - Wrong API class: Використовуйте
DefaultApiдля серверних автентифікованих запитів,PublicApiдля клієнтських/публічних запитів, таModerationApiдля запитів панелі модератора. - Import errors: Переконайтеся, що ви імпортуєте з правильного модуля:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
Примітки 
Ідентифікатори трансляцій
Ви побачите, що в деяких викликах API потрібно передавати broadcast_id. Коли ви отримуватимете події, ви отримаєте цей ідентифікатор назад, тож знатимете, що слід ігнорувати подію, якщо ви плануєте оптимістично застосовувати зміни на клієнті (а ймовірно саме так ви й захочете зробити, оскільки це забезпечує найкращий досвід). Передавайте сюди UUID. Ідентифікатор має бути достатньо унікальним, щоб не з'явитися двічі в одній сесії браузера.
Вимоги 
- Python >= 3.8
Базова установка є чистою стандартною бібліотекою та надає утиліти SSO. Згенерований API‑клієнт (DefaultApi/PublicApi/ModerationApi) потребує додаткового пакету client, який завантажує urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 та typing-extensions >= 4.0.0:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"
aggregate 
Агрегує документи шляхом їх групування (якщо вказано groupBy) та застосування кількох операцій.
Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregateResponse
Приклад

get_audit_logs 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Відповідь
Returns: GetAuditLogsResponse
Приклад

logout_public 
Response
Повертає: APIEmptyResponse
Example

block_from_comment_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: BlockSuccess
Приклад

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

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

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

create_comment_public 
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: SaveCommentsResponseWithPresence
Example

delete_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Відповідь
Повертає: DeleteCommentResult
Приклад

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

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

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

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

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

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

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

get_comments_public 
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 | Ні |
Відповідь
Повертає: GetCommentsResponseWithPresencePublicComment
Приклад

lock_comment 
Параметри
| Назва | Type | Location | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

save_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Відповідь
Повертає: APISaveCommentResponse
Приклад

save_comments_bulk 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Відповідь
Повертає: SaveCommentsBulkResponse
Приклад

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

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

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

un_lock_comment 
Параметри
| Назва | Тип | Location | Required | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

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

vote_comment 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: VoteResponse
Приклад

get_comments_for_user 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| userId | string | query | Ні | |
| direction | string | query | Ні | |
| repliesToUserId | string | query | Ні | |
| page | number | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| isCrawler | boolean | query | Ні |
Відповідь
Повертає: GetCommentsForUserResponse
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_event_log 
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

get_global_event_log 
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

create_feed_post 
Parameters
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | запит | Так | |
| broadcastId | string | запит | Ні | |
| isLive | boolean | запит | Ні | |
| doSpamCheck | boolean | запит | Ні | |
| skipDupCheck | boolean | запит | Ні |
Відповідь
Повертає: CreateFeedPostsResponse
Приклад

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

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

get_feed_posts 
req tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні |
Відповідь
Повертає: GetFeedPostsResponse
Приклад

get_feed_posts_public 
req tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Відповідь
Повертає: PublicFeedPostsResponse
Приклад

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

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

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

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

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

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

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

get_gifs_search 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| search | string | query | Так | |
| locale | string | query | Ні | |
| rating | string | query | Ні | |
| page | number | query | Ні |
Відповідь
Повертає: GetGifsSearchResponse
Приклад

get_gifs_trending 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| locale | string | query | Ні | |
| rating | string | query | Ні | |
| page | number | query | Ні |
Відповідь
Повертає: GetGifsTrendingResponse
Приклад

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

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

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

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

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

delete_moderation_vote 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: VoteDeleteResponse
Приклад

get_api_comments 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | number | query | Ні | |
| count | number | query | Ні | |
| text-search | string | query | Ні | |
| byIPFromComment | string | query | Ні | |
| filters | string | query | Ні | |
| searchFilters | string | query | Ні | |
| sorts | string | query | Ні | |
| demo | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPIGetCommentsResponse
Приклад

get_api_export_status 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationExportStatusResponse
Приклад

get_api_ids 
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| text-search | string | query | Ні | |
| byIPFromComment | string | query | Ні | |
| filters | string | query | Ні | |
| searchFilters | string | query | Ні | |
| afterId | string | query | Ні | |
| demo | boolean | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: ModerationAPIGetCommentIdsResponse
Приклад

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

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

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

get_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPICountCommentsResponse
Приклад

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

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

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

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

get_moderation_comment 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPICommentResponse
Приклад

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

get_pre_ban_summary 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PreBanSummary
Приклад

get_search_comments_summary 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationCommentSearchResponse
Приклад

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

get_search_sites 
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Returns: ModerationSiteSearchResponse
Приклад

get_search_suggest 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| text-search | string | query | Ні | |
| sgo | string | query | Ні |
Відповідь
Повертає: ModerationSuggestResponse
Приклад

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

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

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

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

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

post_api_export 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationExportResponse
Приклад

post_ban_user_from_comment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: BanUserFromCommentResult
Приклад

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

post_bulk_pre_ban_summary 
Параметри
| Назва | Тип | Локація | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: BulkPreBanSummary
Приклад

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

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

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

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

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

post_set_comment_review_status 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example

post_set_comment_spam_status 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

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

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

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

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

put_remove_badge 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: RemoveUserBadgeResponse
Приклад

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

set_trust_factor 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| trustFactor | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetUserTrustFactorResponse
Приклад

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

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

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

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

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

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

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

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

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

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

update_notification 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Response
Повертає: APIEmptyResponse
Example

create_v1_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| title | string | query | Ні |
Відповідь
Повертає: CreateV1PageReact
Приклад

create_v2_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| id | string | query | Так | |
| title | string | query | Ні |
Відповідь
Повертає: CreateV1PageReact
Приклад

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

delete_v2_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Response
Повертає: CreateV1PageReact
Example

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

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

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

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

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

get_offline_users 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | Ідентифікатор URL сторінки (очищений на сервері). |
| afterName | string | query | Ні | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | Ні | Тай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли встановлено afterName, щоб уникнути пропуску записів через однакові імена. |
Відповідь
Returns: PageUsersOfflineResponse
Приклад

get_online_users 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищений на боці сервера). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Тай-брейкер курсору: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли встановлено afterName, щоб уникнути втрати записів через однакові імена. |
Response
Повертає: PageUsersOnlineResponse
Example

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

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

get_pages_public 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| cursor | string | query | Ні | Непрозорий курсор пагінації, повернутий як nextCursor у попередньому запиті. Прив'язаний до того ж sortBy. |
| limit | integer | query | Ні | 1..200, за замовчуванням 50 |
| q | string | query | Ні | Необов'язковий нечутливий до регістру фільтр префіксу назви. |
| sortBy | string | query | Ні | Порядок сортування. updatedAt (за замовчуванням, новіші першими), commentCount (найбільше коментарів спочатку), або title (за алфавітом). |
| hasComments | boolean | query | Ні | Якщо true, повертаються лише сторінки з принаймні одним коментарем. |
Відповідь
Повертає: GetPublicPagesResponse
Приклад

get_users_info 
Масова інформація про користувачів для тенанта. За заданими userIds повертає відображувану інформацію з User / SSOUser. Використовується віджетом коментарів для доповнення інформації про користувачів, які щойно з’явилися через подію присутності. Без контексту сторінки: конфіденційність застосовується однаково (приватні профілі маскуються).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds, розділені комами. |
Відповідь
Повертає: PageUsersInfoResponse
Приклад

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

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

get_pending_webhook_event_count 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Відповідь
Повертає: GetPendingWebhookEventCountResponse
Приклад

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

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

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

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

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

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

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

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

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

get_question_results 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: GetQuestionResultsResponse
Приклад

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

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

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

combine_comments_with_question_results 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: CombineQuestionResultsWithCommentsResponse
Приклад

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

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

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

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

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

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

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

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

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

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

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

get_tenant_daily_usages 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Відповідь
Returns: GetTenantDailyUsagesResponse
Приклад

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

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

get_tenant_package 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Повертає: GetTenantPackageResponse
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_translations 
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Відповідь
Повертає: GetTranslationsResponse
Приклад

upload_image 
Завантаження та зміна розміру зображення
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| sizePreset | string | query | Ні | Попередньо визначений розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | Ні | Ідентифікатор сторінки, з якої відбувається завантаження, для налаштування |
Відповідь
Повертає: UploadImageResponse
Приклад

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

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

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

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

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

get_user_badge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Повертає: APIGetUserBadgeResponse
Example

get_user_badges 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Відповідь
Повертає: APIGetUserBadgesResponse
Приклад

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

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

get_user_notifications 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Використовується для визначення, чи підписана поточна сторінка. |
| 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 | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: GetMyNotificationsResponse
Приклад

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

reset_user_notifications 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

update_user_notification_comment_subscription_status 
Увімкнути або вимкнути сповіщення для певного коментаря.
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| notificationId | string | path | Так | |
| optedInOrOut | string | path | Так | |
| commentId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse
Приклад

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

update_user_notification_status 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| notificationId | string | path | Так | |
| newStatus | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatusResponse
Приклад

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

search_users 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| usernameStartsWith | string | query | Ні | |
| mentionGroupIds | array | query | Ні | |
| sso | string | query | Ні | |
| searchSection | string | query | Ні |
Response
Повертає: SearchUsersResult
Example

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

create_vote 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Повертає: VoteResponse
Приклад

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

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

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

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