FastComments SDK для JavaScript/TypeScript

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

Керуйте коментарями, користувачами, SSO та модерацією з Node.js або браузера.

Репозиторій

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

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);
}

Broadcast IDs

Ви побачите, що потрібно передавати 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);
  }
}

aggregate

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

Параметри

Name	Type	Required
tenantId	string	Так
aggregationRequest	AggregationRequest	Так
parentTenantId	string	Ні
includeStats	boolean	Ні

Відповідь

Повертає: Aggregate200Response

Приклад

Приклад aggregate

Copy

const tenantId: string = 'tenant_78a9';
const parentTenantId: string = 'parent_tenant_01';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  operation: { type: 'COUNT' },
  groupBy: ['pageUrl'],
  predicate: { field: 'status', operator: 'EQUALS', value: 'approved' },
  sort: [{ field: 'count', direction: 'DESC' }],
  limit: 25
};
const result: Aggregate200Response = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

getAuditLogs

Parameters

Name	Type	Required
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Response

Повертає: GetAuditLogs200Response

Example

Приклад getAuditLogs

Copy

const tenantId: string = 'tenant_5f8d7c3a';
const limit: number = 100;
const skip: number = 0;
const order: SORTDIR = 'DESC' as SORTDIR;
const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // тиждень тому
const before: number = Date.now();
const result: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after, before);

blockFromCommentPublic

Параметри

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

Відповідь

Повертає: BlockFromCommentPublic200Response

Приклад

blockFromCommentPublic Приклад

Copy

const tenantId: string = 'tenant_6b3f9a2d';
const commentId: string = 'cmt_8f4b12a9';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'Repeated promotional links',
  durationMinutes: 60 * 24 * 30, // 30 днів
  escalateToModeration: true
};
const sso: string = 'sso_token_3fH7kLw';
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

unBlockCommentPublic

Параметри

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

Відповідь

Повертає: UnBlockCommentPublic200Response

Приклад

Приклад unBlockCommentPublic

Copy

const tenantId: string = "tenant-42-production";
const commentId: string = "comment_7f3b2a9d";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "flag reviewed and determined not to violate policy",
  restoredBy: "moderator_jane",
  restoredAt: new Date().toISOString()
};
const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

checkedCommentsForBlocked

Параметри

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

Відповідь

Повертає: CheckedCommentsForBlocked200Response

Приклад

Приклад checkedCommentsForBlocked

Copy

(async () => {
  const tenantId: string = 'tenant_fa3b2c9e';
  const commentIds: string = 'cmt_112233,cmt_445566';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0Njc4IiwidGVuYW50IjoidGVuYW50X2ZhM2IifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, sso);
  const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
  console.log(resultWithSSO, resultWithoutSSO);
})();

blockUserFromComment

Параметри

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

Відповідь

Повертає: BlockFromCommentPublic200Response

Приклад

Приклад blockUserFromComment

Copy

const tenantId: string = "tenant_7f3b4c";
const id: string = "comment_9a8b7c6d";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated spam links",
  durationHours: 168,
  notifyModerators: true
};
const userId: string | undefined = "user_42";
const anonUserId: string | undefined = undefined;
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

createCommentPublic

Параметри

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

Відповідь

Повертає: CreateCommentPublic200Response

Приклад

Приклад createCommentPublic

Copy

const tenantId: string = 'tenant_9a1b2c';
const urlId: string = 'https://www.news-site.com/article/67890';
const broadcastId: string = 'broadcast_2026-06-15-01';
const sessionId: string | undefined = 'sess_abc123xyz';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiam9yZGFuIiwiaWF0IjoxNjI0MDAwMDB9.signature';
const commentData: CommentData = {
  content: 'Insightful piece — I appreciated the data-backed points and sources cited.',
  authorDisplayName: 'Jordan Miles'
} as CommentData;
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Параметри

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

Відповідь

Повертає: DeleteComment200Response

Приклад

Приклад deleteComment

Copy

const tenantId: string = 'tenant_84a9f2';
const id: string = 'comment_5f3b21';
const contextUserId: string | undefined = 'user_1122';
const isLive: boolean | undefined = true;
async function run(): Promise<void> {
  const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);
  console.log(result);
}
run();

deleteCommentPublic

Параметри

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

Відповідь

Повертає: DeleteCommentPublic200Response

Приклад

deleteCommentPublic Приклад

Copy

const tenantId: string = 'tenant_acme_42';
const commentId: string = 'c0mment-9f8b7a6';
const broadcastId: string = 'site_homepage_2026-06-15';
const editKey: string = 'ek_3b7a1f59-4d2c-11eb-8dcd-0242ac130003';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

deleteCommentVote

Параметри

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

Відповідь

Повертає: DeleteCommentVote200Response

Приклад

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

Copy

const tenantId: string = 'tenant_8f3a2b7c';
const commentId: string = 'cmt-5a1f3d92';
const voteId: string = 'vote-3b9c7e1a';
const urlId: string = 'articles/2026/06/typescript-best-practices';
const broadcastId: string = 'broadcast-77f4d2';
const editKey: string = 'edk-9b2f4c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

flagComment

Parameters

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

Відповідь

Повертає: FlagComment200Response

Приклад

Приклад flagComment

Copy

const tenantId: string = "tenant_4f21c9a";
const commentId: string = "cmt_7a12b3e9";
const userId: string = "user_82bd123";
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

getComment

Параметри

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

Відповідь

Повертає: GetComment200Response

Приклад

Приклад getComment

Copy

const tenantId: string = 'tenant_6f1a2b';
const commentId: string = 'cmt_4d9e8f';
const includeReplies: boolean | undefined = true; // приклад необов'язкового параметра (не передається в getComment)
const result: GetComment200Response = await getComment(tenantId, commentId);
console.log('Fetched comment for tenant:', tenantId, 'comment id:', commentId);
console.log('API response received:', result);

getComments

Параметри

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	Ні
fromDate	number	Ні
toDate	number	Ні

Відповідь

Повертає: GetComments200Response

Приклад

Приклад getComments

Copy

const tenantId: string = "tenant_9a12b3";
const response: GetComments200Response = await getComments(tenantId, 1, 20, 0, true, 0, 3, 2, "https://mysite.com/posts/678", undefined, undefined, undefined, undefined, "parent_987", undefined, 1716873600000, 1719552000000);

getCommentsPublic

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 = 'acme-news';
const urlId: string = '/articles/2026/fastcomments-update';
const page: number = 1;
const skip: number = 0;
const limit: number = 25;
const countChildren: boolean = true;
const includeConfig: boolean = true;
const result: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  page,
  undefined,
  undefined,
  skip,
  undefined,
  limit,
  undefined,
  countChildren,
  undefined,
  includeConfig
);

getCommentText

Параметри

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

Відповідь

Повертає: GetCommentText200Response

Приклад

Приклад getCommentText

Copy

const tenantId: string = 'tenant_42b7e9';
const commentId: string = 'cmt_9f3a2b';
const editKey: string = 'edk_3f1b7c9d';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

getCommentVoteUserNames

Параметри

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

Відповідь

Повертає: GetCommentVoteUserNames200Response

Приклад

Приклад getCommentVoteUserNames

Copy

const tenantId: string = "tenant_67890";
const commentId: string = "comment_abc123";
const dir: number = 1;
const ssoToken: string = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const responseWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
const responseWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

lockComment

Параметри

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

Відповідь

Повертає: LockComment200Response

Приклад

Приклад lockComment

Copy

const tenantId: string = 'tenant_42f6c1';
const commentId: string = 'cmt-9a8b7c';
const broadcastId: string = 'brd_2026_06_15';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY1MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const lockedWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const lockedWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

pinComment

Параметри

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

Відповідь

Повертає: PinComment200Response

Приклад

Приклад pinComment

Copy

const tenantId: string = "acme-corp-tenant-72";
const commentId: string = "cmt_8f3a2b4c9d";
const broadcastId: string = "live_2026-06-15_21z";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload.signature";
const responseNoSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId);
const responseWithSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

saveComment

Параметри

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

Відповідь

Повертає: SaveComment200Response

Приклад

Приклад saveComment

Copy

