FastComments JavaScript/TypeScript SDK

Це офіційний SDK JavaScript/TypeScript для FastComments.

Офіційний SDK JavaScript/TypeScript для API FastComments

Репозиторій

Встановлення

npm install fastcomments-sdk

Документація API

Повна документація API: docs/api/README.md

Сумісність браузера та сервера

Цей SDK використовує подвійні точки входу, щоб забезпечити оптимальну сумісність і запобігти помилкам під час виконання:

fastcomments-sdk/browser - Безпечна для браузера версія з нативним fetch
fastcomments-sdk/server - Повна версія для Node.js з підтримкою SSO
fastcomments-sdk (за замовчуванням) - Лише типи, безпечно імпортувати будь-куди

Використання

Цей SDK надає окремі точки входу для середовищ браузера та сервера, щоб забезпечити оптимальну сумісність і безпеку:

Використання в браузері (клієнтська сторона)

Для браузерних/фронтенд-застосунків використовуйте браузерний експорт без залежностей від Node.js:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Використання на сервері (Node.js)

Для серверних/бекенд-застосунків використовуйте повний SDK зі SSO та функціями аутентифікації:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Імпорт тільки типів

Якщо вам потрібні лише типи TypeScript (без виконуваного коду), використовуйте стандартний імпорт:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Використання окремих класів API

Середовище браузера

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

Середовище сервера

import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key',
  basePath: 'https://fastcomments.com'
});

const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);

Публічні та захищені API

SDK надає три основні API-класи:

DefaultApi - Захищені кінцеві точки, які вимагають вашого API-ключа для автентифікації. Використовуйте їх для серверних операцій.
PublicApi - Публічні кінцеві точки, до яких можна отримати доступ без API-ключа. Їх можна викликати безпосередньо з браузерів/мобільних пристроїв тощо.
HiddenApi - Внутрішні/адміністративні кінцеві точки для просунутих сценаріїв використання.

Приклад: Використання Public API (безпечне для браузера)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Отримати коментарі для сторінки (API-ключ не потрібен)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Приклад: Використання Default API (лише на сервері)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // Тримайте це в секреті!
});
const defaultApi = new DefaultApi(config);

// Отримати коментарі з повним адміністративним доступом
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Інтеграція SSO (єдиний вхід)

FastComments підтримує SSO для інтеграції з вашою існуючою системою аутентифікації користувачів. Функціональність SSO доступна лише у серверному експорті, оскільки вона вимагає можливостей Node.js crypto.

Просте SSO (тільки на сервері)

Прості SSO-токени мають генеруватися на сервері та передаватися клієнту:

// Серверний код (Node.js/бекенд)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Створити просте SSO за допомогою вбудованого помічника  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// Відправте ssoToken у ваш клієнтський код
// Клієнтський код потім може використати цей токен з браузерним SDK

Безпечне SSO (серверна сторона, рекомендовано)

Безпечне SSO слід реалізовувати на сервері — воно забезпечує кращий рівень безпеки:

// Серверний код (Node.js/бекенд)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Створити безпечне SSO за допомогою вбудованого помічника
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// Використання з викликами API на сервері
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Або відправте ssoConfig клієнту для використання в браузері

Використання SSO з браузера (з токеном, згенерованим на сервері)

// Клієнтський код (браузер)
import { PublicApi } from 'fastcomments-sdk/browser';

// Отримати SSO токен з вашого серверного endpoint
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Використайте SSO токен, згенерований на сервері
});

SSO зі створенням коментаря

// На сервері: створити SSO і коментар
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Поширені випадки використання

Отримання коментарів для сторінки

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Створення коментаря

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Голосування за коментар

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 — за, -1 — проти
  }
});

Управління користувачами (потребує API-ключа)

// Пошук користувачів (потребує DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Живі події (оновлення в реальному часі)

Підписуйтеся на події в реальному часі, щоб отримувати оновлення щодо коментарів, голосів та інших дій.

Події на рівні сторінки

Слухайте події в реальному часі для конкретної сторінки (коментарі, голоси тощо):

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Підписатися на живі події для сторінки
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (отримайте це з відповіді getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Оновіть ваш інтерфейс користувача новим коментарем
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Оновіть підрахунок голосів у вашому інтерфейсі
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Поверніть true, якщо подію оброблено
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

Підписка на події користувача

Слухайте події, специфічні для користувача (сповіщення, згадки тощо):

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Отримайте це з відповіді getComments
};

// Підписка на персональну стрічку користувача
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Показати сповіщення у вашому інтерфейсі
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }

    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Закрийте, коли закінчите
userSubscription.close();

Отримання userIdWS

Параметр userIdWS потрібен для живих подій і може бути отриманий з відповідей API:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Витягніть userIdWS з відповіді
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Тепер ви можете підписатися на живі події
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

ID трансляцій

Ви побачите, що потрібно передавати broadcastId у деяких викликах API. Коли ви отримуватимете події, ви отримаєте назад цей ID, тож знатимете, що ігнорувати подію, якщо плануєте оптимістично застосовувати зміни на клієнті (а саме так, ймовірно, і варто робити, оскільки це забезпечує найкращий досвід). Передайте сюди UUID. ID повинен бути достатньо унікальним, щоб не повторюватися двічі в одній сесії браузера.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // Унікальний ідентифікатор для цієї операції
  }
});

Обробка помилок

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

Агрегувати

Агрегує документи, групуючи їх (якщо вказано groupBy) та застосовуючи кілька операцій. Підтримуються різні операції (наприклад sum, countDistinct, avg тощо).

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
aggregationRequest	AggregationRequest	Так
parentTenantId	string	Ні
includeStats	boolean	Ні

Відповідь

Повертає: AggregationResponse

Отримати журнали аудиту

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
limit	number	Ні
skip	number	Ні
order	SORTDIR	Ні
after	number	Ні
before	number	Ні

Відповідь

Повертає: GetAuditLogs200Response

Приклад

Приклад getAuditLogs

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_9b8f6c';
  const limit: number = 50;
  const skip: number = 0;
  const order: SORTDIR = 'desc';
  const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000;
  const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after);
  console.log(response);
}
main();

