FastComments JavaScript/TypeScript-SDK

Dies ist das offizielle JavaScript/TypeScript-SDK für FastComments.

Verwalten Sie Kommentare, Benutzer, SSO und Moderation von Node.js oder dem Browser aus.

Repository

Installation

npm install fastcomments-sdk

API-Dokumentation

Vollständige API-Referenz: docs/api/README.md

Browser- vs. Server-Kompatibilität

Dieses SDK verwendet zwei Einstiegspunkte, um optimale Kompatibilität sicherzustellen und Laufzeitfehler zu vermeiden:

fastcomments-sdk/browser - Browser-sichere Version mit nativer fetch-Unterstützung
fastcomments-sdk/server - Vollständige Node.js-Version mit SSO-Unterstützung
fastcomments-sdk (Standard) - Nur Typen, sicher überall zu importieren

Verwendung

Dieses SDK bietet getrennte Einstiegspunkte für Browser- und Server-Umgebungen, um optimale Kompatibilität und Sicherheit zu gewährleisten:

Browser-Nutzung (Clientseitig)

Für Browser-/Frontend-Anwendungen verwenden Sie den browser-sicheren Export, der Node.js-Abhängigkeiten ausschließt:

// Browser-sicherer Import (keine Node.js-Abhängigkeiten)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

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

// Verwende öffentliche APIs (kein API-Schlüssel erforderlich - sicher für Browser)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server-Nutzung (Node.js)

Für Server-/Backend-Anwendungen verwenden Sie das vollständige SDK mit SSO- und Authentifizierungsfunktionen:

// Serverseitiger Import (inkl. SSO und für NodeJS ausgelegt)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Halten Sie diesen geheim auf dem Server!
  basePath: 'https://fastcomments.com' // optional, Standardwert ist https://fastcomments.com
});

// Verwenden Sie geschützte APIs mit Ihrem API-Schlüssel
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Nur Typen-Import

Wenn Sie nur TypeScript-Typen benötigen (kein Laufzeitcode), verwenden Sie den Standardimport:

// Nur Typen (keine Laufzeitabhängigkeiten - überall sicher)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Verwendung einzelner API-Klassen

Browser-Umgebung

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

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

const publicApi = new PublicApi(config);

Server-Umgebung

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

Öffentliche vs. gesicherte APIs

Das SDK stellt drei Haupt-API-Klassen bereit:

DefaultApi - Gesicherte Endpunkte, die deinen API-Schlüssel zur Authentifizierung erfordern. Verwende diese für serverseitige Operationen.
PublicApi - Öffentliche Endpunkte, die ohne API-Schlüssel zugänglich sind. Diese können direkt aus Browsern/Mobilgeräten/etc. aufgerufen werden.
HiddenApi - Interne/Admin-Endpunkte für fortgeschrittene Anwendungsfälle.

Beispiel: Verwendung der Public API (browser-sicher)

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

const publicApi = new PublicApi();

// Kommentare für eine Seite abrufen (kein API-Schlüssel erforderlich)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Beispiel: Verwendung der Default API (nur serverseitig)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Dies geheim halten!
});
const defaultApi = new DefaultApi(config);

// Kommentare mit vollem Admin-Zugriff abrufen
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On)-Integration

FastComments unterstützt SSO, um sich in Ihr bestehendes Benutzerauthentifizierungssystem zu integrieren. Die SSO-Funktionalität ist nur im Server-Export verfügbar, da sie Node.js-Crypto-Funktionen benötigt.

Einfache SSO (nur serverseitig)

Einfache SSO sollte serverseitig erzeugt und an den Client gesendet werden:

// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Erstelle einfache SSO mit dem eingebauten Helfer  
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();

// Sende ssoToken an Ihren Client-Code
// Der Client-Code kann dieses Token dann mit dem Browser-SDK verwenden

Sichere SSO (serverseitig, empfohlen)

Sichere SSO sollte serverseitig implementiert werden und bietet bessere Sicherheit:

// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Erstelle sichere SSO mit dem eingebauten Helfer
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();

// Mit API-Aufrufen auf dem Server verwenden
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Oder sende ssoConfig an den Client zur Browser-Verwendung

Verwendung von SSO im Browser (mit servergeneriertem Token)

// Client-seitiger Code (Browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Hole SSO-Token von Ihrem Server-Endpunkt
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 // Use the server-generated SSO token
});

SSO mit Kommentar-Erstellung

// Server-seitig: SSO und Kommentar erstellen
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)
});

Häufige Anwendungsfälle

Kommentare für eine Seite abrufen

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

Einen Kommentar erstellen

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

Für einen Kommentar abstimmen

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 für Upvote, -1 für Downvote
  }
});

Benutzerverwaltung (erfordert API-Schlüssel)

// Benutzer suchen (erfordert DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live-Events (Echtzeit-Aktualisierungen)

Abonnieren Sie Live-Ereignisse, um Echtzeit-Updates für Kommentare, Abstimmungen und andere Aktivitäten zu erhalten.

Ereignisse auf Seitenebene

Abonnieren Sie Live-Ereignisse für eine bestimmte Seite (Kommentare, Abstimmungen usw.):

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

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

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Aktualisieren Sie Ihre UI mit dem neuen Kommentar
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Aktualisieren Sie die Abstimmungszahlen in Ihrer UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Geben Sie true zurück, wenn das Ereignis verarbeitet wurde
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

Benutzerbezogene Ereignisse abonnieren

Abonnieren Sie benutzerspezifische Ereignisse (Benachrichtigungen, Erwähnungen usw.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Benachrichtigung in Ihrer UI anzeigen
        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');
  }
);

// Close when done
userSubscription.close();

Abrufen von userIdWS

Der userIdWS Parameter wird für Live-Ereignisse benötigt und kann aus API-Antworten abgerufen werden:

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

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast-IDs

Sie werden sehen, dass Sie in einigen API-Aufrufen eine broadcastId übergeben sollen. Wenn Sie Ereignisse erhalten, bekommen Sie diese ID zurück, sodass Sie das Ereignis ignorieren können, falls Sie Änderungen auf dem Client optimistisch anwenden möchten (was Sie wahrscheinlich tun sollten, da es die beste Erfahrung bietet). Geben Sie hier eine UUID an. Die ID sollte so eindeutig sein, dass sie in einer Browsersitzung nicht zweimal vorkommt.

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() // Eindeutige ID für diese Operation
  }
});

Fehlerbehandlung

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

aggregieren

Fasst Dokumente zusammen, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
aggregationRequest	AggregationRequest	Ja
parentTenantId	string	Nein
includeStats	boolean	Nein

Antwort

Gibt zurück: AggregationResponse

Audit-Protokolle abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
limit	number	Nein
skip	number	Nein
order	SORTDIR	Nein
after	number	Nein
before	number	Nein