const tenantId: string = "fastcomments-tenant-42";
const createCommentParams: CreateCommentParams = {
  threadId: "article-2026-06-0142",
  content: "Great write-up — I followed the migration steps and everything worked as described.",
  userId: "u_9c72b",
  userName: "Ava R.",
  userAvatarUrl: "https://cdn.example.com/avatars/u_9c72b.png",
  metadata: { platform: "web", locale: "en-US" }
};
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);

saveCommentsBulk

Параметри

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

Відповідь

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

Приклад

Приклад saveCommentsBulk

Copy

const tenantId: string = "tenant_42a1b7";
const mentions: CommentUserMentionInfo[] = [{ userId: "user_2b9", displayName: "Alex Chen" }];
const hashtags: CommentUserHashTagInfo[] = [{ tag: "performance" }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: "Thanks for the detailed article — the alternative approach worked for me.",
    authorId: "user_8f3c2",
    authorName: "Maya Patel",
    authorEmail: "maya.patel@example.com",
    url: "/articles/optimizing-ts-performance",
    createdAt: new Date().toISOString(),
    mentions,
    hashtags
  }
];
const isLive: boolean = true;
const doSpamCheck: boolean = false;
const sendEmails: boolean = true;
const populateNotifications: boolean = true;
const result: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

setCommentText

Параметри

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

Відповідь

Повертає: SetCommentText200Response

Приклад

Приклад setCommentText

Copy

const tenantId: string = 'tenant_4f9a2b'
const commentId: string = 'cmt-8421'
const broadcastId: string = 'brd-2026-06-15'
const commentTextUpdateRequest: CommentTextUpdateRequest = { text: 'Updated comment text to clarify the schedule.', mentions: [], hashtags: [] }
const editKey: string = 'editkey_9b12'
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso.signature'
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso)

unBlockUserFromComment

Параметри

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

Відповідь

Повертає: UnBlockCommentPublic200Response

Приклад

Приклад unBlockUserFromComment

Copy

const tenantId: string = 'tenant_7b9c2a';
const id: string = 'comment_4f8e1d';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'User submitted appeal and provided additional context',
  effectiveAt: new Date().toISOString()
};
const userId: string = 'user_92a3f6';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

unFlagComment

Параметри

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

Відповідь

Повертає: FlagComment200Response

Приклад

Приклад unFlagComment

Copy

const tenantId: string = 'tenant_8f3b2a1f';
const commentId: string = 'cmt_20250614_01';
const userId: string = 'user_47d2b9';
const result: FlagComment200Response = await unFlagComment(tenantId, commentId, userId);

unLockComment

Параметри

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

Відповідь

Повертає: LockComment200Response

Приклад

Приклад unLockComment

Copy

const tenantId: string = "tenant-8f3b2c4a";
const commentId: string = "cmt_92a7f3e6";
const broadcastId: string = "brd_1b4c9d20";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

unPinComment

Параметри

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

Відповідь

Повертає: PinComment200Response

Приклад

Приклад unPinComment

Copy

const tenantId: string = "tenant_9f3b2c1a";
const commentId: string = "comment_4d2e8a7f";
const broadcastId: string = "broadcast_live_2026_06_15_18";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.invalid-signature";
const response: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);
console.log(response);

updateComment

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

updateComment Приклад

Copy

const tenantId: string = 'tenant_7f3c1b2a';
const commentId: string = 'cmt_8d9f2a4b';
const updatableCommentParams: UpdatableCommentParams = {
  body: 'Updating this comment to clarify the feature behavior and include a timestamp.',
  metadata: { category: 'support', editedReason: 'clarify instructions' },
  visible: true
};
const contextUserId: string = 'user_42';
const doSpamCheck: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, commentId, updatableCommentParams, contextUserId, doSpamCheck);

voteComment

Параметри

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

Відповідь

Повертає: VoteComment200Response

Приклад

Приклад voteComment

Copy

const tenantId: string = 'tenant_7f9d2e';
const commentId: string = '5a1d3f9b-2c4e-4a2b-bf7b-1234567890ab';
const urlId: string = 'articles/2026/06/15/typescript-api-patterns';
const broadcastId: string = 'broadcast-20260615-01';
const voteBodyParams: VoteBodyParams = { vote: 'up' };
const sessionId: string = 'sess_9d2f3b45';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY5NzE2MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const response: VoteComment200Response = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

getCommentsForUser

Параметри

Назва	Тип	Обов'язково
userId	string	Ні
direction	SortDirections	Ні
repliesToUserId	string	Ні
page	number	Ні
includei10n	boolean	Ні
locale	string	Ні
isCrawler	boolean	Ні

Відповідь

Повертає: GetCommentsForUser200Response

Приклад

Приклад getCommentsForUser

Copy

const userId: string = "550e8400-e29b-41d4-a716-446655440000";
const page: number = 2;
const includei10n: boolean = true;
const locale: string = "en-US";
const isCrawler: boolean = false;
const comments: GetCommentsForUser200Response = await getCommentsForUser(
  userId,
  undefined, // direction пропущено
  undefined, // repliesToUserId пропущено
  page,
  includei10n,
  locale,
  isCrawler
);
console.log(comments);

addDomainConfig

Параметри

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

Відповідь

Повертає: AddDomainConfig200Response

deleteDomainConfig

Параметри

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

Відповідь

Повертає: DeleteDomainConfig200Response

getDomainConfig

Параметри

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

Відповідь

Повертає: GetDomainConfig200Response

getDomainConfigs

Параметри

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

Відповідь

Повертає: GetDomainConfigs200Response

patchDomainConfig

Параметри

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

Відповідь

Повертає: GetDomainConfig200Response

putDomainConfig

Параметри

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

Відповідь

Повертає: GetDomainConfig200Response

createEmailTemplate

Параметри

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

Відповідь

Повертає: CreateEmailTemplate200Response

Приклад

Приклад createEmailTemplate

Copy

const tenantId: string = "tenant_4f2b1c9e";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "New Comment Notification",
  subject: "Someone replied to your discussion",
  fromName: "Community Team",
  fromAddress: "no-reply@community.example.com",
  htmlBody: "<p>\{{comment.author}} replied: \{{comment.text}}</p>",
  plaintextBody: "\{{comment.author}} replied: \{{comment.text}}",
  previewText: "A new reply on a discussion you follow",
  isDefault: false // необов'язковий прапорець, що демонструє використання необов'язкового параметра
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

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

Copy

const tenantId: string = "tenant_9c4f1b2a";
const id: string = "emailtmpl_4d2b9a5e";
const requestorNote: string | undefined = undefined; // необов'язкові метадані (не вимагаються функцією)
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, id);

deleteEmailTemplateRenderError

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteEmailTemplateRenderError

Copy

const tenantId: string = 'tenant-72f3b4';
const templateId: string = 'email_template-9c3a1';
let providedErrorId: string | undefined = undefined; // необов'язкове значення, може бути встановлене в іншому місці
const errorId: string = providedErrorId ?? 'render_err-5d2f7';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);

getEmailTemplate

Параметри

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

Відповідь

Повертає: GetEmailTemplate200Response

Приклад

Приклад getEmailTemplate

Copy

const tenantId: string = 'tenant_7f3b2c';
const templateId: string = 'welcome-email-2024';
const includeDrafts: boolean | undefined = undefined;
const emailTemplate: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

getEmailTemplateDefinitions

Параметри

Name	Type	Required	Description
tenantId	string	Так

Відповідь

Повертає: GetEmailTemplateDefinitions200Response

Приклад

Приклад getEmailTemplateDefinitions

Copy

(async () => {
  const tenantId: string = 'tenant_acme_001';
  const options: { includeDrafts?: boolean } = { includeDrafts: true }; // продемонстровано необов'язковий параметр
  const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, options);
  console.log(templates);
})();

getEmailTemplateRenderErrors

Параметри

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

Відповідь

Повертає: GetEmailTemplateRenderErrors200Response

Приклад

Приклад getEmailTemplateRenderErrors

Copy

const tenantId: string = 'acme-tenant-01';
const id: string = 'tmpl_7f9a2b4c';
const skip: number = 20;
const errorsWithSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
const errorsFirstPage: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id);

getEmailTemplates

Параметри

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

Відповідь

Повертає: GetEmailTemplates200Response

Приклад

Приклад getEmailTemplates

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme-marketing-tenant-001";
  const templatesDefault: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 25);
  console.log(templatesDefault, templatesPaged);
}
run();

renderEmailTemplate

Параметри