Заблокувати через публічний коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
publicBlockFromCommentParams	PublicBlockFromCommentParams	Так
sso	string	Ні

Відповідь

Повертає: BlockFromCommentPublic200Response

Приклад

blockFromCommentPublic Приклад

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

Розблокувати публічний коментар

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
commentId	string	Так
publicBlockFromCommentParams	PublicBlockFromCommentParams	Так
sso	string	Ні

Відповідь

Повертає: UnBlockCommentPublic200Response

Приклад

unBlockCommentPublic Приклад

Copy

const tenantId: string = 'tenant_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

Перевірені коментарі на блокування

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentIds	string	Так
sso	string	Ні

Відповідь

Повертає: CheckedCommentsForBlocked200Response

Приклад

Приклад checkedCommentsForBlocked

Copy

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

Заблокувати користувача через коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
blockFromCommentParams	BlockFromCommentParams	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: BlockFromCommentPublic200Response

Приклад

Приклад blockUserFromComment

Copy

const tenantId: string = "tenant_12345";
const id: string = "comment_67890";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated abusive language",
  blockDurationHours: 168,
  blockReplies: true,
  notifyAuthor: true
};
const userId: string = "user_abc123";
const anonUserId: string = "anon_xyz789";
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

Створити публічний коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlId	string	Так
broadcastId	string	Так
commentData	CommentData	Так
sessionId	string	Ні
sso	string	Ні

Відповідь

Повертає: CreateCommentPublic200Response

Приклад

Приклад createCommentPublic

Copy

const tenantId: string = 'tenant_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

Видалити коментар

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
contextUserId	string	Ні
isLive	boolean	Ні

Відповідь

Повертає: DeleteComment200Response

Приклад

Приклад deleteComment

Copy

const tenantId: string = 'tenant_7b3f2a';
const commentId: string = 'cmt_8a1f4d2b';
const contextUserId: string = 'user_102';
const isLive: boolean = true;
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

Видалити публічний коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Відповідь

Повертає: DeleteCommentPublic200Response

Приклад

deleteCommentPublic Приклад

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(
  tenantId,
  commentId,
  broadcastId,
  editKey,
  sso
);

Видалити голос за коментар

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
commentId	string	Так
voteId	string	Так
urlId	string	Так
broadcastId	string	Так
editKey	string	Ні
sso	string	Ні

Відповідь

Повертає: DeleteCommentVote200Response

Приклад

Приклад deleteCommentVote

Copy

const tenantId: string = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: DeleteCommentVote200Response = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  sso
);

Позначити коментар

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: FlagComment200Response

Приклад

Приклад flagComment

Copy

const tenantId: string = 'tenant_acme_001';
const id: string = 'comment_7f3a2b9e';
const userId: string = 'user_jdoe_1001';
const anonUserId: string = 'anon_3f2b_visitor';
const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

Отримати коментар

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetComment200Response

Приклад

Приклад getComment

Copy

const tenantId: string = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

Отримати коментарі

Параметри

Name	Type	Required
tenantId	string	Так
page	number	Ні
limit	number	Ні
skip	number	Ні
asTree	boolean	Ні
skipChildren	number	Ні
limitChildren	number	Ні
maxTreeDepth	number	Ні
urlId	string	Ні
userId	string	Ні
anonUserId	string	Ні
contextUserId	string	Ні
hashTag	string	Ні
parentId	string	Ні
direction	SortDirections	Ні

Відповідь

Повертає: GetComments200Response

Приклад

Приклад getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // page
  20, // limit
  0, // skip
  true, // asTree
  1, // skipChildren
  3, // limitChildren
  4, // maxTreeDepth
  'articles/2026/new-product-launch', // urlId
  'user_7890', // userId
  'anon_4f3b2', // anonUserId
  undefined, // contextUserId
  '#launch', // hashTag
  undefined // parentId
);

Отримати публічні коментарі

req tenantId urlId

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlId	string	Так
page	number	Ні
direction	SortDirections	Ні
sso	string	Ні
skip	number	Ні
skipChildren	number	Ні
limit	number	Ні
limitChildren	number	Ні
countChildren	boolean	Ні
fetchPageForCommentId	string	Ні
includeConfig	boolean	Ні
countAll	boolean	Ні
includei10n	boolean	Ні
locale	string	Ні
modules	string	Ні
isCrawler	boolean	Ні
includeNotificationCount	boolean	Ні
asTree	boolean	Ні
maxTreeDepth	number	Ні
useFullTranslationIds	boolean	Ні
parentId	string	Ні
searchText	string	Ні
hashTags	Array	Ні
userId	string	Ні
customConfigStr	string	Ні
afterCommentId	string	Ні
beforeCommentId	string	Ні

Відповідь

Повертає: GetCommentsPublic200Response

Приклад

Приклад getCommentsPublic

Copy

const tenantId: string = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

Отримати текст коментаря

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
editKey	string	Ні
sso	string	Ні

Відповідь

Повертає: GetCommentText200Response

Приклад

Приклад getCommentText

Copy

const tenantId: string = 'tenant_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

Отримати імена користувачів, що голосували за коментар

Параметри

Назва	Type	Обов'язково
tenantId	string	Так
commentId	string	Так
dir	number	Так
sso	string	Ні

Відповідь

Повертає: GetCommentVoteUserNames200Response

Приклад

Приклад getCommentVoteUserNames

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

Заблокувати коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: LockComment200Response

Приклад

Приклад lockComment

Copy

const tenantId: string = "tenant_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

Закріпити коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: PinComment200Response

Приклад

Приклад pinComment

Copy

const tenantId: string = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

Зберегти коментар

Параметри

Name	Type	Required
tenantId	string	Так
createCommentParams	CreateCommentParams	Так
isLive	boolean	Ні
doSpamCheck	boolean	Ні
sendEmails	boolean	Ні
populateNotifications	boolean	Ні

Відповідь

Повертає: SaveComment200Response

Приклад

Приклад saveComment

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

Масове збереження коментарів

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Відповідь

Повертає: Array<SaveComment200Response

Приклад

Приклад saveCommentsBulk

Copy

const tenantId: string = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

Встановити текст коментаря

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
commentTextUpdateRequest	CommentTextUpdateRequest	Так
editKey	string	Ні
sso	string	Ні