Antwort

Gibt zurück: GetAuditLogs200Response

Beispiel

getAuditLogs Beispiel

Copy

const tenantId: string = 'tenant_9a8b7c';
const limit: number = 100;
const skip: number = 0;
const after: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // vor 30 Tagen
const before: number = Date.now();
const auditLogs: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, undefined, after, before);

Vom Kommentar blockieren (öffentlich)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nein

Antwort

Gibt zurück: BlockFromCommentPublic200Response

Beispiel

blockFromCommentPublic Beispiel

Copy

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

Kommentar entsperren (öffentlich)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nein

Antwort

Gibt zurück: UnBlockCommentPublic200Response

Beispiel

unBlockCommentPublic Beispiel

Copy

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

Gesperrte Kommentare prüfen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentIds	string	Ja
sso	string	Nein

Antwort

Gibt zurück: CheckedCommentsForBlocked200Response

Beispiel

checkedCommentsForBlocked Beispiel

Copy

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

Benutzer vom Kommentar blockieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
blockFromCommentParams	BlockFromCommentParams	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: BlockFromCommentPublic200Response

Beispiel

blockUserFromComment Beispiel

Copy

const tenantId: string = 'acme-corp';
const id: string = 'comment_7f3b2a9c';
const blockFromCommentParams: BlockFromCommentParams = {
  reason: 'Repeated abusive language and targeted harassment',
  durationDays: 90,
  preventReposting: true
};
const userId: string = 'user_12345';
const anonUserId: string = 'anon_98765';
const result: BlockFromCommentPublic200Response = await blockUserFromComment(
  tenantId,
  id,
  blockFromCommentParams,
  userId,
  anonUserId
);

Öffentlichen Kommentar erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
commentData	CommentData	Ja
sessionId	string	Nein
sso	string	Nein

Antwort

Rückgabe: CreateCommentPublic200Response

Beispiel

createCommentPublic Beispiel

Copy

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

Kommentar löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
contextUserId	string	Nein
isLive	boolean	Nein

Antwort

Gibt zurück: DeleteComment200Response

Beispiel

deleteComment Beispiel

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "comment_5f3a2b7c";
const contextUserId: string = "user_1229";
const isLive: boolean = true;
const response: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

Öffentlichen Kommentar löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Antwort

Gibt zurück: DeleteCommentPublic200Response

Beispiel

Beispiel für deleteCommentPublic

Copy

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

Kommentarwertung löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
voteId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: DeleteCommentVote200Response

Beispiel

deleteCommentVote Beispiel

Copy

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

Kommentar melden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: FlagComment200Response

Beispiel

flagComment Beispiel

Copy

const tenantId: string = 'tenant_7f3b21';
const commentId: string = 'cmt_9a2b4';
const userId: string = 'user_1024';
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

Kommentar abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetComment200Response

Beispiel

getComment Beispiel

Copy

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

Kommentare abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
page	number	Nein
limit	number	Nein
skip	number	Nein
asTree	boolean	Nein
skipChildren	number	Nein
limitChildren	number	Nein
maxTreeDepth	number	Nein
urlId	string	Nein
userId	string	Nein
anonUserId	string	Nein
contextUserId	string	Nein
hashTag	string	Nein
parentId	string	Nein
direction	SortDirections	Nein

Antwort

Gibt zurück: GetComments200Response

Beispiel

getComments Beispiel

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // Seite
  20, // Limit
  0, // Überspringen
  true, // als Baumstruktur
  1, // Kinder überspringen
  3, // maximale Kinderanzahl
  4, // maximale Baumtiefe
  'articles/2026/new-product-launch', // URL-ID
  'user_7890', // Benutzer-ID
  'anon_4f3b2', // anonyme Benutzer-ID
  undefined, // Kontext-Benutzer-ID
  '#launch', // Hashtag
  undefined // Eltern-ID
);

Öffentliche Kommentare abrufen

req tenantId urlId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
page	number	Nein
direction	SortDirections	Nein
sso	string	Nein
skip	number	Nein
skipChildren	number	Nein
limit	number	Nein
limitChildren	number	Nein
countChildren	boolean	Nein
fetchPageForCommentId	string	Nein
includeConfig	boolean	Nein
countAll	boolean	Nein
includei10n	boolean	Nein
locale	string	Nein
modules	string	Nein
isCrawler	boolean	Nein
includeNotificationCount	boolean	Nein
asTree	boolean	Nein
maxTreeDepth	number	Nein
useFullTranslationIds	boolean	Nein
parentId	string	Nein
searchText	string	Nein
hashTags	Array	Nein
userId	string	Nein
customConfigStr	string	Nein
afterCommentId	string	Nein
beforeCommentId	string	Nein

Antwort

Gibt zurück: GetCommentsPublic200Response

Beispiel

getCommentsPublic Beispiel

Copy

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

Kommentartext abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: GetCommentText200Response

Beispiel

Beispiel für getCommentText

Copy

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

Nutzernamen der Kommentarwertungen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
dir	number	Ja
sso	string	Nein

Antwort

Gibt zurück: GetCommentVoteUserNames200Response

Beispiel

getCommentVoteUserNames Beispiel

Copy

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

Kommentar sperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: LockComment200Response

Beispiel

lockComment Beispiel

Copy

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

Kommentar anpinnen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: PinComment200Response

Beispiel

pinComment Beispiel

Copy

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

Kommentar speichern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	CreateCommentParams	Ja
isLive	boolean	Nein
doSpamCheck	boolean	Nein
sendEmails	boolean	Nein
populateNotifications	boolean	Nein

Antwort

Gibt zurück: SaveComment200Response

Beispiel

saveComment Beispiel

Copy

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

Kommentare im Stapel speichern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	Array	Ja
isLive	boolean	Nein
doSpamCheck	boolean	Nein
sendEmails	boolean	Nein
populateNotifications	boolean	Nein

Antwort

Gibt zurück: Array<SaveComment200Response

Beispiel

saveCommentsBulk Beispiel

Copy

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

Kommentartext setzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
commentTextUpdateRequest	CommentTextUpdateRequest	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: SetCommentText200Response

Beispiel

Beispiel für setCommentText

Copy

const tenantId: string = 'tenant-42';
const commentId: string = 'cmt-8932';
const broadcastId: string = 'brd-2023-07';
const updateRequest: CommentTextUpdateRequest = {
  text: 'Updated comment text for the product launch — congrats team!',
  mentions: [{ userId: 'user-17', displayName: 'Ava Nguyen' }] as CommentUserMentionInfo[],
  hashtags: [{ tag: 'ProductLaunch' }] as CommentUserHashTagInfo[]
};
const editKey: string = 'edtk-9f7b';
const sso: string = 'sso-token-abc123';
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, updateRequest, editKey, sso);