Name	Type	Required
tenantId	string	Так
renderEmailTemplateBody	RenderEmailTemplateBody	Так
locale	string	Ні

Відповідь

Повертає: RenderEmailTemplate200Response

Приклад

Приклад renderEmailTemplate

Copy

const tenantId: string = '7f7e2b90-3a2b-4d9b-9df1-5f0b6b2e8a1c';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'welcome_email',
  recipient: { email: 'jordan.smith@acme.co', name: 'Jordan Smith' },
  variables: { siteName: 'Acme Forum', verificationUrl: 'https://acme.forum/verify?code=abc123' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateEmailTemplate

Copy

const tenantId: string = 'acme-corp-123';
const id: string = 'template-789';
const locale: string | undefined = 'en-US';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  subject: 'Welcome to Acme — Get started',
  bodyHtml: '<p>Hi \{{firstName}}, welcome to Acme. Start by visiting your dashboard.</p>',
  fromName: 'Acme Support',
  fromEmail: 'support@acme.com',
  enabled: true,
  ...(locale ? { locale } : {})
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Параметри

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

Відповідь

Повертає: GetEventLog200Response

Приклад

Приклад getEventLog

Copy

const tenantId: string = 'tenant_9f3a2b';
const urlId: string = 'news/2026/06/fastcomments-release';
const userIdWS: string = 'ws_user_48291';
const startTime: number = Date.now() - 86_400_000;
const endTime: number = Date.now();
const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

getGlobalEventLog

req tenantId urlId userIdWS

Параметри

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

Відповідь

Повертає: GetEventLog200Response

Приклад

Приклад getGlobalEventLog

Copy

const tenantId: string = "tenant_639b7f12";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/important-update-987";
const userIdWS: string = "user_ws_42b7";
const startTime: number = new Date("2026-06-14T00:00:00Z").getTime();
const endTime: number = Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Параметри

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

Відповідь

Повертає: CreateFeedPost200Response

Приклад

Приклад createFeedPost

Copy

const tenantId: string = 'tenant_4f2b1c';
const createFeedPostParams: CreateFeedPostParams = {
  content: 'Launching our summer collection today — check it out!',
  authorId: 'user_879',
  media: [
    {
      type: 'image',
      assets: [
        { url: 'https://cdn.myshop.com/uploads/summer-look.jpg', width: 1200, height: 800 } as FeedPostMediaItemAsset
      ]
    } as FeedPostMediaItem
  ],
  links: [
    { url: 'https://myshop.com/new-arrival', title: 'Summer Collection' } as FeedPostLink
  ],
  allowComments: true
};
const broadcastId: string = 'broadcast-2026-06-15-001';
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const response: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

createFeedPostPublic

Параметри

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

Відповідь

Повертає: CreateFeedPostPublic200Response

Приклад

Приклад createFeedPostPublic

Copy

(async () => {
  const tenantId: string = "tenant_9f8b7c";
  const media: FeedPostMediaItem[] = [{ type: "image", assets: [{ url: "https://cdn.example.com/roadmap.jpg", mimeType: "image/jpeg" }] }];
  const links: FeedPostLink[] = [{ url: "https://company.example.com/roadmap", title: "Full roadmap" }];
  const createFeedPostParams: CreateFeedPostParams = {
    title: "Weekly Product Roadmap Update",
    body: "This week we shipped enhancements to search relevance and fixed top customer bugs.",
    authorId: "user_8321",
    media,
    links,
    visibility: "public"
  };
  const broadcastId: string = "broadcast_2026_06_15";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload";
  const response: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);
  console.log(response);
})();

deleteFeedPostPublic

Параметри

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

Відповідь

Повертає: DeleteFeedPostPublic200Response

Приклад

Приклад deleteFeedPostPublic

Copy

const tenantId: string = 'acme-tenant-42';
const postId: string = 'post_8f3d2a7c';
const broadcastId: string = 'broadcast_2026-06-15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

getFeedPosts

req tenantId afterId

Параметри

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

Відповідь

Повертає: GetFeedPosts200Response

Приклад

Приклад getFeedPosts

Copy

const tenantId: string = "tenant_74321";
const afterId: string = "post_20250610_9b2f3";
const limit: number = 25;
const tags: Array<string> = ["product-updates", "announcements"];
const response: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

getFeedPostsPublic

req tenantId afterId

Параметри

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

Відповідь

Повертає: GetFeedPostsPublic200Response

Приклад

Приклад getFeedPostsPublic

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const afterId: string = 'post_20250610_842';
  const limit: number = 25;
  const tags: string[] = ['news', 'technology'];
  const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1Ni';
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
  console.log(response);
})();

getFeedPostsStats

Параметри

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

Відповідь

Повертає: GetFeedPostsStats200Response

Приклад

Приклад getFeedPostsStats

Copy

const tenantId: string = "tenant_98765";
const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, ssoToken);

getUserReactsPublic

Параметри

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

Response

Повертає: GetUserReactsPublic200Response

Приклад

Приклад getUserReactsPublic

Copy

const tenantId: string = 'fastcomments-tenant-4f2b9c';
const postIds: Array<string> = ['post_7a1f9e', 'post_2b3c88'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTQ0MDAwMH0.signature';
const response: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

reactFeedPostPublic

Параметри

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

Відповідь

Повертає: ReactFeedPostPublic200Response

Приклад

Приклад reactFeedPostPublic

Copy

const tenantId: string = 'acme-tenant-001';
const postId: string = 'feedpost_78901';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_2026_06_15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const response: ReactFeedPostPublic200Response = await reactFeedPostPublic(
  tenantId,
  postId,
  reactBodyParams,
  isUndo,
  broadcastId,
  sso
);

updateFeedPost

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

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

Copy

const tenantId: string = "tenant_72f3b4c9";
const id: string = "post_ba4f6e18-2d3c-4b7a-91f2-8c0e3a6b5d4f";
const feedPost: FeedPost = {
  title: "June feature rollout",
  body: "Announcing performance improvements and moderation updates available to all sites.",
  authorName: "Platform Team",
  mediaItems: [
    {
      type: "image",
      caption: "Release banner",
      asset: { url: "https://cdn.fastcomments.com/assets/june-banner.jpg", mimeType: "image/jpeg", width: 1200, height: 600 }
    }
  ],
  links: [{ title: "Release notes", url: "https://docs.fastcomments.com/releases/june-2026" }]
} as FeedPost;
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Параметри

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

Відповідь

Повертає: CreateFeedPostPublic200Response

Приклад

Приклад updateFeedPostPublic

Copy

const tenantId: string = 'tenant_acme_01';
const postId: string = 'post_20260615_001';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Weekly Update: Product Launch',
  content: 'We shipped the 2.0 release today — highlights and links below.',
  media: [{ url: 'https://cdn.acme.com/releases/launch.jpg', type: 'image' }],
  tags: ['release', 'product'],
  isPublic: true
};
const broadcastId: string = 'broadcast_live_42';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

flagCommentPublic

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

flagCommentPublic Приклад

Copy

const tenantId: string = "tenant_4f1b2a9c";
const commentId: string = "comment_8d3e6f12";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

getGifLarge

Параметри

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

Відповідь

Повертає: GetGifLarge200Response

Приклад

Приклад getGifLarge

Copy

const tenantId: string = "tenant_9f8b7c";
const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/07d3f6_large.gif";
const preferWebP: boolean | undefined = true; // необов'язкова перевага
const urlToUse: string = preferWebP ? largeInternalURLSanitized.replace(".gif", ".webp") : largeInternalURLSanitized;
const response: GetGifLarge200Response = await getGifLarge(tenantId, urlToUse);

getGifsSearch

Параметри

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

Відповідь

Повертає: GetGifsSearch200Response

Приклад

getGifsSearch Приклад

Copy

const tenantId: string = "tenant_acme_9876";
const search: string = "cat playing piano";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 1;
const result: GetGifsSearch200Response = await getGifsSearch(tenantId, search, locale, rating, page);

getGifsTrending

Параметри

Name	Type	Required
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

Відповідь

Повертає: GetGifsTrending200Response

Приклад

Приклад getGifsTrending

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_8b3f2c';
  const locale: string = 'en-US';
  const rating: string = 'pg';
  const page: number = 1;
  const result: GetGifsTrending200Response = await getGifsTrending(tenantId, locale, rating, page);
  console.log(result);
}
main();

addHashTag

Параметри

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

