
Мова 🇺🇦 Українська
Документація
Агрегат
Журнали аудиту
Аутентифікація
Блокування з коментаря
Перевірка заблокованих коментарів
Коментарі
Коментарі для користувача
Конфігурації домену
Шаблони електронної пошти
Журнал подій
Пости у стрічці
Позначити коментар
GIF
Хештеги
Модерація
Модератори
Кількість сповіщень
Сповіщення
Реакції на сторінці
Сторінки
Очікуючі події вебхука
Конфігурації питань
Результати питань
Агрегація результатів питань
Користувачі SSO
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Tenant Users
Tenants
Tickets
Translations
Upload Image
User Badge Progress
User Badges
Сповіщення користувача
Спощення користувача
Сповіщення користючих
User Notifications
User Presence Status
User Search
Users
Votes
FastComments Dart SDK
This is the official Dart SDK for FastComments.
Manage comments, users, SSO, and moderation from your Dart and Flutter applications.
Repository
AI агенти кодування 
Надайте вашому кодовому агенту контекст FastComments, який йому потрібен — віджети, конфігурація, Secure SSO, REST API та SDK:
npx skills add fastcomments/skills
Працює з Claude Code, Codex, Cursor, Copilot, Gemini та будь‑яким іншим агентом, який підтримує skills CLI.
Макет 
fastcomments-dart/
client/ згенерований dart‑клієнт (не редагуйте вручну)
sso/ ручно написані допоміжні засоби токенів SSO
openapi.json збережена копія специфікації, що використовується для генерації
config.json конфігурація openapi-generator
update.py перегенерувати клієнт зі специфікації
Використання 
dependencies:
fastcomments_dart: ^3.0.0
Помічники SSO включені в пакет (package:fastcomments_dart/sso/...).
Клієнт надає три класи API:
DefaultApi- методи, автентифіковані API-ключем, для використання на сервері.PublicApi- публічні методи, які не потребують API-ключа, безпечні для браузера та мобільних клієнтів.ModerationApi- обширний набір живих та швидких API модерації. Кожен методModerationApiприймає параметрssoі може автентифікуватися через SSO або cookie сесії FastComments.com.
import 'package:fastcomments_dart/api.dart';
final api = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final comments = await api.getCommentsPublic('YOUR_TENANT_ID', 'YOUR_URL_ID');import 'package:fastcomments_dart/api.dart';
final publicApi = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final feedPosts = await publicApi.getFeedPostsPublic('YOUR_TENANT_ID');import 'package:fastcomments_dart/api.dart';
final moderation = ModerationApi(ApiClient(basePath: 'https://fastcomments.com'));
final result = await moderation.getApiComments(
GetApiCommentsOptions(sso: 'SSO_TOKEN'),
);
SSO 
import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';
final sso = FastCommentsSSO.secure(
apiKey: 'YOUR_API_SECRET',
user: SecureSSOUserData(
id: 'user-123',
email: 'jane@example.com',
username: 'jane',
avatar: 'https://example.com/jane.png',
),
);
final token = sso.prepareToSend();
агрегат 
Агрегує документи, групуючи їх (якщо передано groupBy) і застосовуючи кілька операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregateResponse
Приклад

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

logoutPublic 
Відповідь
Повертає: APIEmptyResponse
Приклад

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

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

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

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

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

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

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

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

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

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

getComments 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

getCommentsPublic 
req tenantId urlId
Параметри
| Назва | Тип | Location | Обов'язковий | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getEmailTemplateRenderErrors 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| skip | number | query | Ні |
Response
Повертає: GetEmailTemplateRenderErrorsResponse
Example

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

renderEmailTemplate 
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| locale | string | query | Ні |
Response
Повертає: RenderEmailTemplateResponse
Приклад

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

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

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

createFeedPost 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Response
Повертає: CreateFeedPostsResponse
Example

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

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

getFeedPosts 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні |
Response
Повертає: GetFeedPostsResponse
Example

getFeedPostsPublic 
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
Приклад

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

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

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

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

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

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

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

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

getGifsTrending 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Response
Повертає: GetGifsTrendingResponse
Example

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

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

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

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

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

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

getApiComments 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

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

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

getCount 
Параметри
| 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
Приклад

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

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

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

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

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

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

getPreBanSummary 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

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

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Response
Returns: ModerationUserSearchResponse
Example

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

getUserBanPreference 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Response
Повертає: APIModerateGetUserBanPreferencesResponse
Example

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

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

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

postBanUserFromComment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

postBulkPreBanSummary 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| includeByUserIdAndEmail | boolean | query | Ні | |
| includeByIP | boolean | query | Ні | |
| includeByEmailDomain | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: BulkPreBanSummary
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

putRemoveBadge 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

deleteModerator 
Parameters
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sendEmail | string | query | No |
Response
Повертає: APIEmptyResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getOfflineUsers 
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 | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищений на сервері). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Тай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Обов'язково, коли afterName встановлено, щоб уникнути втрати записів через однакові імена. |
Відповідь
Повертає: PageUsersOfflineResponse
Приклад

getOnlineUsers 
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищений на сервері). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Тай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлено, щоб уникнути пропуску записів через однакові імена. |
Response
Returns: PageUsersOnlineResponse
Example

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

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

getPagesPublic 
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.
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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, повертаються лише сторінки, що мають хоча б один коментар. |
Response
Повертає: GetPublicPagesResponse
Example

getUsersInfo 
Масова інформація про користувачів для орендаря. За заданими userIds повертає відображувану інформацію з User / SSOUser.
Використовується віджетом коментарів для збагачення користувачів, які щойно з’явились через подію присутності.
Немає контексту сторінки: конфіденційність застосовується однорідно (приватні профілі маскуються).
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| ids | string | query | Так | Кома-розділені userIds. |
Response
Повертає: PageUsersInfoResponse
Example

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

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

getPendingWebhookEventCount 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Приклад

getPendingWebhookEvents 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | |
| skip | number | query | No |
Відповідь
Повертає: GetPendingWebhookEventsResponse
Приклад

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

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

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

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

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

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

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

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

getQuestionResults 
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| startDate | string | query | Ні | |
| questionId | string | query | Ні | |
| questionIds | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionResultsResponse
Приклад

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

aggregateQuestionResults 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Відповідь
Returns: AggregateQuestionResultsResponse
Приклад

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

combineCommentsWithQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

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

getSSOUsers 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | integer | query | Ні |
Response
Повертає: GetSSOUsersResponse
Example

patchSSOUser 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Response
Повертає: PatchSSOUserAPIResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getUserBadges 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

getUserNotifications 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

resetUserNotifications 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| afterCreatedAt | integer | query | Ні | |
| unreadOnly | boolean | query | Ні | |
| dmOnly | boolean | query | Ні | |
| noDm | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

updateUserNotificationCommentSubscriptionStatus 
Enable or disable notifications for a specific comment.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Response
Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse
Приклад

updateUserNotificationPageSubscriptionStatus 
Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Повертає: UpdateUserNotificationPageSubscriptionStatusResponse
Example

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

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

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

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

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

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

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

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

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