Benutzer vom Kommentar entsperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
unBlockFromCommentParams	UnBlockFromCommentParams	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: UnBlockCommentPublic200Response

Beispiel

unBlockUserFromComment Beispiel

Copy

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

Kommentarmeldung zurücksetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: FlagComment200Response

Beispiel

unFlagComment Beispiel

Copy

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

Kommentar entsperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: LockComment200Response

Beispiel

unLockComment Beispiel

Copy

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

Kommentar von Pinnung entfernen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: PinComment200Response

Beispiel

Beispiel für unPinComment

Copy

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

Kommentar aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updatableCommentParams	UpdatableCommentParams	Ja
contextUserId	string	Nein
doSpamCheck	boolean	Nein
isLive	boolean	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateComment

Copy

const tenantId: string = "tenant_3f47b2a1";
const id: string = "comment_9a12b3c4";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Thanks for the update — I've adjusted my view accordingly."
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

Kommentar bewerten

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
voteBodyParams	VoteBodyParams	Ja
sessionId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: VoteComment200Response

Beispiel

Beispiel für voteComment

Copy

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

Kommentare für Benutzer abrufen

Parameter

Name	Typ	Erforderlich
userId	string	Nein
tenantId	string	Nein
urlId	string	Nein
page	number	Nein
direction	SortDirections	Nein
lastGenDate	number	Nein
repliesToUserId	string	Nein
fetchPageForCommentId	string	Nein
includei10n	boolean	Nein
useFullTranslationIds	boolean	Nein
locale	string	Nein
includeConfig	boolean	Nein
includeNotificationCount	boolean	Nein
countAll	boolean	Nein
sso	string	Nein

Antwort

Gibt zurück: GetCommentsForUserResponse

Beispiel

getCommentsForUser Beispiel

Copy

const userId: string = 'user_82f9b';
const tenantId: string = 'tenant_22';
const page: number = 2;
const lastGenDate: number = Date.now();
const includei10n: boolean = true;
const useFullTranslationIds: boolean = false;
const locale: string = 'en-US';
const includeConfig: boolean = true;
const includeNotificationCount: boolean = true;
const countAll: boolean = false;
const sso: string = 'sso-token-1a2b';
const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(userId, tenantId, undefined, page, undefined, lastGenDate, undefined, undefined, includei10n, useFullTranslationIds, locale, includeConfig, includeNotificationCount, countAll, sso);

Domain-Konfiguration hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Ja

Antwort

Gibt zurück: AddDomainConfig200Response

Domain-Konfiguration löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Ja

Antwort

Gibt zurück: DeleteDomainConfig200Response

Domain-Konfiguration abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Ja

Antwort

Gibt zurück: GetDomainConfig200Response

Domain-Konfigurationen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: GetDomainConfigs200Response

Domain-Konfiguration patchen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
domainToUpdate	string	Ja
patchDomainConfigParams	PatchDomainConfigParams	Ja

Antwort

Gibt zurück: GetDomainConfig200Response

Domain-Konfiguration ersetzen (PUT)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
domainToUpdate	string	Ja
updateDomainConfigParams	UpdateDomainConfigParams	Ja

Antwort

Gibt zurück: GetDomainConfig200Response

E-Mail-Vorlage erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Ja

Antwort

Gibt zurück: CreateEmailTemplate200Response

Beispiel

createEmailTemplate Beispiel

Copy

(async () => {
  const tenantId: string = 'tenant_9f4a2b';
  const createEmailTemplateBody: CreateEmailTemplateBody = {
    name: 'Weekly Digest',
    subject: 'Your weekly discussion highlights',
    html: '<!doctype html><body><h1>Hello \{{user.name}}</h1><p>Top comments this week...</p></body>',
    fromAddress: 'no-reply@fastcomments-example.com',
    replyTo: 'moderation@fastcomments-example.com',
    isDefault: false
  };
  const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);
  console.log(result);
})();

E-Mail-Vorlage löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteEmailTemplate Beispiel

Copy

const tenantId: string = "acme-corp-42";
const idSuffix: string | undefined = "-archived";
const templateId: string = "email_tmpl_6a1b2c" + (idSuffix ?? "");
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

Render-Fehler der E-Mail-Vorlage löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
errorId	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteEmailTemplateRenderError Beispiel

Copy

const tenantId: string = "tenant_7a1d2f9b";
const id: string = "email_template_42b1";
const errorId: string = "render_err_2026-04-24_7f3c";
const includeStackTrace: boolean | undefined = undefined; // optionales Flag-Beispiel
const response: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
// Wenn ein optionales Optionsobjekt unterstützt würde, könnte es so aussehen:
// await deleteEmailTemplateRenderError(tenantId, id, errorId /*, { includeStackTrace } */);

E-Mail-Vorlage abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetEmailTemplate200Response

Beispiel

Beispiel für getEmailTemplate

Copy

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

Definitionen der E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: GetEmailTemplateDefinitions200Response

Beispiel

Beispiel für getEmailTemplateDefinitions

Copy

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

Render-Fehler der E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetEmailTemplateRenderErrors200Response

Beispiel

Beispiel für getEmailTemplateRenderErrors

Copy

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

E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetEmailTemplates200Response

Beispiel

getEmailTemplates Beispiel

Copy

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

E-Mail-Vorlage rendern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Ja
locale	string	Nein

Antwort

Gibt zurück: RenderEmailTemplate200Response

Beispiel

renderEmailTemplate Beispiel

Copy

const tenantId: string = 'acme-corp-987';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'user-invite',
  subject: "You're invited to Acme",
  placeholders: { firstName: 'Alex' },
  metadata: { source: 'signup-flow' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

E-Mail-Vorlage aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateEmailTemplateBody	UpdateEmailTemplateBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateEmailTemplate

Copy

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

Ereignisprotokoll abrufen

req tenantId urlId userIdWS

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Antwort

Gibt zurück: GetEventLog200Response

Beispiel

getEventLog Beispiel

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // optionaler Upstream-Wert
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

Globales Ereignisprotokoll abrufen

req tenantId urlId userIdWS

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Antwort

Gibt zurück: GetEventLog200Response

Beispiel

getGlobalEventLog Beispiel

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // vor 7 Tagen
const endTimeOptional: number | undefined = undefined; // optionales Ende des Zeitraums
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

Feed-Beitrag erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nein
isLive	boolean	Nein
doSpamCheck	boolean	Nein
skipDupCheck	boolean	Nein

Antwort

Rückgabe: CreateFeedPost200Response

Beispiel

createFeedPost Beispiel

Copy

const tenantId: string = 'tenant_87f3b2';
const mediaAsset: FeedPostMediaItemAsset = { url: 'https://cdn.example.com/images/post-123.jpg', mimeType: 'image/jpeg', width: 1200, height: 800, size: 245000 };
const mediaItem: FeedPostMediaItem = { id: 'media_1', type: 'image', assets: [mediaAsset], altText: 'Conference keynote stage' };
const link: FeedPostLink = { url: 'https://news.example.com/keynote-recap', title: 'Keynote recap' };
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Product Launch Highlights',
  content: 'Highlights from today’s product launch and roadmap updates.',
  authorId: 'user_42',
  mediaItems: [mediaItem],
  links: [link],
  tags: ['product', 'launch', 'announcement']
};
const broadcastId: string = 'broadcast_20260424';
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