Відповідь

Повертає: AddHashTag200Response

Приклад

Приклад addHashTag

Copy

const tenantId: string | undefined = "tenant_3c9f7b";
const createHashTagBody: CreateHashTagBody = {
  name: "support",
  title: "Support",
  description: "Questions about product usage, bugs, and account issues",
  color: "#0066CC",
  isActive: true,
  aliases: ["help", "customer-service"]
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

addHashTagsBulk

Параметри

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

Відповідь

Повертає: AddHashTagsBulk200Response

Приклад

Приклад addHashTagsBulk

Copy

const tenantId: string = "tenant_acme_corp_987";
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: "product-update", description: "Announcements about new product releases", visible: true },
    { name: "customer-support", description: "Customer support related discussions", visible: false }
  ],
  createdBy: "moderator_jane"
};
const resultWithTenant: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const resultWithoutTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

deleteHashTag

Параметри

Name	Type	Required
tag	string	Так
tenantId	string	Ні
deleteHashTagRequest	DeleteHashTagRequest	Ні

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

deleteHashTag Приклад

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_72a1";
const deleteHashTagRequest: DeleteHashTagRequest = {
  reason: "consolidate-duplicates",
  requestedBy: "moderator@dailypress.com",
  forceDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

getHashTags

Параметри

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

Відповідь

Повертає: GetHashTags200Response

Приклад

Приклад getHashTags

Copy

const tenantId: string = 'tenant_7f4b2c3a';
const tagsFirstPage: GetHashTags200Response = await getHashTags(tenantId);
const tagsSecondPage: GetHashTags200Response = await getHashTags(tenantId, 2);
console.log(tagsFirstPage, tagsSecondPage);

patchHashTag

Параметри

Name	Type	Required
tag	string	Так
tenantId	string	Ні
updateHashTagBody	UpdateHashTagBody	Ні

Відповідь

Повертає: PatchHashTag200Response

Приклад

Приклад patchHashTag

Copy

const tag: string = "feature-request";
const tenantId: string = "tenant_8f7a3b2c";
const updateHashTagBody: UpdateHashTagBody = {
  displayName: "Feature Request",
  description: "Use this tag for requests to add new features to the product",
  enabled: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Параметри

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

Відповідь

Повертає: CreateModerator200Response

Приклад

createModerator Приклад

Copy

const tenantId: string = 'tenant_9f3b21';
const createModeratorBody: CreateModeratorBody = {
  moderator: {
    name: 'Alex Rivera',
    email: 'alex.rivera@fastcomments.io',
    role: 'global_moderator',
    enabled: true,
  },
  // продемонстровано необов'язкові параметри:
  notifyUser: true,
  permissions: ['delete_comment', 'edit_comment', 'ban_user'],
  customConfig: { dashboardTheme: 'dark' } as unknown as CustomConfigParameters
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteModerator

Copy

const tenantId: string = 'tenant_4f3b2c9a';
const id: string = 'mod_9c2d1f7b';
const sendEmail: string = 'true';
const response: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);
console.log(response);

getModerator

Параметри

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

Відповідь

Повертає: GetModerator200Response

Приклад

Приклад getModerator

Copy

const tenantId: string = 'acme-media-58';
const id: string = 'mod-82f3b9c1';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Параметри

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

Відповідь

Повертає: GetModerators200Response

Приклад

Приклад getModerators

Copy

const tenantId: string = 'tenant_0a1b2c3d';
const moderators: GetModerators200Response = await getModerators(tenantId);
const skip: number = 20;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

sendInvite

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

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

Copy

(async () => {
  const tenantId: string = "tenant_acme_42";
  const id: string = "cmt_8f3b21";
  const fromName: string = "Ava Thompson";
  const inviteResult: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);
  console.log(inviteResult);
})();

updateModerator

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateModerator

Copy

const tenantId: string = 'acme-tenant-81';
const id: string = 'mod_7f3a2b';
const updateModeratorBody: UpdateModeratorBody = {
  email: 'j.reyes@acme-corp.com',
  displayName: 'Jordan Reyes',
  roles: ['moderator', 'content_reviewer'],
  active: true,
  notes: 'Promoted to senior moderator; monitor flagged content weekly'
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

deleteNotificationCount

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteNotificationCount

Copy

const tenantId: string = 'tenant_5f3d2e1b';
const id: string = 'notification_9a4b1c2';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);

getCachedNotificationCount

Параметри

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

Відповідь

Повертає: GetCachedNotificationCount200Response

Приклад

Приклад getCachedNotificationCount

Copy

const tenantId: string = 'fastcomments-tenant-23';
const id: string = 'user_987654';
const cachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);
const maybeId: string | undefined = Math.random() > 0.5 ? 'user_123456' : undefined;
if (maybeId) {
  const optionalCachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, maybeId);
}

getNotificationCount

Параметри

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

Відповідь

Повертає: GetNotificationCount200Response

Приклад

Приклад getNotificationCount

Copy

const tenantId: string = 'tenant_82a3b9f';
const userId: string = 'user_43721';
const urlId: string = 'https://news.example.com/articles/2026/06/15/coverage-123';
const fromCommentId: string = 'comment_98765';
const viewed: boolean = false;
const notificationType: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, notificationType);

getNotifications

Параметри

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

Відповідь

Повертає: GetNotifications200Response

Приклад

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

Copy

const tenantId: string = 'tenant_9f8b7c6a';
const userId: string = 'user_5a4b3c2d';
const urlId: string = 'post_84f2a1b9';
const fromCommentId: string = 'cmt_0a1b2c3d';
const viewed: boolean = false;
const type: string = 'reply';
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(
  tenantId,
  userId,
  urlId,
  fromCommentId,
  viewed,
  type,
  skip
);

updateNotification

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateNotification

Copy

const tenantId: string = 'tenant_9f3b2c';
const id: string = 'notification_4a1d2e';
const updateNotificationBody: UpdateNotificationBody = {
  enabled: true,
  channels: ['email', 'push'],
  frequency: 'immediate',
  templateId: 'tmpl_77aa'
} as UpdateNotificationBody;
const userId: string = 'user_2468';
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

createV1PageReact

Параметри

Name	Type	Required
tenantId	string	Так
urlId	string	Так
title	string	Ні

Відповідь

Повертає: CreateV1PageReact200Response

Приклад

Приклад createV1PageReact

Copy

(async () => {
  const tenantId: string = 'b12f3c4d-5678-90ab-cdef-1234567890ab';
  const urlId: string = 'https://www.news-site.com/world/2026/election-results';
  const title: string = 'Election results: key takeaways and analysis';
  const responseWithTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId, title);
  const responseWithoutTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId);
  console.log(responseWithTitle, responseWithoutTitle);
})();

createV2PageReact

Параметри

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

Відповідь

Повертає: CreateV2PageReact200Response

Приклад

Приклад createV2PageReact

Copy

const tenantId: string = "fastcomments-tenant-72";
const urlId: string = "articles/2026/06/15/product-update";
const id: string = "page-8f3b2a";
const title: string = "Product Update: June 15, 2026";
(async function run(): Promise<void> {
  const response: CreateV2PageReact200Response = await createV2PageReact(tenantId, urlId, id, title);
  console.log(response);
})();

deleteV1PageReact

Параметри

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

Відповідь

Повертає: DeleteV1PageReact200Response

Приклад

Приклад deleteV1PageReact

Copy

const tenantId: string = process.env.TENANT_ID ?? 'd3b07384-9f6a-4c2b-8c3e-0a1b2c3d4e5f';
const urlId: string = 'https://acme.com/articles/2026/06/fastcomments-integration';
const result: DeleteV1PageReact200Response = await deleteV1PageReact(tenantId, urlId);

deleteV2PageReact

Параметри

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

Відповідь

Повертає: DeleteV2PageReact200Response

Приклад

Приклад deleteV2PageReact

Copy

const tenantId: string = "tenant_79021";
const urlId: string = "blog/my-first-post";
const id: string = "reaction_9f8b7c";
let includeHistory: boolean | undefined = undefined; // необов'язковий прапорець, використовується в деяких викликах
const result: DeleteV2PageReact200Response = await deleteV2PageReact(tenantId, urlId, id);
console.log(result);

getV1PageLikes

Параметри

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

Відповідь

Повертає: GetV1PageLikes200Response

Приклад

Приклад getV1PageLikes