Відповідь

Повертає: SetCommentText200Response

Приклад

Приклад setCommentText

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

Розблокувати користувача через коментар

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
unBlockFromCommentParams	UnBlockFromCommentParams	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: UnBlockCommentPublic200Response

Приклад

Приклад unBlockUserFromComment

Copy

const tenantId: string = 'tenant_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

Зняти позначку з коментаря

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: FlagComment200Response

Приклад

Приклад unFlagComment

Copy

const tenantId: string = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

Розблокувати коментар

Параметри

Name	Type	Required
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: LockComment200Response

Приклад

unLockComment Приклад

Copy

const tenantId: string = 'tenant_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

Відкріпити коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
broadcastId	string	Так
sso	string	Ні

Відповідь

Повертає: PinComment200Response

Приклад

Приклад unPinComment

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

Оновити коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updatableCommentParams	UpdatableCommentParams	Так
contextUserId	string	Ні
doSpamCheck	boolean	Ні
isLive	boolean	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateComment

Copy

const tenantId: string = "tenant_acme_corp_01";
const id: string = "comment_20260325_4592";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",
  editedByUserId: "user_8721",
  isVisible: true
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

Проголосувати за коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
urlId	string	Так
broadcastId	string	Так
voteBodyParams	VoteBodyParams	Так
sessionId	string	Ні
sso	string	Ні

Відповідь

Повертає: VoteComment200Response

Приклад

Приклад voteComment

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

Додати конфігурацію домену

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
addDomainConfigParams	AddDomainConfigParams	Так

Відповідь

Повертає: AddDomainConfig200Response

Видалити конфігурацію домену

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
domain	string	Так

Відповідь

Повертає: DeleteDomainConfig200Response

Отримати конфігурацію домену

Параметри

Назва	Тип	Обов'язкове	Опис
tenantId	string	Так
domain	string	Так

Відповідь

Повертає: GetDomainConfig200Response

Отримати конфігурації доменів

Параметри

Назва	Тип	Обов'язкове	Опис
tenantId	string	Так

Відповідь

Повертає: GetDomainConfigs200Response

Частково оновити конфігурацію домену

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
domainToUpdate	string	Так
patchDomainConfigParams	PatchDomainConfigParams	Так

Відповідь

Повертає: GetDomainConfig200Response

Замінити конфігурацію домену

Параметри

Назва	Тип	Обов'язкове
tenantId	string	Так
domainToUpdate	string	Так
updateDomainConfigParams	UpdateDomainConfigParams	Так

Відповідь

Повертає: GetDomainConfig200Response

Створити шаблон електронного листа

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createEmailTemplateBody	CreateEmailTemplateBody	Так

Відповідь

Повертає: CreateEmailTemplate200Response

Приклад

Приклад createEmailTemplate

Copy

const tenantId: string = "tenant_7a9f3c2b";
const customConfig: CustomConfigParameters = { smtpHost: "smtp.fastmail.com", smtpPort: 587, useTLS: true };
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Account Notification",
  subject: "Your ACME account was updated",
  fromEmail: "no-reply@acme-corp.com",
  replyTo: "support@acme-corp.com",
  html: "<p>Hi {{user.firstName}}, your account settings were changed.</p>",
  text: "Hi {{user.firstName}}, your account settings were changed.",
  isActive: true,
  description: "Used for transactional account update emails",
  customConfig
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

Видалити шаблон електронного листа

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteEmailTemplate

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // приклад необов'язкового параметра
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

Видалити помилку рендерингу шаблону листа

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
errorId	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteEmailTemplateRenderError

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // необов'язковий селектор середовища
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

Отримати шаблон електронного листа

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetEmailTemplate200Response

Приклад

Приклад getEmailTemplate

Copy

const tenantId: string = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

Отримати визначення шаблонів листів

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так

Відповідь

Повертає: GetEmailTemplateDefinitions200Response

Приклад

Приклад getEmailTemplateDefinitions

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

Отримати помилки рендерингу шаблонів листів

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
skip	number	Ні

Відповідь

Повертає: GetEmailTemplateRenderErrors200Response

Приклад

Приклад getEmailTemplateRenderErrors

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

Отримати шаблони електронних листів

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Yes
skip	number	No

Відповідь

Повертає: GetEmailTemplates200Response

Приклад

Приклад getEmailTemplates

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

Згенерувати шаблон електронного листа

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
renderEmailTemplateBody	RenderEmailTemplateBody	Так
locale	string	Ні

Відповідь

Повертає: RenderEmailTemplate200Response

Приклад

Приклад renderEmailTemplate

Copy

const tenantId: string = 'tenant_b6f3c2';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'comment-notification',
  recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },
  context: {
    siteName: 'City Gazette',
    commentText: 'Thanks for the in-depth coverage — very helpful.',
    articleTitle: 'Downtown Redevelopment Plan Advances',
    threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'
  }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

Оновити шаблон електронного листа

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
updateEmailTemplateBody	UpdateEmailTemplateBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateEmailTemplate

Copy

const tenantId: string = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

Отримати журнал подій

req tenantId urlId userIdWS

Параметри

Name	Type	Required
tenantId	string	Так
urlId	string	Так
userIdWS	string	Так
startTime	number	Так
endTime	number	Так

Відповідь

Повертає: GetEventLog200Response

Приклад

Приклад getEventLog

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // необов'язкове вхідне значення
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

Отримати глобальний журнал подій

req tenantId urlId userIdWS

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlId	string	Так
userIdWS	string	Так
startTime	number	Так
endTime	number	Так

Відповідь

Повертає: GetEventLog200Response

Приклад

Приклад getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 днів тому
const endTimeOptional: number | undefined = undefined; // необов'язковий кінець інтервалу
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

Створити запис стрічки

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Так
createFeedPostParams	CreateFeedPostParams	Так
broadcastId	string	Ні
isLive	boolean	Ні
doSpamCheck	boolean	Ні
skipDupCheck	boolean	Ні

Відповідь

Повертає: CreateFeedPost200Response

Приклад

Приклад createFeedPost

Copy