Öffentlichen Feed-Beitrag erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: CreateFeedPostPublic200Response

Beispiel

createFeedPostPublic Beispiel

Copy

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

Öffentlichen Feed-Beitrag löschen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
postId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: DeleteFeedPostPublic200Response

Beispiel

deleteFeedPostPublic Beispiel

Copy

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

Feed-Beiträge abrufen

req tenantId afterId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
limit	number	Nein
tags	Array	Nein

Antwort

Gibt zurück: GetFeedPosts200Response

Beispiel

getFeedPosts Beispiel

Copy

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

Öffentliche Feed-Beiträge abrufen

req tenantId afterId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
limit	number	Nein
tags	Array	Nein
sso	string	Nein
isCrawler	boolean	Nein
includeUserInfo	boolean	Nein

Antwort

Gibt zurück: GetFeedPostsPublic200Response

Beispiel

getFeedPostsPublic Beispiel

Copy

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

Statistiken der Feed-Beiträge abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postIds	Array	Ja
sso	string	Nein

Antwort

Gibt zurück: GetFeedPostsStats200Response

Beispiel

getFeedPostsStats Beispiel

Copy

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

Öffentliche Nutzerreaktionen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postIds	Array	Nein
sso	string	Nein

Antwort

Gibt zurück: GetUserReactsPublic200Response

Beispiel

getUserReactsPublic Beispiel

Copy

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

Öffentliche Reaktion auf Feed-Beitrag

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Ja
reactBodyParams	ReactBodyParams	Ja
isUndo	boolean	Nein
broadcastId	string	Nein
urlId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: ReactFeedPostPublic200Response

Beispiel

reactFeedPostPublic Beispiel

Copy

const tenantId: string = "global-markets";
const postId: string = "8e2c3f9a-4b6d-4f1a-9c2d-e8a1b2c3d4e5";
const reactBodyParams: ReactBodyParams = { reactionType: "like", clientApp: "web-ui", timestamp: new Date().toISOString() };
const isUndo: boolean = false;
const broadcastId: string = "broadcast-2026-05-20";
const urlId: string = "feed-post-8e2c";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload";
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

Feed-Beitrag aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
feedPost	FeedPost	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateFeedPost Beispiel

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // optionales Array eingeschlossen
  links: [link],          // optionale Links eingeschlossen
  isPublished: true       // optionales Veröffentlichungs-Flag verwendet
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

Öffentlichen Feed-Beitrag aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Ja
updateFeedPostParams	UpdateFeedPostParams	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: CreateFeedPostPublic200Response

Beispiel

Beispiel für updateFeedPostPublic

Copy

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

Kommentar öffentlich melden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
isFlagged	boolean	Ja
sso	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

flagCommentPublic Beispiel

Copy

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

Großes GIF abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
largeInternalURLSanitized	string	Ja

Antwort

Gibt zurück: GifGetLargeResponse

Beispiel

Beispiel für getGifLarge

Copy

const tenantId: string = 'tenant_8a92f4';
const largeInternalURLSanitized: string = 'https://cdn.streamingco.com/gifs/product-demo-large.gif';
let maybeStatus: APIStatus | undefined = undefined; // optionale Metadaten, wenn verfügbar
const response: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);

Gifs suchen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
search	string	Ja
locale	string	Nein
rating	string	Nein
page	number	Nein

Antwort

Gibt zurück: GifSearchResponse

Beispiel

getGifsSearch Beispiel

Copy

(async () => {
  const tenantId: string = "global-media";
  const search: string = "laughing baby";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 2;
  const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);
  console.log(result);
})();

Trendende Gifs abrufen

Parameters

Name	Typ	Erforderlich
tenantId	string	Ja
locale	string	Nein
rating	string	Nein
page	number	Nein

Response

Gibt zurück: GifSearchResponse

Beispiel

Beispiel für getGifsTrending

Copy

const tenantId: string = 'tenant_42';
const locale: string = 'en-US';
const rating: string = 'PG';
const page: number = 1;
const result: GifSearchResponse = await getGifsTrending(tenantId, locale, rating, page);

Hashtag hinzufügen

Parameter

Name	Type	Erforderlich	Beschreibung
tenantId	string	Nein
createHashTagBody	CreateHashTagBody	Nein

Antwort

Gibt zurück: AddHashTag200Response

Beispiel

addHashTag Beispiel

Copy

const tenantId: string | undefined = undefined;
const createHashTagBody: CreateHashTagBody = {
  name: 'release-2026',
  description: 'Feedback and bug reports for the April 2026 product release',
  synonyms: ['v2-release', 'launch-2026'],
  color: '#1d72b8',
  isActive: true,
  createdBy: 'product.manager@acme-corp.com'
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

Hashtags im Stapel hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Nein
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nein

Antwort

Gibt zurück: AddHashTagsBulk200Response

Beispiel

addHashTagsBulk Beispiel

Copy

const tenantId: string = 'tenant_acme_corp_01';
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: 'feature-request', slug: 'feature-request', description: 'Requests for new capabilities', isActive: true, customConfig: { visibility: 'public' } as unknown as CustomConfigParameters }
  ]
};
const addHashTagsResponse: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const bulkCreateHashTagsBodyNoTenant: BulkCreateHashTagsBody = {
  tags: [
    { name: 'ux-feedback', slug: 'ux-feedback', description: 'User experience suggestions', isActive: true }
  ]
};
const addHashTagsResponseNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBodyNoTenant);

Hashtag löschen

Parameter

Name	Typ	Erforderlich
tag	string	Ja
tenantId	string	Nein
deleteHashTagRequest	DeleteHashTagRequest	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteHashTag Beispiel

Copy