Copy

const tenantId: string = 'fastcomments-742';
const urlId: string = 'sports/2026/06/15/world-cup-preview';
const pageLikes: GetV1PageLikes200Response = await getV1PageLikes(tenantId, urlId);

getV2PageReacts

Параметри

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

Відповідь

Повертає: GetV2PageReacts200Response

Приклад

Приклад getV2PageReacts

Copy

const tenantId: string = "tenant_82f4b3a9";
const urlId: string = "https://news.site.com/articles/2026/06/15/product-launch";
const response: GetV2PageReacts200Response = await getV2PageReacts(tenantId, urlId);
console.log(response);

getV2PageReactUsers

Параметри

Ім'я	Тип	Обов'язковий
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Відповідь

Повертає: GetV2PageReactUsers200Response

Приклад

Приклад getV2PageReactUsers

Copy

const tenantId: string = "7421";
const urlId: string = "sports/london-marathon";
const id: string = "reactUser-3fa85f64-5717-4562-b3fc-2c963f66afa6";
const includeDeleted: boolean | undefined = undefined; // необов'язковий прапорець (демонстрація)
const result: GetV2PageReactUsers200Response = await getV2PageReactUsers(tenantId, urlId, id);

addPage

Параметри

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

Відповідь

Повертає: AddPageAPIResponse

deletePage

Параметри

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

Відповідь

Повертає: DeletePageAPIResponse

getOfflineUsers

Минулі коментатори на сторінці, які НЕ зараз онлайн. Відсортовано за displayName. Використовуйте це після вичерпання /users/online, щоб відобразити розділ "Учасники". Курсорна пагінація по commenterName: сервер проходить по частковому {tenantId, urlId, commenterName} індексу від afterName вперед через $gt, без витрат на $skip.

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Відповідь

Повертає: GetOfflineUsers200Response

Приклад

Приклад getOfflineUsers

Copy

const tenantId: string = 'tenant_prod_001';
const urlId: string = 'article-2026-06-15-how-ai-impacts';
const afterName: string = 'michael.smith';
const afterUserId: string = 'user_72b9';
const response: GetOfflineUsers200Response = await getOfflineUsers(tenantId, urlId, afterName, afterUserId);

getOnlineUsers

Користувачі, які наразі онлайн на сторінці: люди, чиї websocket-сесії зараз підписані на цю сторінку. Повертає anonCount + totalCount (підписники в межах кімнати, включно з анонімними переглядачами, яких ми не перераховуємо).

Параметри

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

Відповідь

Повертає: GetOnlineUsers200Response

Приклад

Приклад getOnlineUsers

Copy

const tenantId: string = 'tenant_14f9c3';
const urlId: string = 'article_20250615';
const afterName: string = 'marie.curie';
const afterUserId: string = 'u_92b7';
const result: GetOnlineUsers200Response = await getOnlineUsers(tenantId, urlId, afterName, afterUserId);

getPageByURLId

Параметри

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

Відповідь

Повертає: GetPageByURLIdAPIResponse

getPages

Параметри

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

Відповідь

Повертає: GetPagesAPIResponse

getPagesPublic

Перелік сторінок для орендаря. Використовується десктоп-клієнтом FChat для заповнення його списку кімнат. Вимагає, щоб enableFChat було встановлено в true у вирішеній кастомній конфігурації для кожної сторінки. Сторінки, які вимагають SSO, фільтруються відповідно до групового доступу користувача, що виконує запит.

Параметри

Name	Type	Required
tenantId	string	Так
cursor	string	Ні
limit	number	Ні
q	string	Ні
sortBy	PagesSortBy	Ні
hasComments	boolean	Ні

Відповідь

Повертає: GetPagesPublic200Response

Приклад

Приклад getPagesPublic

Copy

const tenantId: string = 'tenant_8f3b2c';
const cursor: string = 'eyJwYWdlIjoiMTIwIn0';
const limit: number = 25;
const q: string = 'homepage hero';
const hasComments: boolean = true;
const response: GetPagesPublic200Response = await getPagesPublic(
  tenantId,
  cursor,
  limit,
  q,
  undefined,
  hasComments
);

getUsersInfo

Зведена інформація про користувачів для tenant. За заданими userIds повертає відображувану інформацію з User / SSOUser. Використовується віджетом коментарів для збагачення користувачів, які щойно з'явилися через подію присутності. Без контексту сторінки: конфіденційність застосовується однаково (приватні профілі замасковані).

Параметри

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

Відповідь

Повертає: GetUsersInfo200Response

Приклад

Приклад getUsersInfo

Copy

const tenantId: string = 'acme-tenant-007';
const userIdsList: string[] = ['user_12a', 'user_34b', 'user_56c'];
const separator: string | undefined = undefined; // необов'язково; якщо undefined, за замовчуванням використовується кома
const ids: string = userIdsList.join(separator ?? ',');
const usersInfo: GetUsersInfo200Response = await getUsersInfo(tenantId, ids);

patchPage

Параметри

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

Відповідь

Повертає: PatchPageAPIResponse

deletePendingWebhookEvent

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deletePendingWebhookEvent

Copy

const tenantId: string = "tenant_5f8d7a34";
const id: string = "webhook_evt_987654321";
const requestNote: string | undefined = undefined;
const response: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);

getPendingWebhookEventCount

Параметри

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

Відповідь

Повертає: GetPendingWebhookEventCount200Response

Приклад

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

Copy

const tenantId: string = 'tenant_9f8b3b';
const commentId: string = 'cmt_1a2b3c';
const eventType: string = 'comment.created';
const domain: string = 'news-site.com';
const attemptCountGT: number = 2;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined, // externalId omitted
  eventType,
  undefined, // type omitted
  domain,
  attemptCountGT
);

getPendingWebhookEvents

Параметри

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

Відповідь

Повертає: GetPendingWebhookEvents200Response

Приклад

Приклад getPendingWebhookEvents

Copy

const tenantId: string = 'tenant_9f3b2a';
const commentId: string = 'cmt_8a7d1';
const eventType: string = 'comment.created';
const domain: string = 'reviews.myshop.com';
const attemptCountGT: number = 1;
const skip: number = 0;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Параметри

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

Відповідь

Повертає: CreateQuestionConfig200Response

Приклад

Приклад createQuestionConfig

Copy

const tenantId: string = "tenant_9f3b1c2a";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  name: "Product feedback",
  key: "product_quality",
  description: "Short survey question shown after posting a comment",
  required: true,
  renderingType: "singleChoice",
  customOptions: [
    { label: "Excellent", value: "5" },
    { label: "Good", value: "4" },
    { label: "Fair", value: "3" }
  ] as QuestionConfigCustomOptionsInner[],
  notifyModerators: false // необов'язковий параметр (продемонстровано)
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteQuestionConfig

Copy

const tenantId: string = 'acme-corp-47a9';
const id: string = 'qcfg_20260615_001';
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

getQuestionConfig

Параметри

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

Відповідь

Повертає: GetQuestionConfig200Response

Приклад

Приклад getQuestionConfig

Copy

const tenantId: string = "acme-corp-47";
const questionId: string = "q-4f2b9a";
const includeDrafts: boolean | undefined = undefined; // заповнювач для необов'язкового параметра
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
console.log(result);

getQuestionConfigs

Параметри

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

Відповідь

Повертає: GetQuestionConfigs200Response

Приклад

Приклад getQuestionConfigs

Copy

const tenantId: string = "tenant_4c9f2b";
const responseWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const skip: number = 50;
const responseWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, skip);

updateQuestionConfig

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateQuestionConfig

Copy

const tenantId: string = "tenant_9f3b8a2e-4c6d-4b4f-a1b2-9e8f7d6c5b3a";
const id: string = "q_7c2e1b4a-5d6f-4a8b-9c3d-2e1f0b9a4c5d";
const options: QuestionConfigCustomOptionsInner[] = [
  { value: "1", label: "Very dissatisfied" },
  { value: "2", label: "Dissatisfied" },
  { value: "3", label: "Neutral" },
  { value: "4", label: "Satisfied" },
  { value: "5", label: "Very satisfied" }
];
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  label: "How satisfied are you with the article?",
  enabled: true,
  required: false, // приклад необов'язкового параметра
  options
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Параметри

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

Відповідь

Повертає: CreateQuestionResult200Response

Приклад

Приклад createQuestionResult