const tenantId: string = "tenant_7f3b9a";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — March 2026",
  body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",
  authorId: "user_86fa2b",
  allowComments: true,
  media: [
    {
      url: "https://cdn.example.com/images/update-march.png",
      mimeType: "image/png",
      caption: "Performance graph",
      assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]
    }
  ],
  links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]
};
const broadcastId: string = "broadcast_prod_updates_202603";
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

Створити публічний запис стрічки

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
createFeedPostParams	CreateFeedPostParams	Так
broadcastId	string	Ні
sso	string	Ні

Відповідь

Повертає: CreateFeedPostPublic200Response

Приклад

Приклад createFeedPostPublic

Copy

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

Видалити публічний запис стрічки

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
postId	string	Так
broadcastId	string	Ні
sso	string	Ні

Відповідь

Повертає: DeleteFeedPostPublic200Response

Приклад

Приклад deleteFeedPostPublic

Copy

const tenantId: string = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

Отримати записи стрічки

req tenantId afterId

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
afterId	string	Ні
limit	number	Ні
tags	Array	Ні

Відповідь

Повертає: GetFeedPosts200Response

Приклад

Приклад getFeedPosts

Copy

const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

Отримати публічні записи стрічки

req tenantId afterId

Параметри

Name	Type	Required
tenantId	string	Так
afterId	string	Ні
limit	number	Ні
tags	Array	Ні
sso	string	Ні
isCrawler	boolean	Ні
includeUserInfo	boolean	Ні

Відповідь

Повертає: GetFeedPostsPublic200Response

Приклад

Приклад getFeedPostsPublic

Copy

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

Отримати статистику записів стрічки

Параметри

Name	Type	Required
tenantId	string	Так
postIds	Array	Так
sso	string	Ні

Відповідь

Повертає: GetFeedPostsStats200Response

Приклад

Приклад getFeedPostsStats

Copy

const tenantId: string = 'tenant_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

Отримати публічні реакції користувачів

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
postIds	Array	Ні
sso	string	Ні

Відповідь

Повертає: GetUserReactsPublic200Response

Приклад

Приклад getUserReactsPublic

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

Поставити публічну реакцію до запису стрічки

Параметри

Name	Type	Required
tenantId	string	Так
postId	string	Так
reactBodyParams	ReactBodyParams	Так
isUndo	boolean	Ні
broadcastId	string	Ні
sso	string	Ні

Відповідь

Повертає: ReactFeedPostPublic200Response

Приклад

Приклад reactFeedPostPublic

Copy

const tenantId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const postId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍', source: 'web' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast-2026-03-25-001';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, sso);

Оновити запис стрічки

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Так
id	string	Так
feedPost	FeedPost	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateFeedPost

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // необов'язковий масив включено
  links: [link],          // необов'язкові посилання включені
  isPublished: true       // необов'язковий прапорець публікації, застосований тут
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

Оновити публічний запис стрічки

Параметри

Name	Type	Required
tenantId	string	Так
postId	string	Так
updateFeedPostParams	UpdateFeedPostParams	Так
broadcastId	string	Ні
sso	string	Ні

Відповідь

Повертає: CreateFeedPostPublic200Response

Приклад

Приклад updateFeedPostPublic

Copy

const tenantId: string = "tenant_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

Позначити публічний коментар

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Так
isFlagged	boolean	Так
sso	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад flagCommentPublic

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

Додати хештег

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Ні
createHashTagBody	CreateHashTagBody	Ні

Відповідь

Повертає: AddHashTag200Response

Приклад

Приклад addHashTag

Copy

const tenantId: string = 'tenant_acme_01';
const createHashTagBody: CreateHashTagBody = {
  name: 'feature-request',
  label: 'Feature Request',
  color: '#FF5722',
  enabled: true
};
const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);
const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBody);

Масове додавання хештегів

Параметри

Name	Type	Required	Description
tenantId	string	Ні
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Ні

Відповідь

Повертає: AddHashTagsBulk200Response

Приклад

Приклад addHashTagsBulk

Copy