const tag: string = "spring-sale-2026";
const tenantId: string = "tenant-9876";
const deleteHashTagRequest: DeleteHashTagRequest = {
  requestedBy: "admin@retailco.com",
  reason: "Campaign ended; remove associated auto-tags",
  cascadeDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

Hashtags abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
page	number	Nein

Antwort

Gibt zurück: GetHashTags200Response

Beispiel

getHashTags Beispiel

Copy

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

Hashtag patchen

Parameter

Name	Typ	Erforderlich
tag	string	Ja
tenantId	string	Nein
updateHashTagBody	UpdateHashTagBody	Nein

Antwort

Gibt zurück: PatchHashTag200Response

Beispiel

patchHashTag Beispiel

Copy

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

Moderator erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Ja

Antwort

Gibt zurück: CreateModerator200Response

Beispiel

createModerator-Beispiel

Copy

const tenantId: string = "tenant_8f3b6c";
const optionalConfig: CustomConfigParameters = { moderationThreshold: 5, escalateOnRepeatedOffenses: true };
const newModerator: CreateModeratorBody = {
  email: "lina.gomez@dailynews.com",
  fullName: "Lina Gomez",
  role: "senior_moderator",
  enabled: true,
  notifyByEmail: true,
  customConfig: optionalConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, newModerator);

Moderator löschen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
id	string	Ja
sendEmail	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteModerator Beispiel

Copy

const tenantId: string = 'tenant_9f8b7c6d';
const id: string = 'mod_4a3e11ec9d1f0242ac120003';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);

Moderator abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetModerator200Response

Beispiel

Beispiel für getModerator

Copy

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

Moderatoren abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetModerators200Response

Beispiel

getModerators Beispiel

Copy

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

Einladung senden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
fromName	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

sendInvite-Beispiel

Copy

const tenantId: string = 'acme-corp-128';
const id: string = 'comment-8421f';
const fromName: string = 'Marcus Lindström';
const note: string | undefined = undefined; // Beispiel für optionalen Parameter
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

Moderator aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateModeratorBody	UpdateModeratorBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateModerator Beispiel

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // optionales Feld zur Demonstration
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

Benachrichtigungsanzahl löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteNotificationCount Beispiel

Copy

const tenantId: string = "org-72a8f1b9";
const id: string = "notif-8f9c2e4a";
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

Zwischengespeicherte Benachrichtigungsanzahl abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetCachedNotificationCount200Response

Beispiel

getCachedNotificationCount Beispiel

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // optionales Parameter-Flag (dargestellt)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

Benachrichtigungsanzahl abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
urlId	string	Nein
fromCommentId	string	Nein
viewed	boolean	Nein
type	string	Nein

Antwort

Gibt zurück: GetNotificationCount200Response

Beispiel

Beispiel für getNotificationCount

Copy

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

Benachrichtigungen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
urlId	string	Nein
fromCommentId	string	Nein
viewed	boolean	Nein
type	string	Nein
skip	number	Nein

Antwort

Gibt zurück: GetNotifications200Response

Beispiel

getNotifications Beispiel

Copy

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

Benachrichtigung aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateNotificationBody	UpdateNotificationBody	Ja
userId	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateNotification

Copy

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

Seite hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Ja

Antwort

Gibt zurück: AddPageAPIResponse

Seite löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: DeletePageAPIResponse

Seite nach URL-ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: GetPageByURLIdAPIResponse

Seiten abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: GetPagesAPIResponse

Seite patchen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPIPageData	UpdateAPIPageData	Ja

Antwort

Gibt zurück: PatchPageAPIResponse

Ausstehendes Webhook-Ereignis löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deletePendingWebhookEvent

Copy

const tenantId: string = "tenant_7f3b2a";
const webhookEventId: string = "wh_evt_9a8c7d1234";
const dryRun: boolean | undefined = undefined; // optionales Flagbeispiel (für diesen Aufruf nicht erforderlich)
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, webhookEventId);

Anzahl ausstehender Webhook-Ereignisse abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Nein
externalId	string	Nein
eventType	string	Nein
type	string	Nein
domain	string	Nein
attemptCountGT	number	Nein

Antwort

Gibt zurück: GetPendingWebhookEventCount200Response

Beispiel

Beispiel für getPendingWebhookEventCount

Copy

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

Ausstehende Webhook-Ereignisse abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Nein
externalId	string	Nein
eventType	string	Nein
type	string	Nein
domain	string	Nein
attemptCountGT	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetPendingWebhookEvents200Response

Beispiel

getPendingWebhookEvents Beispiel

Copy

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

Frage-Konfiguration erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Ja

Antwort

Gibt zurück: CreateQuestionConfig200Response

Beispiel

createQuestionConfig Beispiel

Copy

const tenantId: string = "tenant_acme_01";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Post-purchase feedback",
  description: "Quick survey about your recent order",
  required: true,
  renderingType: "single_choice",
  options: [
    { label: "Very dissatisfied", value: "1" },
    { label: "Dissatisfied", value: "2" },
    { label: "Neutral", value: "3" },
    { label: "Satisfied", value: "4" },
    { label: "Very satisfied", value: "5" }
  ] as QuestionConfigCustomOptionsInner[]
} as CreateQuestionConfigBody;
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

Frage-Konfiguration löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteQuestionConfig Beispiel

Copy

const tenantId: string = "tenant_42fa9b7c";
const id: string = "qcfg-0f8fad5b-d9cb-469f-a165-70867728950e";
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

Frage-Konfiguration abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetQuestionConfig200Response

Beispiel

getQuestionConfig Beispiel

Copy

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

Frage-Konfigurationen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
skip	number	No

Antwort

Gibt zurück: GetQuestionConfigs200Response

Beispiel

getQuestionConfigs Beispiel

Copy

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

Frage-Konfiguration aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateQuestionConfigBody	UpdateQuestionConfigBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateQuestionConfig Beispiel

Copy

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

Frageergebnis erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

Antwort

Gibt zurück: CreateQuestionResult200Response

Beispiel

createQuestionResult Beispiel

Copy

const tenantId: string = 'fastcomments-tenant-01';
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: 'q-34567',
  respondentId: 'user-8923',
  answers: [{ optionId: 'opt_A', text: 'Agree', count: 1 }],
  score: 5,
  meta: [{ key: 'platform', value: 'web' }],
  notifyModerators: false // optionaler Parameter
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

Frageergebnis löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteQuestionResult Beispiel

Copy

const tenantIdEnv: string | undefined = process.env.FASTCOMMENTS_TENANT_ID;
const tenantId: string = tenantIdEnv ?? 'tenant_78b3f2';
const id: string = 'qres-9f2a3b1c';
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);

Frageergebnis abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetQuestionResult200Response

Beispiel

getQuestionResult Beispiel

Copy

const tenantId: string = 'acme-corp-42';
const id: string = 'question-9f8b7c';
const includeComments: boolean | undefined = true; // Beispiel für einen optionalen Parameter
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);
console.log(result);

Frageergebnisse abrufen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
urlId	string	Nein
userId	string	Nein
startDate	string	Nein
questionId	string	Nein
questionIds	string	Nein
skip	number	Nein