Copy

const tenantId: string = 'fc-tenant-512';
const meta: MetaItem[] = [{ key: 'source', value: 'article' }];
const body: CreateQuestionResultBody = {
  questionId: 'q-94',
  userId: 'user_332',
  answers: [{ optionId: 'opt_a', score: 1 }],
  meta, // необов'язкові метадані
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, body);

deleteQuestionResult

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

deleteQuestionResult Example

Copy

const tenantId: string = "acme-corp-tenant-01";
const id: string = "qres_9f8b7c3a";
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);
const optionalResponse: FlagCommentPublic200Response | undefined = response;

getQuestionResult

Параметри

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

Відповідь

Повертає: GetQuestionResult200Response

Приклад

getQuestionResult Приклад

Copy

const tenantId: string = 'tenant_9f3b2a7c9';
const questionId: string = 'q_8d4f1b2c3a';
const options: { includeMeta?: boolean } = { includeMeta: true }; // демонстрація необов'язкового параметра
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
const apiStatus: APIStatus | undefined = (result as unknown as { apiStatus?: APIStatus }).apiStatus;
const question: QuestionResult | undefined = (result as unknown as { question?: QuestionResult }).question;

getQuestionResults

Параметри

Name	Type	Required
tenantId	string	Так
urlId	string	Ні
userId	string	Ні
startDate	string	Ні
questionId	string	Ні
questionIds	string	Ні
skip	number	Ні

Відповідь

Повертає: GetQuestionResults200Response

Приклад

Приклад getQuestionResults

Copy

const tenantId: string = 'fc-tenant-7a9c';
const urlId: string = 'news/article-2026-06-15';
const userId: string = 'user-8421';
const startDate: string = '2026-05-01T00:00:00Z';
const questionId: string = 'q-13';
const questionIds: string = 'q-13,q-14';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

updateQuestionResult

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateQuestionResult

Copy

const tenantId: string = "tenant_prod_84b2";
const id: string = "question_9f3a";
const updateQuestionResultBody: UpdateQuestionResultBody = {
  outcome: "accepted",
  confidence: 0.88,
  moderatorId: "moderator_17",
  notes: "Validated by automated review" // необов'язкове поле включено
};
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Параметри

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

Відповідь

Повертає: AggregateQuestionResults200Response

Приклад

Приклад aggregateQuestionResults

Copy

const tenantId: string = 'tenant_6f2b3c';
const questionIds: Array<string> = ['q-7a1b2c', 'q-8d3e4f'];
const urlId: string = 'url_9f8e7d';
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, urlId, undefined, startDate, true);

bulkAggregateQuestionResults

Параметри

Name	Type	Required
tenantId	string	Так
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Так
forceRecalculate	boolean	Ні

Відповідь

Повертає: BulkAggregateQuestionResults200Response

Приклад

Приклад bulkAggregateQuestionResults

Copy

const tenantId: string = "tenant_0012";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: "quality_score",
      startTime: "2026-06-01T00:00:00Z",
      endTime: "2026-06-14T00:00:00Z",
      timeBucket: "day",
      dimensions: ["threadId"]
    }
  ],
  includeTotals: true
};
const forceRecalculate: boolean = false;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

combineCommentsWithQuestionResults

Параметри

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

Відповідь

Повертає: CombineCommentsWithQuestionResults200Response

Приклад

Приклад combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant_12345';
const questionId: string = 'q_98765';
const questionIds: string[] = ['q_98765', 'q_12345'];
const urlId: string = 'url_abc123';
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 0;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

addSSOUser

Параметри

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

Відповідь

Повертає: AddSSOUserAPIResponse

deleteSSOUser

Параметри

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

Відповідь

Повертає: DeleteSSOUserAPIResponse

getSSOUserByEmail

Параметри

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

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

getSSOUserById

Параметри

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

Відповідь

Повертає: GetSSOUserByIdAPIResponse

getSSOUsers

Параметри

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

Відповідь

Повертає: GetSSOUsers200Response

patchSSOUser

Параметри

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

Відповідь

Повертає: PatchSSOUserAPIResponse

putSSOUser

Параметри

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

Відповідь

Повертає: PutSSOUserAPIResponse

Приклад

Приклад putSSOUser

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

createSubscription

Параметри

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

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

Приклад createSubscription

Copy

const tenantId: string = "acme-corp-tenant-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_98765",
  planId: "pro_monthly",
  paymentMethod: { type: "card", cardId: "card_abc123" },
  autoRenew: true,
  trialDays: 14, // необов'язковий параметр (демонстрація)
  metadata: { campaign: "spring_launch" } // необов'язковий параметр (демонстрація)
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

deleteSubscription

Параметри

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

Відповідь

Повертає: DeleteSubscriptionAPIResponse

getSubscriptions

Параметри

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

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад getSubscriptions

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

updateSubscription

Параметри

Назва	Тип	Обов'язково
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);

getTenantDailyUsages

Параметри

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

Відповідь

Повертає: GetTenantDailyUsages200Response

Приклад

Приклад getTenantDailyUsages

Copy

const tenantId: string = 'tenant_7a3c2e';
const dailyUsages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, 2026, 6, undefined, 0);

createTenantPackage

Параметри

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

Відповідь

Повертає: CreateTenantPackage200Response

Приклад

Приклад createTenantPackage

Copy

const tenantId: string = "tenant_7890";
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Growth Plan",
  maxSeats: 2500,
  features: {
    moderation: true,
    analytics: true,
    sso: { enabled: true, provider: "saml" }
  },
  billing: { interval: "monthly", priceCents: 19900 },
  // продемонстровано необов'язковий параметр: notes не є обов'язковим, але вказано
  notes: "Onboarding bundle with priority support"
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

deleteTenantPackage

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад deleteTenantPackage

Copy

const tenantId: string = 'acme-corp-tenant-01';
const packageId: string = 'pkg-2026-06-15-001';
const dryRun: boolean | undefined = undefined; // приклад необов'язкового прапорця (не потрібен для виконання функції)
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Параметри

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

Відповідь

Повертає: GetTenantPackage200Response

Приклад

Приклад getTenantPackage

Copy

const tenantId: string = 'tenant_4b8c2a9f';
const packageId: string = 'pkg_7d3e1b5c';
const includeMetadata: boolean | undefined = true;
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Параметри

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

Response

Повертає: GetTenantPackages200Response

Приклад

getTenantPackages Приклад

Copy

const tenantId: string = 'tenant_8421';
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, 25);
const packagesWithoutSkip: GetTenantPackages200Response = await getTenantPackages(tenantId);

replaceTenantPackage

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад replaceTenantPackage

Copy

const tenantId: string = "fastcomments-tenant-114";
const id: string = "pkg-enterprise-2026-06";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: "EnterpriseModeration",
  version: "2.4.7",
  enabled: true,
  apiStatus: { state: "active", lastUpdated: "2026-06-10T12:00:00Z" },
  customConfigParameters: { maxCommentLength: 1200, allowImages: true }, // необов'язкові параметри налаштувань включені
  voteStyle: { style: "updown" }
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

updateTenantPackage

Параметри

Name	Type	Required
tenantId	string	Так
id	string	Так
updateTenantPackageBody	UpdateTenantPackageBody	Так

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateTenantPackage

Copy

const tenantId: string = 'tenant_9f3b2a';
const id: string = 'pkg_pro_2026';
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Pro Plan',
  monthlyPriceUsd: 49,
  isActive: true,
  features: ['moderation', 'analytics', 'sso'],
  trialDays: 14 // необов'язковий параметр (демонстрація)
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Параметри

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

Відповідь

Повертає: CreateTenantUser200Response

Приклад

Приклад createTenantUser

Copy

const tenantId: string = "tenant_7f4a2b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "commenter",
  approved: true,
  displayName: "Jane D." // необов'язково: вказати зручне ім'я
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
console.log(result);

deleteTenantUser

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

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

Copy

const tenantId: string = "tenant_8f3a2b1c4d";
const id: string = "user_62a4f9e0b7";
const deleteComments: string = "true";
const commentDeleteMode: string = "permanent";
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

getTenantUser

Параметри

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

Відповідь

Повертає: GetTenantUser200Response

Приклад

Приклад getTenantUser

Copy

const tenantId: string = 'tenant_ab12c3';
const id: string = 'user_9f8e7d';
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log(response);