// Створіть ідентифікатор tenant (необов'язковий параметр)
const tenantId: string = "tenant_9f8c2b7a";
// Підготуйте окремі записи тегів
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Тіло для масового створення (необов'язковий параметр)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Викличте глобальну асинхронну функцію та присвойте типізований результат
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

Видалити хештег

Параметри

Назва	Тип	Обов'язково
tag	string	Так
tenantId	string	Ні
deleteHashTagRequest	DeleteHashTagRequest	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteHashTag

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_12345";
const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

Отримати хештеги

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
page	number	Ні

Відповідь

Повертає: GetHashTags200Response

Приклад

Приклад getHashTags

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

Частково оновити хештег

Параметри

Назва	Тип	Обов'язково
tag	string	Так
tenantId	string	Ні
updateHashTagBody	UpdateHashTagBody	Ні

Відповідь

Повертає: PatchHashTag200Response

Приклад

Приклад patchHashTag

Copy

const tag: string = "feature-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

Створити модератора

Параметри

Name	Type	Required	Description
tenantId	string	Так
createModeratorBody	CreateModeratorBody	Так

Відповідь

Повертає: CreateModerator200Response

Приклад

Приклад createModerator

Copy

const tenantId: string = 'tenant_7d9f2b4a';
const customConfig: CustomConfigParameters = { timezone: 'UTC', moderationQueueEnabled: true };
const createModeratorBody: CreateModeratorBody = {
  email: 'jane.martin@publisher.com',
  displayName: 'Jane Martin',
  roles: ['moderator'],
  sendWelcomeEmail: true,
  customConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

Видалити модератора

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
sendEmail	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

deleteModerator Приклад

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

Отримати модератора

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetModerator200Response

Приклад

Приклад getModerator

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

Отримати модераторів

Параметри

Name	Type	Required	Description
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetModerators200Response

Приклад

Приклад getModerators

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

Надіслати запрошення

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
fromName	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад sendInvite

Copy

const tenantId: string = 'tenant_acme-42';
const id: string = 'comment_8f3b21a7';
const fromName: string = 'Elena Morales';
const replyToEmail: string | undefined = undefined;
const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

Оновити модератора

Параметри

Назва	Тип	Обов'язкове
tenantId	string	Так
id	string	Так
updateModeratorBody	UpdateModeratorBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateModerator

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // необов'язкове поле (показано)
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

Видалити лічильник сповіщень

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteNotificationCount

Copy

const tenantSuffix: string | undefined = undefined;
const tenantId: string = tenantSuffix ? `tenant-${tenantSuffix}` : 'tenant-9142a7';
const id: string = '3f9b2a44-1c2e-4d3b-9f6a-8e7c6d5b2a1f';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

Отримати кешований лічильник сповіщень

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetCachedNotificationCount200Response

Приклад

Приклад getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // необов'язковий прапорець параметра (показано)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

Отримати лічильник сповіщень

Параметри

Name	Type	Required
tenantId	string	Так
userId	string	Ні
urlId	string	Ні
fromCommentId	string	Ні
viewed	boolean	Ні
type	string	Ні

Відповідь

Повертає: GetNotificationCount200Response

Приклад

Приклад getNotificationCount

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

Отримати сповіщення

Параметри

Назва	Тип	Обов'язкове
tenantId	string	Так
userId	string	Ні
urlId	string	Ні
fromCommentId	string	Ні
viewed	boolean	Ні
type	string	Ні
skip	number	Ні

Відповідь

Повертає: GetNotifications200Response

Приклад

Приклад getNotifications

Copy

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

Оновити сповіщення

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateNotificationBody	UpdateNotificationBody	Так
userId	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад використання updateNotification

Copy

const tenantId: string = 'tenant_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

Додати сторінку

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createAPIPageData	CreateAPIPageData	Так

Відповідь

Повертає: AddPageAPIResponse

Видалити сторінку

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: DeletePageAPIResponse

Отримати сторінку за URL ID

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
urlId	string	Так

Відповідь

Повертає: GetPageByURLIdAPIResponse

Отримати сторінки

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так

Відповідь

Повертає: GetPagesAPIResponse

Частково оновити сторінку

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateAPIPageData	UpdateAPIPageData	Так

Відповідь

Повертає: PatchPageAPIResponse

Видалити невиконану подію вебхука

Параметри

Назва	Type	Required	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deletePendingWebhookEvent

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // приклад необов'язкового параметра (не обов'язковий для функції)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

Отримати кількість невиконаних подій вебхука

Параметри

Name	Type	Required
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Відповідь

Повертає: GetPendingWebhookEventCount200Response

Приклад

Приклад getPendingWebhookEventCount

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

Отримати невиконані події вебхука

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
commentId	string	Ні
externalId	string	Ні
eventType	string	Ні
type	string	Ні
domain	string	Ні
attemptCountGT	number	Ні
skip	number	Ні

Відповідь

Повертає: GetPendingWebhookEvents200Response

Приклад

Приклад getPendingWebhookEvents

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

Створити конфігурацію запитання

Параметри

Назва	Type	Required	Опис
tenantId	string	Так
createQuestionConfigBody	CreateQuestionConfigBody	Так

Відповідь

Повертає: CreateQuestionConfig200Response

Приклад

Приклад createQuestionConfig

Copy

const tenantId: string = "tenant_9f8b2c";
const option: QuestionConfigCustomOptionsInner = { id: "opt_yes", label: "Yes, helpful", value: "yes" };
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Article usefulness",
  prompt: "Was this article helpful?",
  type: "singleChoice",
  required: false, // продемонстровано необов'язковий параметр
  options: [option],
  saveBehavior: "immediate"
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

Видалити конфігурацію запитання

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteQuestionConfig

Copy

const tenantId: string = "acme-enterprises-01";
const idOptional: string | undefined = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const id: string = idOptional ?? "11111111-1111-1111-1111-111111111111";
const response: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

Отримати конфігурацію запитання

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetQuestionConfig200Response

Приклад

Приклад getQuestionConfig

Copy

const tenantId: string = 'acme-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

Отримати конфігурації запитань

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetQuestionConfigs200Response

Приклад

Приклад getQuestionConfigs

Copy

const tenantId: string = "tenant_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

Оновити конфігурацію запитання

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateQuestionConfig

Copy

const tenantId: string = 'tenant_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

Створити результат запитання

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
createQuestionResultBody	CreateQuestionResultBody	Так

Відповідь

Повертає: CreateQuestionResult200Response

Приклад

Приклад createQuestionResult

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // необов'язкові метадані
  note: "Follow-up requested" // продемонстровано необов'язковий параметр
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

Видалити результат запитання

Параметри

Назва	Тип	Обов'язкове	Опис
tenantId	string	Yes
id	string	Yes

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteQuestionResult

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // необов'язковий параметр, що демонструє альтернативний вибір цілі
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

Отримати результат запитання

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetQuestionResult200Response

Приклад

Приклад getQuestionResult

Copy

const post: { title: string; questionId?: string } = { title: 'Product feedback' };
const tenantId: string = 'acme-corp-tenant-01';
const id: string = post.questionId ?? 'q-8f3a7b2c4d9e';
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);

Отримати результати запитань

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlId	string	Ні
userId	string	Ні
startDate	string	Ні
questionId	string	Ні
questionIds	string	Ні
skip	number	Ні

Відповідь

Повертає: GetQuestionResults200Response

Приклад

Приклад getQuestionResults

Copy

const tenantId: string = "tenant_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

Оновити результат запитання

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateQuestionResultBody	UpdateQuestionResultBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateQuestionResult

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // необов'язкові метадані
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Агрегувати результати запитань

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
questionId	string	Ні
questionIds	Array	Ні
urlId	string	Ні
timeBucket	AggregateTimeBucket	Ні
startDate	Date	Ні
forceRecalculate	boolean	Ні

Відповідь

Повертає: AggregateQuestionResults200Response

Приклад

Приклад aggregateQuestionResults

Copy

const tenantId: string = 'tenant_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // questionId пропущено, використовується questionIds натомість
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

Масова агрегація результатів запитань

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Так
forceRecalculate	boolean	Ні

Відповідь

Повертає: BulkAggregateQuestionResults200Response

Приклад

bulkAggregateQuestionResults Приклад

Copy

const tenantId: string = "tenant_live_7c9d";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    { questionId: "q_feedback_rating", includeSubQuestions: false, filters: { locale: "en-US" } }
  ],
  timeBuckets: [
    { granularity: "day", startUtc: "2026-03-01T00:00:00Z", endUtc: "2026-03-15T00:00:00Z" }
  ]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