Antwort

Gibt zurück: GetQuestionResults200Response

Beispiel

getQuestionResults Beispiel

Copy

(async () => {
  const tenantId: string = "tenant_9b3f";
  const urlId: string = "survey-2026-spring";
  const userId: string = "user_00123";
  const startDate: string = "2026-04-01T00:00:00Z";
  const questionIds: string = "q_42,q_43";
  const skip: number = 0;
  const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);
  console.log(result);
})();

Frageergebnis aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateQuestionResultBody	UpdateQuestionResultBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateQuestionResult

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // optionale Metadaten
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Frageergebnisse aggregieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Antwort

Gibt zurück: AggregateQuestionResults200Response

Beispiel

aggregateQuestionResults Beispiel

Copy

const tenantId: string = "tenant_acme_001";
const questionIds: string[] = ["q-2026-sales", "q-2026-support"];
const urlId: string = "url_7f2c";
const timeBucket: AggregateTimeBucket = { unit: "week", size: 1 };
const startDate: Date = new Date("2026-01-01T00:00:00Z");
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

Frageergebnisse im Stapel aggregieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Ja
forceRecalculate	boolean	Nein

Antwort

Gibt zurück: BulkAggregateQuestionResults200Response

Beispiel

bulkAggregateQuestionResults Beispiel

Copy

const tenantId: string = "tenant_acme_42";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  questions: [
    { questionId: "q-001", threadId: "thread-1001", questionType: "rating" },
    { questionId: "q-002", threadId: "thread-1002", questionType: "yes_no" }
  ],
  timeRange: { from: "2026-03-01T00:00:00Z", to: "2026-04-01T00:00:00Z" },
  groupBy: ["questionId", "threadId"]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

Kommentare mit Frageergebnissen kombinieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
questionId	string	Nein
questionIds	Array	Nein
urlId	string	Nein
startDate	Date	Nein
forceRecalculate	boolean	Nein
minValue	number	Nein
maxValue	number	Nein
limit	number	Nein

Antwort

Gibt zurück: CombineCommentsWithQuestionResults200Response

Beispiel

Beispiel für combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant-acme-001';
const questionId: string | undefined = 'q-analytics-42';
const questionIds: string[] | undefined = ['q-analytics-42', 'q-feedback-17'];
const urlId: string | undefined = 'url-987654';
const startDate: Date | undefined = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean | undefined = true;
const minValue: number | undefined = 1;
const maxValue: number | undefined = 5;
const limit: number | undefined = 250;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

SSO-Benutzer hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Ja

Antwort

Gibt zurück: AddSSOUserAPIResponse

SSO-Benutzer löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
deleteComments	boolean	Nein
commentDeleteMode	string	Nein

Antwort

Gibt zurück: DeleteSSOUserAPIResponse

SSO-Benutzer per E-Mail abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
email	string	Ja

Antwort

Gibt zurück: GetSSOUserByEmailAPIResponse

SSO-Benutzer per ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetSSOUserByIdAPIResponse

SSO-Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetSSOUsers200Response

SSO-Benutzer patchen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nein

Antwort

Gibt zurück: PatchSSOUserAPIResponse

SSO-Benutzer ersetzen (PUT)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nein

Antwort

Gibt zurück: PutSSOUserAPIResponse

Beispiel

putSSOUser Beispiel

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

Abonnement erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ja

Antwort

Gibt zurück: CreateSubscriptionAPIResponse

Beispiel

createSubscription Beispiel

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, // optionaler Parameter zur Demonstration
  metadata: { campaign: "spring_launch" } // optionaler Parameter zur Demonstration
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

Abonnement löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein

Antwort

Gibt zurück: DeleteSubscriptionAPIResponse

Abonnements abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Nein

Antwort

Gibt zurück: GetSubscriptionsAPIResponse

Beispiel

getSubscriptions Beispiel

Copy

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

Abonnement aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Ja
userId	string	Nein

Antwort

Gibt zurück: UpdateSubscriptionAPIResponse

Beispiel

Beispiel für 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);

Tägliche Mandanten-Nutzung abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
yearNumber	number	Nein
monthNumber	number	Nein
dayNumber	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetTenantDailyUsages200Response

Beispiel

getTenantDailyUsages Beispiel

Copy

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

Mandantenpaket erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

Antwort

Gibt zurück: CreateTenantPackage200Response

Beispiel

Beispiel für createTenantPackage

Copy

const tenantId: string = "tenant_acme-corp_001";
const createTenantPackageBody: CreateTenantPackageBody = {
  name: "Acme Standard Package",
  description: "Default package for Acme Corp comments with moderation and SSO enabled",
  enabled: true,
  maxCommentsPerThread: 500,
  voteStyle: "thumbs",
  gifRating: "PG-13",
  tosConfig: { enabled: true, url: "https://acme.example.com/terms" } // optionaler Parameter zur Demonstration
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

Mandantenpaket löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenantPackage Beispiel

Copy

(async () => {
  const tenantId: string = "tenant_8f3a2b4c9d01";
  const packageId: string = "pkg_2026-04-security-patch";
  const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);
  console.log(result);
})();

Mandantenpaket abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetTenantPackage200Response

Beispiel

getTenantPackage Beispiel

Copy

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

Mandantenpakete abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetTenantPackages200Response

Beispiel

getTenantPackages Beispiel

Copy

const tenantId: string = 'tenant-7b3c2f';
const skipCount: number = 10;
const packages: GetTenantPackages200Response = await getTenantPackages(tenantId, skipCount);
const packagesFromStart: GetTenantPackages200Response = await getTenantPackages(tenantId);

Mandantenpaket ersetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
replaceTenantPackageBody	ReplaceTenantPackageBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

replaceTenantPackage Beispiel

Copy

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

Mandantenpaket aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateTenantPackageBody	UpdateTenantPackageBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateTenantPackage Beispiel

Copy

(async () => {
  const tenantId: string = "tenant_sf_001";
  const id: string = "pkg-premium-v2";
  const updateTenantPackageBody: UpdateTenantPackageBody = {
    name: "San Francisco Premium",
    enabled: true,
    customConfig: { maxComments: 500 },
    tosConfig: { required: true } // optionale Felder werden durch Anwesenheit gezeigt; andere ausgelassen
  } as UpdateTenantPackageBody;
  const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);
  console.log(result);
})();

Mandanten-Benutzer erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Ja

Antwort

Gibt zurück: CreateTenantUser200Response

Beispiel

createTenantUser Beispiel

Copy