getTenantUsers

Параметри

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

Відповідь

Повертає: GetTenantUsers200Response

Приклад

Приклад getTenantUsers

Copy

const tenantId: string = 'tenant_7b8f3a2c-9e4d-4f1a';
const skip: number = 50;
const usersResponseDefault: GetTenantUsers200Response = await getTenantUsers(tenantId);
const usersResponsePaged: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

replaceTenantUser

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад replaceTenantUser

Copy

const tenantId: string = "f3b9a2d1-8b4e-4c6a-9f2b-1d5c4e6a7b8c";
const id: string = "user_92f7c3b1";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: "auth0|1234567890",
  email: "jane.doe@company.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  metadata: { department: "support" }
};
const updateComments: string = "reassign-comments-to-new-user";
const response: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад sendLoginLink

Copy

const tenantId: string = "tenant_0a1b2c3d";
const id: string = "user_984321";
const redirectURL: string = "https://app.acme-corp.com/welcome";
const responseWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
const responseWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);

updateTenantUser

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateTenantUser

Copy

const tenantId: string = 'acme-corp';
const userId: string = 'u_72b9f4';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  suspended: false
};
const updateComments: string = 'Promoted to moderator after review of activity and community feedback';
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, userId, updateTenantUserBody, updateComments);

createTenant

Параметри

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

Відповідь

Повертає: CreateTenant200Response

Приклад

Приклад createTenant

Copy

const tenantId: string = 'acme-news-01';
const createTenantBody: CreateTenantBody = {
  name: 'Acme News',
  domainConfiguration: { primaryDomain: 'news.acme.com', redirectHttps: true } as APIDomainConfiguration,
  importedSites: [{ siteId: 'site-92', url: 'https://news.acme.com' }] as ImportedSiteType[],
  billingInfo: { planId: 'business_monthly', contactEmail: 'billing@acme.com' } as BillingInfo
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

deleteTenant

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

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

Copy

const tenantId: string = 'tenant_742b9c';
const flagId: string = 'flag_1a2b3c';
const resultWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId);
const sureConfirmation: string = 'confirmed';
const resultWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId, sureConfirmation);

getTenant

Параметри

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

Відповідь

Повертає: GetTenant200Response

Приклад

Приклад getTenant

Copy

const tenantId: string = 'fc_tenant_6b3e2a';
const id: string = 'site_42f1';
const tenantResponse: GetTenant200Response = await getTenant(tenantId, id);
const tenant: APITenant | undefined = tenantResponse.tenant;
const primaryDomain: APIDomainConfiguration | undefined = tenant?.domainConfiguration?.[0];

getTenants

Параметри

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

Відповідь

Повертає: GetTenants200Response

Приклад

Приклад getTenants

Copy

const tenantId: string = "fcom-tenant-8b4f2a1c";
const meta: string = "include=domains,billing&status=active";
const skip: number = 20;
const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
console.log(response);

updateTenant

Параметри

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

Відповідь

Повертає: FlagCommentPublic200Response

Приклад

Приклад updateTenant

Copy

const tenantId: string = 'tenant_84f12';
const id: string = 'flag_192b';
const updateTenantBody: UpdateTenantBody = {
  name: 'Acme Media',
  billingInfo: { plan: 'enterprise', seats: 25, nextBillingDate: '2026-07-01' },
  apiDomainConfiguration: { primaryDomain: 'comments.acme.com', additionalDomains: ['acme.com'] },
  importedSites: [{ siteUrl: 'https://blog.acme.com', archived: false }], // необов'язково
  commentSettings: { htmlRenderingMode: 'sanitized', deletionMode: 'soft' } // необов'язково
} as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Параметри

Name	Type	Required
tenantId	string	Так
userId	string	Так
id	string	Так
changeTicketStateBody	ChangeTicketStateBody	Так

Відповідь

Повертає: ChangeTicketState200Response

Приклад

Приклад changeTicketState

Copy

const tenantId: string = 'tenant_8a7d3f4b';
const userId: string = 'user_5d1a9b2c';
const id: string = 'ticket_1024';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'closed',
  notifyParticipants: true, // продемонстровано необов'язковий параметр
  comment: 'Resolved by support — follow-up not required.'
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

createTicket

Параметри

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

Відповідь

Повертає: CreateTicket200Response

Приклад

Приклад createTicket

Copy

const tenantId: string = 'tenant_acme_corp';
const userId: string = 'moderator_jane';
const createTicketBody: CreateTicketBody = {
  subject: 'Mass spam reports on article 789',
  description: 'Multiple identical spam comments posted under article 789. Needs moderation and bulk removal.',
  priority: 'high',
  contactEmail: 'jane@acme-corp.com',
  metadata: { articleId: '789', reportedCount: 12 } // наведено необов'язкові метадані
};
const ticket: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

getTicket

Параметри

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

Відповідь

Повертає: GetTicket200Response

Приклад

Приклад getTicket

Copy

const tenantId: string = 'acme-corp';
const ticketId: string = 'TCKT-20250615-42';
const userId: string = 'user_84b2';
const ticketWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);
console.log(ticketWithUser.id, ticketWithoutUser.id);

getTickets

Параметри

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

Відповідь

Повертає: GetTickets200Response

Приклад

Приклад getTickets

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_87b3';
const state: number = 2;
const skip: number = 0;
const limit: number = 50;
const tickets: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);

getTranslations

Параметри

Назва	Тип	Обов'язкове
namespace	string	Так
component	string	Так
locale	string	Ні
useFullTranslationIds	boolean	Ні

Відповідь

Повертає: GetTranslations200Response

Приклад

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

Copy

const namespaceName: string = 'site-ui';
const componentName: string = 'comment-widget';
const locale: string = 'fr-FR';
const useFullTranslationIds: boolean = true;
const translationsWithLocale: GetTranslations200Response = await getTranslations(namespaceName, componentName, locale, useFullTranslationIds);
const translationsDefault: GetTranslations200Response = await getTranslations(namespaceName, componentName);

uploadImage

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

Параметри

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

Відповідь

Повертає: UploadImageResponse

getUserBadgeProgressById

Параметри

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

Відповідь

Повертає: GetUserBadgeProgressById200Response

Приклад

Приклад getUserBadgeProgressById

Copy

const tenantId: string = 'fastcomments-tenant-241';
const badgeId: string = 'user-78b3d-badge-3';
const response: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, badgeId);
const progress: UserBadgeProgress | undefined = (response as unknown as { progress?: UserBadgeProgress }).progress;
const percentComplete: number | undefined = progress?.percentage;
console.log('Badge progress percent complete:', percentComplete);

getUserBadgeProgressByUserId

Параметри

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

Відповідь

Повертає: GetUserBadgeProgressById200Response

Приклад

Приклад getUserBadgeProgressByUserId

Copy

const tenantId: string = 'acme-inc-tenant-01';
const userId: string = 'user_73c9b2';
const progress: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
async function maybeFetchProgress(tenant: string, user?: string): Promise<GetUserBadgeProgressById200Response | null> {
  if (!user) return null;
  return await getUserBadgeProgressByUserId(tenant, user);
}
const optionalResult: GetUserBadgeProgressById200Response | null = await maybeFetchProgress(tenantId, userId);

getUserBadgeProgressList

Параметри

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

Відповідь

Повертає: GetUserBadgeProgressList200Response

Приклад

Приклад getUserBadgeProgressList

Copy

const tenantId: string = 'tenant_4f3a2b9c';
const userId: string = 'user_7721d';
const limit: number = 20;
const skip: number = 0;
const result: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);

createUserBadge

Параметри

Name	Type	Required	Description
tenantId	string	Так
createUserBadgeParams	CreateUserBadgeParams	Так

Відповідь

Повертає: CreateUserBadge200Response

Приклад

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

Copy