Комбінувати коментарі з результатами запитань

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
questionId	string	Ні
questionIds	Array	Ні
urlId	string	Ні
startDate	Date	Ні
forceRecalculate	boolean	Ні
minValue	number	Ні
maxValue	number	Ні
limit	number	Ні

Відповідь

Повертає: CombineCommentsWithQuestionResults200Response

Приклад

Приклад combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant_9f3a2';
const questionIds: string[] = ['question-42', 'question-43'];
const urlId: string = 'url_5d7b';
const startDate: Date = new Date('2026-02-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

Додати користувача SSO

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createAPISSOUserData	CreateAPISSOUserData	Так

Відповідь

Повертає: AddSSOUserAPIResponse

Видалити користувача SSO

Параметри

Назва	Type	Обов'язково
tenantId	string	Так
id	string	Так
deleteComments	boolean	Ні
commentDeleteMode	string	Ні

Відповідь

Повертає: DeleteSSOUserAPIResponse

Отримати користувача SSO за електронною поштою

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
email	string	Так

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

Отримати користувача SSO за ID

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetSSOUserByIdAPIResponse

Отримати користувачів SSO

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetSSOUsers200Response

Частково оновити користувача SSO

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
updateAPISSOUserData	UpdateAPISSOUserData	Так
updateComments	boolean	Ні

Відповідь

Повертає: PatchSSOUserAPIResponse

Замінити користувача SSO

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateAPISSOUserData	UpdateAPISSOUserData	Так
updateComments	boolean	Ні

Відповідь

Повертає: PutSSOUserAPIResponse

Створити підписку

Параметри

Name	Type	Required	Description
tenantId	string	Так
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Так

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

Приклад createSubscription

Copy

const tenantId: string = "acme-corp-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "u_987654",
  planId: "pro_monthly",
  startDate: new Date().toISOString(),
  trialDays: 14, // необов'язковий параметр (показано)
  metadata: { source: "marketing-email" } // необов'язковий параметр (показано)
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
const subscription: APIUserSubscription = result.subscription;

Видалити підписку

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
userId	string	Ні

Відповідь

Повертає: DeleteSubscriptionAPIResponse

Отримати підписки

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
userId	string	Ні

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад getSubscriptions

Copy

const tenantId: string = 'tenant_acme_corp_01';
const userId: string = 'user_76a3b9f2';
const subscriptionsForUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
const subscriptionsForTenant: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);

Оновити підписку

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Так
userId	string	Ні

Відповідь

Повертає: UpdateSubscriptionAPIResponse

Приклад

Приклад updateSubscription

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

Отримати щоденне використання орендаря

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
yearNumber	number	Ні
monthNumber	number	Ні
dayNumber	number	Ні
skip	number	Ні

Відповідь

Повертає: GetTenantDailyUsages200Response

Приклад

Приклад getTenantDailyUsages

Copy

const tenantId: string = 'tenant_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

Створити пакет орендаря

Параметри

Name	Type	Required	Description
tenantId	string	Так
createTenantPackageBody	CreateTenantPackageBody	Так

Відповідь

Повертає: CreateTenantPackage200Response

Приклад

Приклад createTenantPackage

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // необов'язковий параметр, наданий
  // необов'язкові поля опущені: наприклад, розширені правила модерації, власний CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // ілюстративне значення; використовує формат CustomConfigParameters
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

Видалити пакет орендаря

Параметри

Назва	Тип	Обов'язкове	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteTenantPackage

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // демонструються необов'язкові параметри
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

Отримати пакет орендаря

Параметри

Назва	Тип	Обов'язкове	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetTenantPackage200Response

Приклад

Приклад getTenantPackage

Copy

const tenantId: string = 'tenant_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

Отримати пакети орендаря

Параметри

Name	Type	Required	Description
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetTenantPackages200Response

Приклад

Приклад getTenantPackages

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

Замінити пакет орендаря

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
replaceTenantPackageBody	ReplaceTenantPackageBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад replaceTenantPackage

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

Оновити пакет орендаря

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
id	string	Так
updateTenantPackageBody	UpdateTenantPackageBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // необов'язкові поля навмисно опущено (наприклад, description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

Створити користувача орендаря

Parameters

Назва	Тип	Обов'язкове	Опис
tenantId	string	Так
createTenantUserBody	CreateTenantUserBody	Так

Відповідь

Повертає: CreateTenantUser200Response

Приклад

createTenantUser Приклад

Copy

const tenantId: string = 'tenant_6f4b2c';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'sara.kim@example.com',
  displayName: 'Sara Kim',
  role: 'moderator',
  notifyOnMentions: true
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

Видалити користувача орендаря

Параметри

Назва	Type	Обов'язково
tenantId	string	Так
id	string	Так
deleteComments	string	Ні
commentDeleteMode	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteTenantUser

Copy

const tenantId: string = '4f3a9b2e-1c6a-4f7b-9e2a-0b8d6f1c2a3e';
const userId: string = '9d2f7b3a-5c4e-48a2-b1f0-6c7d8e9f0a12';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'permanent';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, userId, deleteComments, commentDeleteMode);

Отримати користувача орендаря

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetTenantUser200Response

Приклад

Приклад getTenantUser

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // accessing payload
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

Отримати користувачів орендаря

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
skip	number	Ні

Відповідь

Повертає: GetTenantUsers200Response

Приклад

getTenantUsers Приклад

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

Замінити користувача орендаря

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
replaceTenantUserBody	ReplaceTenantUserBody	Так
updateComments	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад replaceTenantUser

Copy

const tenantId: string = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

Надіслати посилання для входу

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
redirectURL	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад sendLoginLink

Copy

const tenantId: string = "tenant_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

Оновити користувача орендаря

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
updateTenantUserBody	UpdateTenantUserBody	Так
updateComments	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

updateTenantUser Приклад

Copy

const tenantId: string = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

Створити орендаря

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createTenantBody	CreateTenantBody	Так