const tenantId: string = "tenant_74b3a9f4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@acmecorp.com",
  displayName: "Jane Doe",
  role: "moderator",
  sendWelcomeEmail: true, // optionaler Parameter demonstriert
  metadata: { department: "Customer Support" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

Mandanten-Benutzer löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
deleteComments	string	Nein
commentDeleteMode	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenantUser Beispiel

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme_corp_tenant_9f1a2b";
  const id: string = "user_4d2a1b6c";
  const deleteComments: string = "true"; // entfernt auch die Kommentare des Benutzers
  const commentDeleteMode: string = "permanent"; // "permanent" oder "soft"
  const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);
  console.log(result);
}
run();

Mandanten-Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetTenantUser200Response

Beispiel

Beispiel für getTenantUser

Copy

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

Mandanten-Benutzer abrufen (Liste)

Parameters

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Response

Gibt zurück: GetTenantUsers200Response

Beispiel

Beispiel für getTenantUsers

Copy

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

Mandanten-Benutzer ersetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
replaceTenantUserBody	ReplaceTenantUserBody	Ja
updateComments	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

replaceTenantUser Beispiel

Copy

const tenantId: string = "tenant_acmeCorp";
const id: string = "user_84b2";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "alice.jenkins@acmecorp.com",
  displayName: "Alice Jenkins",
  roles: ["moderator", "editor"],
  disabled: false
} as ReplaceTenantUserBody;
const updateComments: string = "Migrated user account and reattributed historical comments";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

Login-Link senden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
redirectURL	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

sendLoginLink Beispiel

Copy

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

Mandanten-Benutzer aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateTenantUserBody	UpdateTenantUserBody	Ja
updateComments	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateTenantUser Beispiel

Copy

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

Mandanten erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantBody	CreateTenantBody	Ja

Antwort

Gibt zurück: CreateTenant200Response

Beispiel

createTenant Beispiel

Copy

const tenantId: string = 'acme-corp-001';
const createTenantBody: CreateTenantBody = {
  name: 'Acme Corporation',
  domainConfiguration: { primaryDomain: 'comments.acme.com', enforceHttps: true } as APIDomainConfiguration,
  billingInfo: { planId: 'enterprise', contactEmail: 'billing@acme.com' } as BillingInfo
  // optionale Felder wie ssoConfig oder customConfig wurden absichtlich weggelassen
} as CreateTenantBody;
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

Mandanten löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
sure	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenant-Beispiel

Copy

const tenantId: string = 'tenant_42c9f1';
const id: string = 'flag_9a7b3c';
const sure: string = 'confirm-delete';
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

Mandanten abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetTenant200Response

Beispiel

getTenant Beispiel

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // optionale Überschreibung, falls verfügbar
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

Mandanten abrufen (Liste)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
meta	string	Nein
skip	number	Nein

Antwort

Gibt zurück: GetTenants200Response

Beispiel

getTenants Beispiel

Copy

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

Mandanten aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateTenantBody	UpdateTenantBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateTenant Beispiel

Copy

const tenantId: string = 'acme-corp-001';
const id: string = 'tenant-42';
const billingInfo: BillingInfo = { billingEmail: 'billing@acme.com', address: '123 Market St' } as BillingInfo;
const updateTenantBody: UpdateTenantBody = { displayName: 'Acme Corporation', billingInfo } as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Ticketstatus ändern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Ja
id	string	Ja
changeTicketStateBody	ChangeTicketStateBody	Ja

Antwort

Gibt zurück: ChangeTicketState200Response

Beispiel

changeTicketState Beispiel

Copy

const tenantId: string = "tenant_7f3b2c9a";
const userId: string = "user_5a1d9fb2";
const id: string = "ticket_3e8a1b6f";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  reason: "Fixed in backend release 2.4.1",
  notifyUsers: true,
  metadata: { resolutionOwner: "agent_12", priority: "high" } // optionale Felder demonstriert
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

Ticket erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Ja
createTicketBody	CreateTicketBody	Ja

Antwort

Gibt zurück: CreateTicket200Response

Beispiel

createTicket Beispiel

Copy

const tenantId: string = 'acme-company-001';
const userId: string = 'u_78f4b2';
const createTicketBody: CreateTicketBody = {
  title: 'Unable to access project dashboard',
  description: 'Receiving 403 when accessing /dashboard for project X',
  priority: 'high',
  tags: ['dashboard', 'access'] // Beispiel für ein optionales Feld
};
const result: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

Ticket abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein

Antwort

Gibt zurück: GetTicket200Response

Beispiel

getTicket Beispiel

Copy

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

Tickets abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
state	number	Nein
skip	number	Nein
limit	number	Nein

Antwort

Gibt zurück: GetTickets200Response

Beispiel

getTickets Beispiel

Copy

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

Übersetzungen abrufen

Parameter

Name	Typ	Erforderlich
namespace	string	Ja
component	string	Ja
locale	string	Nein
useFullTranslationIds	boolean	Nein

Antwort

Gibt zurück: GetTranslationsResponse

Beispiel

getTranslations Beispiel

Copy

const translationsDefault: GetTranslationsResponse = await getTranslations("payments", "checkout");
const translationsFrenchDetailed: GetTranslationsResponse = await getTranslations("payments", "checkout", "fr-FR", true);

Bild hochladen

Bild hochladen und skalieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
file	Blob	Ja
sizePreset	SizePreset	Nein
urlId	string	Nein

Antwort

Gibt zurück: UploadImageResponse

Abzeichenfortschritt des Benutzers per ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetUserBadgeProgressById200Response

Beispiel

getUserBadgeProgressById Beispiel

Copy

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

Abzeichenfortschritt des Benutzers per Benutzer-ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Ja

Antwort

Gibt zurück: GetUserBadgeProgressById200Response

Beispiel

getUserBadgeProgressByUserId Beispiel

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // optionale Quelle (kann undefined sein)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

Liste des Abzeichenfortschritts abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
limit	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetUserBadgeProgressList200Response

Beispiel

getUserBadgeProgressList Beispiel

Copy

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

Benutzerabzeichen erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Ja

Antwort

Gibt zurück: CreateUserBadge200Response

Beispiel

createUserBadge Beispiel

Copy

const tenantId: string = "tenant_9a8b7c";
const params: CreateUserBadgeParams = {
  name: "Top Contributor",
  slug: "top-contributor",
  description: "Awarded for 100 approved comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top-contributor.png",
  active: true,
  criteria: { approvedComments: 100 },
  customConfig: { showOnProfile: true } // optionaler Parameter
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, params);

Benutzerabzeichen löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: UpdateUserBadge200Response

Beispiel

deleteUserBadge Beispiel

Copy

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

Benutzerabzeichen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetUserBadge200Response

Beispiel

getUserBadge Beispiel

Copy

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

Benutzerabzeichen abrufen (Liste)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
badgeId	string	Nein
type	number	Nein
displayedOnComments	boolean	Nein
limit	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetUserBadges200Response