const tenantId: string = "tenant_7f4b2a";
const createUserBadgeParams: CreateUserBadgeParams = {
  code: "top_contributor",
  title: "Top Contributor",
  description: "Awarded for 100 high-quality comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top_contributor.svg",
  isActive: true,
  criteria: { commentsRequired: 100 },
  customConfig: { displayOnProfile: true } // демонструється необов'язковий параметр
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

deleteUserBadge

Параметри

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

Відповідь

Повертає: UpdateUserBadge200Response

Приклад

Приклад deleteUserBadge

Copy

const tenantId: string = "tenant_8b3f2c7a";
const badgeIdOptional: string | undefined = Math.random() > 0.5 ? "badge_4f9a21" : undefined;
const id: string = badgeIdOptional ?? "badge_backup_01";
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Параметри

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

Відповідь

Повертає: GetUserBadge200Response

Приклад

Приклад getUserBadge

Copy

(async () => {
  const tenantId: string = 'tenant_6b8f2a1c';
  const id: string = 'badge_9f3d4b2a';
  const response: GetUserBadge200Response = await getUserBadge(tenantId, id);
  const badge: UserBadge | undefined = response.userBadge;
  const badgeName: string | undefined = badge?.name;
  console.log('Retrieved badge name:', badgeName);
})();

getUserBadges

Параметри

Назва	Тип	Обов'язково
tenantId	string	Yes
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

Відповідь

Повертає: GetUserBadges200Response

Приклад

Приклад getUserBadges

Copy

const tenantId: string = 'tenant_7f9a12';
const userId: string = 'user_42b7';
const badgeId: string = 'badge_top_contributor';
const type: number = 2;
const displayedOnComments: boolean = true;
const limit: number = 25;
const skip: number = 0;
const badges: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Параметри

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

Відповідь

Повертає: UpdateUserBadge200Response

Приклад

updateUserBadge Приклад

Copy

const tenantId: string = "tenant_9a8b7c";
const id: string = "badge_a1b2c3";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  title: "Community Helper",
  description: "Awarded for providing 50 helpful answers",
  iconUrl: "https://cdn.fastcomments.com/badges/community-helper.png",
  isActive: true,
  expiryDate: undefined
};
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

getUserNotificationCount

Параметри

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

Відповідь

Повертає: GetUserNotificationCount200Response

Приклад

Приклад getUserNotificationCount

Copy

const tenantId: string = 'tenant_acme_01';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const notificationCountNoSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const notificationCountWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);

getUserNotifications

Параметри

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

Відповідь

Повертає: GetUserNotifications200Response

Приклад

Приклад getUserNotifications

Copy

const tenantId: string = "tenant_8271";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/ai-updates";
const pageSize: number = 25;
const afterId: string = "notif_abc123";
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 86_400_000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const includeTenantNotifications: boolean = true;
const sso: string = "sso_token_xyz_987";
const notifications: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  urlId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  includeTenantNotifications,
  sso
);

resetUserNotificationCount

Параметри

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

Відповідь

Повертає: ResetUserNotifications200Response

Приклад

Приклад resetUserNotificationCount

Copy

const tenantId: string = "tenant_8a3f2b6c";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyX2QxMjM0IiwiaWF0IjoxNjI1MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resetResponseWithSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
const resetResponseWithoutSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);

resetUserNotifications

Параметри

Name	Type	Required
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Відповідь

Повертає: ResetUserNotifications200Response

Приклад

Приклад resetUserNotifications

Copy

const tenantId: string = "tenant_9b1f2";
const afterId: string = "notification_0001";
const afterCreatedAt: number = Date.now() - 60 * 60 * 1000; // годину тому
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = "sso_session_7f2d";
const result: ResetUserNotifications200Response = await resetUserNotifications(
  tenantId,
  afterId,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  sso
);

updateUserNotificationCommentSubscriptionStatus

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

Параметри

Name	Type	Required
tenantId	string	Так
notificationId	string	Так
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Так
commentId	string	Так
sso	string	Ні

Відповідь

Повертає: UpdateUserNotificationStatus200Response

Приклад

updateUserNotificationCommentSubscriptionStatus Приклад

Copy

const tenantId: string = 'f3a9c8b0-4d2e-4f8a-9c3b-1234567890ab';
const notificationId: string = '62a1f4d2-8c7b-4e1a-aaa1-abcdef123456';
const commentId: string = '7e4a2b1c-1234-5678-90ab-cdef12345678';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptedIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

updateUserNotificationPageSubscriptionStatus

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

Параметри

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

Відповідь

Повертає: UpdateUserNotificationStatus200Response

Приклад

Приклад updateUserNotificationPageSubscriptionStatus

Copy

const tenantId: string = 'tenant_7f3b2';
const urlId: string = 'article_987';
const url: string = 'https://www.news-site.com/articles/2026/pasta-guide';
const pageTitle: string = 'The Definitive Guide to Cooking Pasta';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso-token-62b9f1';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

updateUserNotificationStatus

Параметри

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

Відповідь

Повертає: UpdateUserNotificationStatus200Response

Приклад

Приклад updateUserNotificationStatus

Copy

const tenantId: string = 'tenant_5f2a8b9c';
const notificationId: string = 'notif_987654321';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

getUserPresenceStatuses

Параметри

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

Відповідь

Повертає: GetUserPresenceStatuses200Response

Приклад

Приклад getUserPresenceStatuses

Copy

const tenantId: string = 'tenant_42';
const urlIdWS: string = 'wss://comments.fastsite.com/ws/tenant_42';
const userIds: string = 'user_9012,user_3478';
const includePresenceMetadata: boolean | undefined = true; // приклад необов'язкового параметра
const presenceStatuses: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Параметри

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

Відповідь

Повертає: SearchUsers200Response

Приклад

Приклад searchUsers

Copy

const tenantId: string = 'tenant_7890';
const urlId: string = 'news/2026-06-15-world-cup-final';
const usernameStartsWith: string = 'mar';
const mentionGroupIds: string[] = ['staff', 'trusted-commenters'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0NTY3OCJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Commenters;
const response: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

getUser

Параметри

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

Відповідь

Повертає: GetUser200Response

Приклад

Приклад getUser

Copy

const tenantId: string = 'fastcomments_corp';
const id: string = 'user_9f8b7c6d-5e4a-3b2c-1f0e-123456789abc';
const response: GetUser200Response = await getUser(tenantId, id);
const userEmail: string | undefined = response.user?.email;
const displayName: string | undefined = response.user?.displayName

createVote

Параметри

Name	Type	Required
tenantId	string	Так
commentId	string	Так
direction	CreateVoteDirectionEnum	Так
userId	string	Ні
anonUserId	string	Ні

Відповідь

Повертає: VoteComment200Response

Приклад

Приклад createVote

Copy

const tenantId: string = 'fastcomments-tenant-001';
const commentId: string = 'cmt_8f3b2a9d';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const userId: string = 'user_5021';
const anonUserId: string = 'anon_7a9c';
const voteResponse: VoteComment200Response = await createVote(tenantId, commentId, direction, userId, anonUserId);

deleteVote

Параметри

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

Відповідь

Повертає: DeleteCommentVote200Response

Приклад

Приклад deleteVote

Copy

(async () => {
  const tenantId: string = 'tenant_8421';
  const id: string = 'vote_3f9b7c2a';
  const editKey: string = 'edit_7Xk9LpQ';
  const responseWithoutEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id);
  const responseWithEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
  console.log(responseWithoutEdit, responseWithEdit);
})();

getVotes

Параметри

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

Відповідь

Повертає: GetVotes200Response

Приклад

Приклад getVotes

Copy

const tenantId: string = 'tenant_7f8e91c2';
const urlId: string = 'https://www.sportsdaily.com/news/2026/06/15/championship-game-recap';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
console.log(votes);

getVotesForUser

Параметри

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

Відповідь

Повертає: GetVotesForUser200Response

Приклад

Приклад getVotesForUser

Copy

const tenantId: string = 'tenant_9b8f7c6d';
const urlId: string = 'articles/product-update-2026';
const userId: string = 'user_c12345';
const anonUserId: string = 'anon_7f4e2a';
const votes: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);

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

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

Внесок

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

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

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

Довідник API

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

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

Агрегація

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

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

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

Коментарі

Коментарі користувача

Налаштування доменів

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

Журнал подій

Пости стрічки

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

GIF-и

Хештеги

Модератори

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

Сповіщення

Реакції сторінки

Сторінки

Очікувані події вебхуків

Налаштування питань

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

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

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

Підписки

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

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

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

Орендарі

Тикети

Переклади

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

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

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

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

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

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

Користувачі

Голоси

FastComments SDK для JavaScript/TypeScript

Репозиторій

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Типові випадки використання

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

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

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

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

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

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

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

Отримання userIdWS

Broadcast IDs

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

aggregate

Параметри

Відповідь

Приклад

getAuditLogs