Відповідь

Повертає: CreateTenant200Response

Приклад

Приклад createTenant

Copy

const tenantId: string = "acme-corp-001";
const createTenantBody: CreateTenantBody = {
  name: "Acme Corporation",
  domain: "comments.acme.com",
  adminContact: { name: "Jane Doe", email: "jane.doe@acme.com" },
  billingInfo: { planId: "pro-monthly", billingContactEmail: "billing@acme.com" },
  importedSite: { siteId: "site-123", siteName: "Acme Blog" } // необов'язковий імпортований сайт
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

Видалити орендаря

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
sure	string	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

deleteTenant Приклад

Copy

const tenantId: string = "tenant_7f3d2c";
const id: string = "flag_8392b1a7";
const sure: string = "confirmed";
const responseWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const responseWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

Отримати орендаря

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetTenant200Response

Приклад

Приклад getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // необов'язкове перевизначення, якщо доступне
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

Отримати орендарів

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
meta	string	Ні
skip	number	Ні

Відповідь

Повертає: GetTenants200Response

Приклад

Приклад getTenants

Copy

const tenantId: string = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

Оновити орендаря

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
updateTenantBody	UpdateTenantBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // необов'язково, пропустіть, щоб зберегти поточну платіжну інформацію
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Змінити стан тікету

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
userId	string	Так
id	string	Так
changeTicketStateBody	ChangeTicketStateBody	Так

Відповідь

Повертає: ChangeTicketState200Response

Приклад

Приклад changeTicketState

Copy

const tenantId: string = 'tenant_82f9b3';
const userId: string = 'user_9472';
const id: string = 'ticket_550e8400-e29b-41d4-a716-446655440000';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'resolved',
  comment: 'Confirmed fix deployed to production; closing ticket.',
  notifySubscribers: true
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

Створити тікет

Параметри

Name	Type	Required
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

Відповідь

Повертає: CreateTicket200Response

Приклад

Приклад createTicket

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_72b9f4";
const createTicketBody: CreateTicketBody = {
  subject: "Subscription renewal failed for card on file",
  description: "Customer's card was declined by the payment processor during automatic renewal. Transaction ID: txn_9a8b7c. Please review gateway logs and retry.",
  priority: "high", // необов'язкове поле — приклад
  contactEmail: "billing@acme-corp.com", // необов'язкова контактна інформація
  relatedUrl: "https://acme-corp.com/account/billing"
};
const ticketResponse: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

Отримати тікет

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
userId	string	Ні

Відповідь

Повертає: GetTicket200Response

Приклад

Приклад getTicket

Copy

const tenantId: string = 'acme-corp-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

Отримати тікети

Параметри

Назва	Type	Обов'язково
tenantId	string	Так
userId	string	Ні
state	number	Ні
skip	number	Ні
limit	number	Ні

Відповідь

Повертає: GetTickets200Response

Приклад

Приклад getTickets

Copy

const tenantId: string = "tenant_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

Завантажити зображення

Завантажити та змінити розмір зображення

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
file	Blob	Так
sizePreset	SizePreset	Ні
urlId	string	Ні

Відповідь

Повертає: UploadImageResponse

Отримати прогрес бейджа користувача за ID

Параметри

Назва	Тип	Обов'язкове	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetUserBadgeProgressById200Response

Приклад

Приклад getUserBadgeProgressById

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

Отримати прогрес бейджа за ID користувача

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
userId	string	Так

Відповідь

Повертає: GetUserBadgeProgressById200Response

Приклад

getUserBadgeProgressByUserId Приклад

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // необов'язкове джерело (може бути undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

Отримати список прогресу бейджів користувача

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
userId	string	Ні
limit	number	Ні
skip	number	Ні

Відповідь

Повертає: GetUserBadgeProgressList200Response

Приклад

Приклад getUserBadgeProgressList

Copy

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

Створити бейдж користувача

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
createUserBadgeParams	CreateUserBadgeParams	Так

Відповідь

Повертає: CreateUserBadge200Response

Приклад

Приклад createUserBadge

Copy

const tenantId: string = 'tenant_84f3b2';
const createUserBadgeParams: CreateUserBadgeParams = {
  name: 'Top Contributor',
  slug: 'top-contributor',
  imageUrl: 'https://assets.fastcomments.com/badges/top-contributor.png',
  description: 'Awarded for 100 helpful comments',
  active: true,
  criteria: { commentsCount: 100 }, // необов'язкові критерії
  displayOrder: 10,
  metadata: { featured: true } // необов'язкові метадані
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);
console.log(result);

Видалити бейдж користувача

Параметри

Name	Type	Required	Description
tenantId	string	Так
id	string	Так

Відповідь

Повертає: UpdateUserBadge200Response

Приклад

Приклад deleteUserBadge

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

Отримати бейдж користувача

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetUserBadge200Response

Приклад

Приклад getUserBadge

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

Отримати бейджі користувача

Параметри

Name	Type	Required
tenantId	string	Так
userId	string	Ні
badgeId	string	Ні
type	number	Ні
displayedOnComments	boolean	Ні
limit	number	Ні
skip	number	Ні

Відповідь

Повертає: GetUserBadges200Response

Приклад

Приклад getUserBadges

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

Оновити бейдж користувача

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Так
id	string	Так
updateUserBadgeParams	UpdateUserBadgeParams	Так

Відповідь

Повертає: UpdateUserBadge200Response

Приклад

Приклад updateUserBadge

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

Отримати кількість сповіщень користувача

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
sso	string	Ні

Відповідь

Повертає: GetUserNotificationCount200Response

Приклад

getUserNotificationCount Приклад

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

Отримати сповіщення користувача

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
pageSize	number	Ні
afterId	string	Ні
includeContext	boolean	Ні
afterCreatedAt	number	Ні
unreadOnly	boolean	Ні
dmOnly	boolean	Ні
noDm	boolean	Ні
includeTranslations	boolean	Ні
sso	string	Ні

Відповідь

Повертає: GetUserNotifications200Response

Приклад

Приклад getUserNotifications

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

Скинути лічильник сповіщень користувача

Параметри

Назва	Тип	Обов'язковий	Опис
tenantId	string	Так
sso	string	Ні

Відповідь

Повертає: ResetUserNotifications200Response

Приклад

resetUserNotificationCount Приклад

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

Скинути сповіщення користувача

Параметри

Name	Type	Required
tenantId	string	Так
afterId	string	Ні
afterCreatedAt	number	Ні
unreadOnly	boolean	Ні
dmOnly	boolean	Ні
noDm	boolean	Ні
sso	string	Ні

Відповідь

Повертає: ResetUserNotifications200Response

Приклад

Приклад resetUserNotifications

Copy

const tenantId: string = "tenant_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

Оновити статус підписки користувача на коментарі

Увімкнути або вимкнути сповіщення для конкретного коментаря.

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
notificationId	string	Так
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Так
commentId	string	Так
sso	string	Ні

Відповідь

Повертає: UpdateUserNotificationStatus200Response

Приклад

updateUserNotificationCommentSubscriptionStatus Приклад

Copy

const tenantId: string = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

Оновити статус підписки користувача на сторінки

Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також

Параметри

Ім'я	Тип	Обов'язково
tenantId	string	Так
urlId	string	Так
url	string	Так
pageTitle	string	Так
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Так
sso	string	Ні

Відповідь

Повертає: UpdateUserNotificationStatus200Response

Приклад

Приклад updateUserNotificationPageSubscriptionStatus

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

Оновити статус сповіщення користувача

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
notificationId	string	Так
newStatus	UpdateUserNotificationStatusNewStatusEnum	Так
sso	string	Ні

Відповідь

Повертає: UpdateUserNotificationStatus200Response

Приклад

Приклад updateUserNotificationStatus

Copy

const tenantId: string = 'tenant_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

Отримати статуси присутності користувачів

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
urlIdWS	string	Так
userIds	string	Так

Відповідь

Повертає: GetUserPresenceStatuses200Response

Приклад

Приклад getUserPresenceStatuses

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // optional source
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

Шукати користувачів

Параметри

Назва	Тип	Обов'язкове
tenantId	string	Так
urlId	string	Так
usernameStartsWith	string	Ні
mentionGroupIds	Array	Ні
sso	string	Ні
searchSection	SearchUsersSearchSectionEnum	Ні

Відповідь

Повертає: SearchUsers200Response

Приклад

Приклад searchUsers

Copy

const tenantId: string = 'tenant_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

Отримати користувача

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
id	string	Так

Відповідь

Повертає: GetUser200Response

Приклад

Приклад getUser

Copy

const tenantId: string = 'tenant_7b3f42';
const id: string = 'user_9c4d2a';
const userResponse: GetUser200Response = await getUser(tenantId, id);
console.log(userResponse);

Створити голос

Параметри

Назва	Тип	Обов'язковий
tenantId	string	Так
commentId	string	Так
direction	CreateVoteDirectionEnum	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: VoteComment200Response

Приклад

createVote Приклад

Copy

const tenantId: string = 'tenant_9f8b6a';
const commentId: string = 'comment_3b7d2e';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_4c2a1f';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

Видалити голос

Параметри

Назва	Тип	Обов'язково
tenantId	string	Так
id	string	Так
editKey	string	Ні

Відповідь

Повертає: DeleteCommentVote200Response

Приклад

Приклад deleteVote

Copy

const tenantId: string = "tenant_7c3f2b4a";
const voteId: string = "vote_4f8d9a11";
const editKey: string = "edit_2b9f8c";
const resultWithoutKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId);
const resultWithKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId, editKey);