Beispiel

getUserBadges Beispiel

Copy

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

Benutzerabzeichen aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateUserBadgeParams	UpdateUserBadgeParams	Ja

Antwort

Gibt zurück: UpdateUserBadge200Response

Beispiel

updateUserBadge Beispiel

Copy

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

Benutzer-Benachrichtigungsanzahl abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: GetUserNotificationCount200Response

Beispiel

getUserNotificationCount Beispiel

Copy

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

Benutzer-Benachrichtigungen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
pageSize	number	Nein
afterId	string	Nein
includeContext	boolean	Nein
afterCreatedAt	number	Nein
unreadOnly	boolean	Nein
dmOnly	boolean	Nein
noDm	boolean	Nein
includeTranslations	boolean	Nein
sso	string	Nein

Antwort

Gibt zurück: GetUserNotifications200Response

Beispiel

getUserNotifications Beispiel

Copy

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

Benutzer-Benachrichtigungsanzahl zurücksetzen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: ResetUserNotifications200Response

Beispiel

Beispiel für resetUserNotificationCount

Copy

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

Benutzer-Benachrichtigungen zurücksetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
afterCreatedAt	number	Nein
unreadOnly	boolean	Nein
dmOnly	boolean	Nein
noDm	boolean	Nein
sso	string	Nein

Antwort

Gibt zurück: ResetUserNotifications200Response

Beispiel

Beispiel für resetUserNotifications

Copy

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

Kommentar-Abonnementstatus des Benutzers aktualisieren

Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
notificationId	string	Ja
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Ja
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Beispiel

Beispiel für updateUserNotificationCommentSubscriptionStatus

Copy

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

Seiten-Abonnementstatus des Benutzers aktualisieren

Aktivieren oder deaktivieren Sie Benachrichtigungen für eine Seite. Wenn Benutzer für eine Seite abonniert sind, werden Benachrichtigungen erstellt für neue Root-Kommentare, und auch

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
url	string	Ja
pageTitle	string	Ja
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Ja
sso	string	Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Beispiel

Beispiel für updateUserNotificationPageSubscriptionStatus

Copy

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

Benachrichtigungsstatus des Benutzers aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
notificationId	string	Ja
newStatus	UpdateUserNotificationStatusNewStatusEnum	Ja
sso	string	Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Beispiel

Beispiel für updateUserNotificationStatus

Copy

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

Anwesenheitsstatus der Benutzer abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlIdWS	string	Ja
userIds	string	Ja

Antwort

Gibt zurück: GetUserPresenceStatuses200Response

Beispiel

getUserPresenceStatuses Beispiel

Copy

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

Benutzer suchen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Nein
mentionGroupIds	Array	Nein
sso	string	Nein
searchSection	SearchUsersSearchSectionEnum	Nein

Antwort

Gibt zurück: SearchUsers200Response

Beispiel

searchUsers Beispiel

Copy

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

Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetUser200Response

Beispiel

getUser Beispiel

Copy

const idSuffix: string | undefined = undefined;
const tenantId: string = "acme-enterprises";
const id: string = idSuffix ?? "user_98765";
const response: GetUser200Response = await getUser({ tenantId, id });

Stimme erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
direction	CreateVoteDirectionEnum	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: VoteComment200Response

Beispiel

createVote Beispiel

Copy

const tenantId: string = 'tenant_5f2a9b';
const commentId: string = 'cmt_3b7e21';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_9x7k2p';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

Stimme löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
editKey	string	Nein

Antwort

Gibt zurück: DeleteCommentVote200Response

Beispiel

deleteVote Beispiel

Copy

const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
const id: string = 'vote-7a1b2c3d-9f8e-4b6a-8123-abcdef012345';
const editKey: string = 'editKey_4f3e2d1c';
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);

Stimmen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Rückgabe: GetVotes200Response

Beispiel

getVotes Beispiel

Copy

const tenantId: string = 'tenant-42c-eu';
const urlId: string = 'article-7f9b';
const includeMetadata: boolean | undefined = true;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

Stimmen für Benutzer abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: GetVotesForUser200Response

Beispiel

getVotesForUser Beispiel

Copy

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

Benötigen Sie Hilfe?

Wenn Sie auf Probleme stoßen oder Fragen zum JavaScript-/TypeScript-SDK haben, bitte:

Mitwirken

Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für Richtlinien zur Mitarbeit.

Sprache 🇩🇪 Deutsch

Erste Schritte

API-Referenz

Dokumentation

Verwendung

Aggregation

Audit-Protokolle

Vom Kommentar blockieren

Gesperrte Kommentare prüfen

Kommentare

Kommentare für Benutzer

Domain-Konfigurationen

E-Mail-Vorlagen

Ereignisprotokoll

Feed-Beiträge

Kommentar melden

Gifs

Hashtags

Moderatoren

Benachrichtigungsanzahl

Benachrichtigungen

Seiten

Ausstehende Webhook-Ereignisse

Fragekonfigurationen

Frageergebnisse

Aggregation der Frageergebnisse

SSO-Benutzer

Abonnements

Tägliche Mandanten-Nutzung

Mandantenpakete

Mandanten-Benutzer

Mandanten

Tickets

Übersetzungen

Bild hochladen

Fortschritt der Benutzerabzeichen

Benutzerabzeichen

Benutzer-Benachrichtigungen

Anwesenheitsstatus des Benutzers

Benutzersuche

Benutzer

Abstimmungen

FastComments JavaScript/TypeScript-SDK

Repository

Installation

API-Dokumentation

Vollständige API-Referenz: docs/api/README.md

Browser- vs. Server-Kompatibilität

Verwendung

Browser-Nutzung (Clientseitig)

Server-Nutzung (Node.js)

Nur Typen-Import

Verwendung einzelner API-Klassen

Browser-Umgebung

Server-Umgebung

Öffentliche vs. gesicherte APIs

Beispiel: Verwendung der Public API (browser-sicher)

Beispiel: Verwendung der Default API (nur serverseitig)

SSO (Single Sign-On)-Integration

Einfache SSO (nur serverseitig)

Sichere SSO (serverseitig, empfohlen)

Verwendung von SSO im Browser (mit servergeneriertem Token)

SSO mit Kommentar-Erstellung

Häufige Anwendungsfälle

Kommentare für eine Seite abrufen

Einen Kommentar erstellen

Für einen Kommentar abstimmen

Benutzerverwaltung (erfordert API-Schlüssel)

Live-Events (Echtzeit-Aktualisierungen)

Ereignisse auf Seitenebene

Benutzerbezogene Ereignisse abonnieren

Abrufen von userIdWS

Broadcast-IDs

Fehlerbehandlung

aggregieren

Parameter

Antwort

Audit-Protokolle abrufen

Parameter

Antwort