Отримати голоси

Параметри

Назва	Тип	Обов'язково	Опис
tenantId	string	Так
urlId	string	Так

Відповідь

Повертає: GetVotes200Response

Приклад

Приклад getVotes

Copy

const tenantId: string = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // необов'язковий параметр запиту
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

Отримати голоси для користувача

Параметри

Name	Type	Required
tenantId	string	Так
urlId	string	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: GetVotesForUser200Response

Приклад

Приклад getVotesForUser

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

Потрібна допомога?

Якщо ви стикнулися з будь-якими проблемами або маєте питання щодо JavaScript/TypeScript SDK, будь ласка:

Внесок

Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для отримання інструкцій щодо внесків.

Мова 🇺🇦 Українська

Початок роботи

Довідник API

Документація

Використання

Агрегація

Журнали аудиту

Блокування через коментар

Перевірка заблокованих коментарів

Коментарі

Конфігурації доменів

Шаблони електронних листів

Журнал подій

Записи стрічки

Позначення коментаря

Хештеги

Модератори

Кількість сповіщень

Сповіщення

Сторінки

Невиконані події вебхука

Конфігурації запитань

Результати запитань

Агрегація результатів запитань

Користувачі SSO

Підписки

Щоденне використання орендаря

Пакети орендаря

Користувачі орендаря

Орендарі

Тікети

Завантаження зображення

Прогрес бейджів користувача

Бейджі користувачів

Сповіщення користувача

Статуси присутності користувачів

Пошук користувачів

Користувачі

Голоси

FastComments JavaScript/TypeScript SDK

Репозиторій

Встановлення

Документація API

Повна документація API: docs/api/README.md

Сумісність браузера та сервера

Використання

Використання в браузері (клієнтська сторона)

Використання на сервері (Node.js)

Імпорт тільки типів

Використання окремих класів API

Середовище браузера

Середовище сервера

Публічні та захищені API

Приклад: Використання Public API (безпечне для браузера)

Приклад: Використання Default API (лише на сервері)

Інтеграція SSO (єдиний вхід)

Просте SSO (тільки на сервері)

Безпечне SSO (серверна сторона, рекомендовано)

Використання SSO з браузера (з токеном, згенерованим на сервері)

SSO зі створенням коментаря

Поширені випадки використання

Отримання коментарів для сторінки

Створення коментаря

Голосування за коментар

Управління користувачами (потребує API-ключа)

Живі події (оновлення в реальному часі)

Події на рівні сторінки

Підписка на події користувача

Отримання userIdWS

ID трансляцій

Обробка помилок

Агрегувати

Параметри

Відповідь

Отримати журнали аудиту

Параметри

Відповідь

Приклад

Заблокувати через публічний коментар

Параметри