
Taal 🇳🇱 Nederlands
Documentatie
Aan de slag
API-referentie
Agent-tenant
Aggregatie
Auditlogboeken
Authenticatie
Batchtaken
Blokkeren vanuit reactie
Controleer geblokkeerde reacties
Reacties
Reacties voor gebruiker
Domeinconfiguraties
E-mailsjablonen
Evenementlog
Feedberichten
Reactie markeren
GIF's
Hashtags
Mij
Moderatie
Moderators
Aantal meldingen
Meldingen
Paginareacties
Pagina's
In afwachting van webhookgebeurtenissen
Peilingstemmen
Peilingen
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijks gebruik van tenant
Tenant-pakketten
Tenant-gebruikers
Tenants
Tickets
Vertalingen
Afbeelding uploaden
Voortgang gebruikersbadge
Gebruikersbadges
Gebruikersmeldingen
Aanwezigheidsstatus van gebruiker
Gebruikers zoeken
Gebruikers
Stemmen
Webhooks
FastComments Swift SDK
Dit is de officiële Swift SDK voor FastComments.
Officiële Swift SDK voor de FastComments API
Repository
AI-coderingsagenten 
Geef je code‑agent de FastComments‑context die hij nodig heeft - widgets, configuratie, Secure SSO, de REST‑API en de SDK’s:
npx skills add fastcomments/skills
Werkt met Claude Code, Codex, Cursor, Copilot, Gemini en elke andere agent die de skills CLI ondersteunt.
Installatie 
Swift Package Manager
Voeg het volgende toe aan je Package.swift bestand:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Of in Xcode:
- File > Add Packages...
- Voer de repository-URL in:
https://github.com/fastcomments/fastcomments-swift.git - Selecteer de versie die je wilt gebruiken
Vereisten
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Bibliotheekinhoud 
De FastComments Swift SDK bestaat uit meerdere modules:
-
Clientmodule - API-client voor de FastComments REST-API's
- Volledige typedefinities voor alle API-modellen
- Geauthenticeerde (
DefaultAPI), openbare (PublicAPI) en moderatie (ModerationAPI) methoden - Volledige async/await-ondersteuning
- Zie client/README.md voor gedetailleerde API-documentatie
-
SSO-module - Server-side Single Sign-On-hulpmiddelen
- Veilige tokengeneratie voor gebruikersauthenticatie
- Ondersteuning voor zowel eenvoudige als beveiligde SSO-modi
- Op HMAC-SHA256 gebaseerde ondertekening van tokens met CryptoKit
Snelle start 
Gebruik van de openbare API
import FastCommentsSwift
// Haal reacties op voor een pagina
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Gebruik van de geauthenticeerde API
import FastCommentsSwift
// Stel uw API-sleutel in op de gedeelde configuratie (verzonden als de x-api-key header)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Haal reacties op met geauthentiseerde API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Gebruik van de moderatie-API
import FastCommentsSwift
// Moderatiemethoden zijn geautoriseerd met een `sso`-token voor de optredende moderator
// (genereer het met FastCommentsSSO, zie de SSO sectie hierboven).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Gebruik van SSO voor authenticatie
Veilige SSO (Aanbevolen voor productie)
import FastCommentsSwift
let apiKey = "your-api-key"
// Maak veilige SSO-gebruikersgegevens aan (alleen server‑side!)
let userData = SecureSSOUserData(
id: "user-123", // Gebruikers-ID
email: "user@example.com", // E‑mail
username: "johndoe", // Gebruikersnaam
avatar: "https://example.com/avatar.jpg" // Avatar‑URL
)
// Genereer SSO-token
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Stuur dit token naar uw front‑end voor authenticatie
} catch {
print("Error creating SSO token: \(error)")
}
Eenvoudige SSO (Voor ontwikkeling/testen)
import FastCommentsSwift
// Maak eenvoudige SSO-gebruikersgegevens aan (geen API-sleutel nodig)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Genereer eenvoudige SSO-token
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API-clients 
De FastComments SDK biedt drie API-clients:
PublicAPI - Client-Safe Methoden
De PublicAPI bevat methoden die veilig kunnen worden aangeroepen vanuit client-side code (iOS/macOS-apps). Deze methoden:
- Vereisen geen API-sleutel
- Kunnen SSO-tokens gebruiken voor authenticatie
- Zijn rate-limited per gebruiker/apparaat
- Zijn geschikt voor applicaties gericht op eindgebruikers
Voorbeeld use case: Het ophalen en maken van opmerkingen in je iOS-app
DefaultAPI - Server-Side Methoden
De DefaultAPI bevat geauthenticeerde methoden die een API-sleutel vereisen. Deze methoden:
- Vereisen je FastComments API-sleutel
- Mogen ALLEEN worden aangeroepen vanuit server-side code
- Bieden volledige toegang tot je FastComments-gegevens
- Zijn rate-limited per tenant
Voorbeeld use case: Administratieve bewerkingen, bulkdata-export, gebruikersbeheer
ModerationAPI - Moderator Dashboard Methoden
De ModerationAPI biedt een uitgebreide suite van live en snelle moderatie-API's. Elke ModerationAPI-methode accepteert een sso-parameter en kan authenticeren via SSO of een FastComments.com-sessiecookie.
Voorbeeld use case: Het bouwen van een moderatie-ervaring voor moderators van jouw community
BELANGRIJK: Stel je API-sleutel nooit bloot in client-side code. API-sleutels mogen alleen server-side worden gebruikt.
API-aanroepen maken 
De Swift SDK gebruikt moderne async/await‑syntaxis voor alle API‑aanroepen:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Veelvoorkomende problemen 
401 Niet-geautoriseerde fouten
Als je 401-fouten krijgt bij het gebruik van de geauthentiseerde API:
- Controleer je API‑sleutel: Zorg ervoor dat je de juiste API‑sleutel van je FastComments-dashboard gebruikt
- Verifieer de tenant‑ID: Zorg ervoor dat de tenant‑ID overeenkomt met je account
- API‑sleutelformaat: De API‑sleutel moet ingesteld worden als de
x-api-keyheader in de gedeelde configuratie:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Gebruik je de verkeerde API: Zorg ervoor dat je
DefaultAPI(nietPublicAPI) gebruikt voor geauthentificeerde oproepen
SSO‑tokenproblemen
Als SSO‑tokens niet werken:
- Gebruik de veilige modus voor productie: Gebruik altijd
FastCommentsSSO.createSecure()met je API‑sleutel voor productie - Alleen server‑side: Genereer veilige SSO‑tokens op je server, en exposeer je API‑sleutel nooit aan clients
- Controleer gebruikersgegevens: Zorg ervoor dat alle verplichte velden (id, e‑mail, gebruikersnaam) zijn opgegeven
- Token‑verval: Veilige SSO‑tokens bevatten een tijdstempel en kunnen verlopen. Genereer indien nodig nieuwe tokens.
SSL/TLS‑fouten
Als je SSL/TLS‑fouten tegenkomt:
- Zorg ervoor dat het Info.plist‑bestand van je app HTTPS‑verbindingen naar fastcomments.com toestaat
- Controleer of je geen App Transport Security‑uitzonderingen gebruikt die de verbinding kunnen blokkeren
Notities 
Broadcast-ID's
Je zult zien dat je een broadcastId moet doorgeven in sommige API-aanroepen. Wanneer je gebeurtenissen ontvangt, krijg je dit ID terug, zodat je weet dat je de gebeurtenis kunt negeren als je van plan bent wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen omdat het de beste gebruikerservaring biedt). Geef hier een UUID door. Het ID moet uniek genoeg zijn om niet twee keer in één sessie voor te komen.
let broadcastId = UUID().uuidString
createAgentTenant 
Maakt een nieuw proefaccount aan voor een AI‑agent zonder menselijke registratie. Er is geen API‑sleutel nodig om dit aan te roepen.
De respons bevat de tenant‑id, een API‑sleutel die onmiddellijk werkt tegen de REST‑API en de MCP‑server, en een claim‑URL. Geef de claim‑URL aan de persoon waarvoor je werkt: deze openen terwijl je bent aangemeld bij FastComments koppelt het account aan hen. Niet‑geclaimde accounts, en hun sleutels, worden 72 uur na creatie verwijderd. Totdat ze geclaimd zijn, heeft het account de standaard proeflimieten.
Response
Returns: CreateAgentTenantResponse
Example

aggregatie 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nee | |
| includeStats | boolean | query | Nee |
Response
Retourneert: AggregateResponse
Example

getAuditLogs 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | De tenant waarvoor auditlogboeken moeten worden gelezen. |
| limit | integer | query | Nee | Hoeveel logboeken moeten worden geretourneerd. Max 10000, standaard 1000. |
| skip | integer | query | Nee | Hoeveel logboeken moeten worden overgeslagen, voor paginering. |
| order | string | query | Nee | Sorteerrichting op de gebeurtenistijd. Standaard DESC (nieuwste eerst). |
| after | integer | query | Nee | |
| before | integer | query | Nee | |
| username | string | query | Nee | Alleen gebeurtenissen retourneren die door deze gebruikersnaam zijn uitgevoerd. |
| ip | string | query | Nee | Alleen gebeurtenissen retourneren van dit IP-adres. |
| crudType | string | query | Nee | Alleen gebeurtenissen van dit type retourneren: c, r, u, d, of login. |
| resourceName | string | query | Nee | Alleen gebeurtenissen voor deze bron retourneren, bijv. User of Moderator. |
| targetId | string | query | Nee | Alleen gebeurtenissen waarvan het getroffen object dit id heeft retourneren. |
| target | string | query | Nee | Hoofdletterongevoelige substringmatch op het label van het getroffen object, bijv. een gebruikersnaam of e‑mail. |
| includeManagedTenants | boolean | query | Nee | Ook gebeurtenissen retourneren van tenants die deze tenant beheert. |
Response
Retourneert: GetAuditLogsResponse
Voorbeeld

logoutPublic 
Respons
Retourneert: APIEmptyResponse
Voorbeeld

getBatchJob 
Status, voortgang en, eenmaal voltooid, het resultaat van één batchtaak.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Returns: GetBatchJobAPIResponse
Example

getBatchJobs 
De batchtaken van de tenant (imports, exports, paginamigraties...), nieuwste eerst.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| type | string | query | Nee | Alleen taken van dit type, bijvoorbeeld migrate-pages. |
| status | string | query | Nee | Alleen taken met deze status: requested, running, success of failed. |
| skip | integer | query | Nee | Hoeveel taken over te slaan, voor paginering. |
Response
Returns: GetBatchJobsAPIResponse
Example

blockFromCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: BlockSuccess
Voorbeeld

unBlockCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UnblockSuccess
Voorbeeld

checkedCommentsForBlocked 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Een door komma's gescheiden lijst met comment-ids. |
| sso | string | query | Nee |
Antwoord
Retourneert: CheckBlockedCommentsResponse
Voorbeeld

blockUserFromComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: BlockSuccess
Voorbeeld

createCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee | |
| locale | string | query | Nee |
Response
Retourneert: SaveCommentsResponseWithPresence
Voorbeeld

deleteComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respons
Retourneert: DeleteCommentResult
Voorbeeld

deleteCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: PublicAPIDeleteCommentResponse
Voorbeeld

deleteCommentVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: VoteDeleteResponse
Example

flagComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: FlagCommentResponse
Voorbeeld

getComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: APIGetCommentResponse
Voorbeeld

getComments 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nee | |
| limit | integer | query | Nee | |
| skip | integer | query | Nee | |
| asTree | boolean | query | Nee | |
| skipChildren | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee | |
| contextUserId | string | query | Nee | |
| hashTag | string | query | Nee | |
| parentId | string | query | Nee | |
| direction | string | query | Nee | |
| fromDate | integer | query | Nee | |
| toDate | integer | query | Nee |
Respons
Retourneert: APIGetCommentsResponse
Voorbeeld

getCommentsPublic 
req tenantId urlId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nee | |
| direction | string | query | Nee | |
| sso | string | query | Nee | |
| skip | integer | query | Nee | |
| skipChildren | integer | query | Nee | |
| limit | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| countChildren | boolean | query | Nee | |
| fetchPageForCommentId | string | query | Nee | |
| includeConfig | boolean | query | Nee | |
| countAll | boolean | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| modules | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeNotificationCount | boolean | query | Nee | |
| asTree | boolean | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| useFullTranslationIds | boolean | query | Nee | |
| parentId | string | query | Nee | |
| searchText | string | query | Nee | |
| hashTags | array | query | Nee | |
| userId | string | query | Nee | |
| customConfigStr | string | query | Nee | |
| afterCommentId | string | query | Nee | |
| beforeCommentId | string | query | Nee | |
| questionId | string | query | Nee | |
| questionValue | integer | query | Nee |
Respons
Retourneert: GetCommentsResponseWithPresencePublicComment
Voorbeeld

getCommentText 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPIGetCommentTextResponse
Voorbeeld

getCommentVoteUserNames 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Antwoord
Retourneert: GetCommentVoteUserNamesSuccessResponse
Voorbeeld

lockComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

pinComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ChangeCommentPinStatusResponse
Voorbeeld

saveComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respons
Retourneert: APISaveCommentResponse
Voorbeeld

saveCommentsBulk 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Respons
Retourneert: [SaveCommentsBulkResponse]
Voorbeeld

setCommentText 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPISetCommentTextResponse
Voorbeeld

translateComments 
Vertaal de opgegeven opmerkingen naar de widgetlocale. Alleen beschikbaar wanneer de bijbehorende widgetaanpassingsregel Commentaarvertaling heeft ingesteld op Automatisch of Handmatig.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Respons
Returns: CommentTranslationsResponse
Voorbeeld

unBlockUserFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Returns: UnblockSuccess
Example

unFlagComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respons
Retourneert: FlagCommentResponse
Voorbeeld

unLockComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwoord
Geeft terug: APIEmptyResponse
Voorbeeld

unPinComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ChangeCommentPinStatusResponse
Voorbeeld

updateComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| isLive | boolean | query | Nee |
Response
Returns: APIEmptyResponse
Example

voteComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: VoteResponse
Example

getCommentsForUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| userId | string | query | Nee | |
| direction | string | query | Nee | |
| repliesToUserId | string | query | Nee | |
| page | number | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| isCrawler | boolean | query | Nee |
Respons
Retourneert: GetCommentsForUserResponse
Voorbeeld

addDomainConfig 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: AddDomainConfigResponse
Voorbeeld

deleteDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Antwoord
Retourneert: DeleteDomainConfigResponse
Voorbeeld

getDomainConfig 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Respons
Retourneert: GetDomainConfigResponse
Voorbeeld

getDomainConfigs 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Geeft terug: GetDomainConfigsResponse
Voorbeeld

patchDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Retourneert: PatchDomainConfigResponse
Voorbeeld

putDomainConfig 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Retourneert: PutDomainConfigResponse
Voorbeeld

createEmailTemplate 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Geeft terug: CreateEmailTemplateResponse
Voorbeeld

deleteEmailTemplate 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: APIEmptyResponse
Voorbeeld

deleteEmailTemplateRenderError 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Voorbeeld

getEmailTemplate 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: GetEmailTemplateResponse
Voorbeeld

getEmailTemplateDefinitions 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: GetEmailTemplateDefinitionsResponse
Voorbeeld

getEmailTemplateRenderErrors 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nee |
Respons
Geeft terug: GetEmailTemplateRenderErrorsResponse
Voorbeeld

getEmailTemplates 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetEmailTemplatesResponse
Voorbeeld

renderEmailTemplate 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Respons
Geeft terug: RenderEmailTemplateResponse
Voorbeeld

updateEmailTemplate 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

getEventLog 
req tenantId urlId userIdWS
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nee |
Response
Retourneert: GetEventLogResponse
Voorbeeld

getGlobalEventLog 
req tenantId urlId userIdWS
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nee |
Antwoord
Retourneert: GetEventLogResponse
Voorbeeld

createFeedPost 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respons
Retourneert: CreateFeedPostsResponse
Voorbeeld

createFeedPostPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostResponse
Voorbeeld

deleteFeedPostPublic 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: DeleteFeedPostPublicResponse
Voorbeeld

getFeedPosts 
req
tenantId
afterId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee |
Respons
Retourneert: GetFeedPostsResponse
Voorbeeld

getFeedPostsPublic 
req tenantId afterId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee | |
| sso | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeUserInfo | boolean | query | Nee |
Respons
Retourneert: PublicFeedPostsResponse
Voorbeeld

getFeedPostsStats 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: FeedPostsStatsResponse
Voorbeeld

getUserReactsPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Response
Retourneert: UserReactsResponse
Example

reactFeedPostPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ReactFeedPostResponse
Voorbeeld

updateFeedPost 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

updateFeedPostPublic 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostResponse
Voorbeeld

flagCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: APIEmptyResponse
Voorbeeld

getGifLarge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Respons
Retourneert: GifGetLargeResponse
Voorbeeld

getGifsSearch 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsSearchResponse
Voorbeeld

getGifsTrending 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsTrendingResponse
Voorbeeld

addHashTag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateHashTagResponse
Example

addHashTagsBulk 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Retourneert: BulkCreateHashTagsResponse
Example

deleteHashTag 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Retourneert: APIEmptyResponse
Example

getHashTags 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Respons
Retourneert: GetHashTagsResponse
Voorbeeld

patchHashTag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Respons
Retourneert: UpdateHashTagResponse
Voorbeeld

getMe 
Identificeert de referentie die in gebruik is: de tenant waartoe deze behoort en, voor OAuth‑tokens, de gebruiker die deze heeft geautoriseerd.
Integraties gebruiken dit om een verbinding te testen en te labelen.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Retourneert: GetMeResponse
Voorbeeld

deleteModerationVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: VoteDeleteResponse
Voorbeeld

getApiComments 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee | |
| count | number | query | Nee | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPIGetCommentsResponse
Voorbeeld

getApiExportStatus 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nee | |
| sso | string | query | Nee |
Response
Returns: ModerationExportStatusResponse
Voorbeeld

getApiIds 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Response
Retourneert: ModerationAPIGetCommentIdsResponse
Voorbeeld

getBanUsersFromComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetBannedUsersFromCommentResponse
Voorbeeld

getCommentBanStatus 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetCommentBanStatusResponse
Voorbeeld

getCommentChildren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld

getCount 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filter | string | query | Nee | |
| searchFilters | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPICountCommentsResponse
Voorbeeld

getCounts 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetBannedUsersCountResponse
Voorbeeld

getLogs 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPIGetLogsResponse
Example

getManualBadges 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetTenantManualBadgesResponse
Example

getManualBadgesForUser 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nee | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: GetUserManualBadgesResponse
Example

getModerationComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nee | |
| includeIP | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPICommentResponse
Voorbeeld

getModerationCommentText 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetCommentTextResponse
Voorbeeld

getPreBanSummary 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Respons
Retourneert: PreBanSummary
Voorbeeld

getSearchCommentsSummary 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sso | string | query | Nee |
Response
Retour: ModerationCommentSearchResponse
Voorbeeld

getSearchPages 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationPageSearchResponse
Voorbeeld

getSearchSites 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationSiteSearchResponse
Voorbeeld

getSearchSuggest 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Respons
Returns: ModerationSuggestResponse
Voorbeeld

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Retourneert: ModerationUserSearchResponse
Example

getTrustFactor 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserTrustFactorResponse
Voorbeeld

getUserBanPreference 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIModerateGetUserBanPreferencesResponse
Example

getUserInternalProfile 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: GetUserInternalProfileResponse
Voorbeeld

postAdjustCommentVotes 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: AdjustVotesResponse
Voorbeeld

postApiExport 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationExportResponse
Voorbeeld

postBanUserFromComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Response
Retourneert: BanUserFromCommentResult
Voorbeeld

postBanUserUndo 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postBulkPreBanSummary 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| includeByUserIdAndEmail | boolean | query | Nee | |
| includeByIP | boolean | query | Nee | |
| includeByEmailDomain | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: BulkPreBanSummary
Voorbeeld

postCommentsByIds 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld

postFlagComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postRemoveComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PostRemoveCommentApiResponse
Voorbeeld

postRestoreDeletedComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Example

postSetCommentApprovalStatus 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetCommentApprovedResponse
Voorbeeld

postSetCommentReviewStatus 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postSetCommentSpamStatus 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| spam | boolean | query | Nee | |
| permNotSpam | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postSetCommentText 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetCommentTextResponse
Voorbeeld

postUnFlagComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: VoteResponse
Example

putAwardBadge 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgeId | string | query | Ja | |
| userId | string | query | Nee | |
| commentId | string | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: AwardUserBadgeResponse
Voorbeeld

putCloseThread 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Returns: APIEmptyResponse
Voorbeeld

putRemoveBadge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: RemoveUserBadgeResponse
Voorbeeld

putReopenThread 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Returns: APIEmptyResponse
Voorbeeld

setTrustFactor 
Parameters
| Name | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| trustFactor | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetUserTrustFactorResponse
Voorbeeld

createModerator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: CreateModeratorResponse
Voorbeeld

deleteModerator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

getModerator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: GetModeratorResponse
Voorbeeld

getModerators 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetModeratorsResponse
Voorbeeld

sendInvite 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

updateModerator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

deleteNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

getCachedNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetCachedNotificationCountResponse
Voorbeeld

getNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee |
Respons
Returns: GetNotificationCountResponse
Voorbeeld

getNotifications 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetNotificationsResponse
Voorbeeld

updateNotification 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

createV1PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

createV2PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: CreateV1PageReact
Voorbeeld

deleteV1PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: CreateV1PageReact
Voorbeeld

deleteV2PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: CreateV1PageReact
Example

getV1PageLikes 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee | |
| includeUserInfo | string | query | Nee | Indien ingesteld, worden de gebruikers die de pagina hebben geliket geretourneerd (avatars en gebruikersnamen). Alleen "public" wordt geaccepteerd, waardoor privéprofielen worden weggelaten. |
Respons
Retourneert: GetV1PageLikes
Voorbeeld

getV2PageReacts 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Wanneer ingesteld, retourneert de gebruikers voor elke react-id (avatars en gebruikersnamen). Alleen "public" wordt geaccepteerd, wat privéprofielen weglaten betekent. |
Response
Returns: GetV2PageReacts
Example

getV2PageReactUsers 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetV2PageReactUsersResponse
Voorbeeld

addPage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: AddPageAPIResponse
Voorbeeld

deletePage 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: DeletePageAPIResponse
Voorbeeld

getOfflineUsers 
Eerdere commenters op de pagina die momenteel NIET online zijn. Gesorteerd op displayName. Gebruik dit na het doorlopen van /users/online om een "Leden"-sectie weer te geven. Cursorpaginering op commenterName: de server loopt via $gt door de partiële {tenantId, urlId, commenterName} index vanaf afterName vooruit, zonder $skip-kosten.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Pagina-URL-identificatie (serverzijde opgeschoond). |
| afterName | string | query | Nee | Cursor: geef nextAfterName uit het vorige antwoord door. |
| afterUserId | string | query | Nee | Cursor-tiebreaker: geef nextAfterUserId uit het vorige antwoord door. Verplicht wanneer afterName is ingesteld, zodat gelijke namen geen items verliezen. |
Response
Retourneert: PageUsersOfflineResponse
Voorbeeld

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Pagina URL identifier (server-side opgeschoond). |
| afterName | string | query | Nee | Cursor: geef nextAfterName door van de vorige respons. |
| afterUserId | string | query | Nee | Cursor-tiebreaker: geef nextAfterUserId door van de vorige respons. Vereist wanneer afterName is ingesteld zodat naam-gelijkstanden geen items verliezen. |
Response
Returns: PageUsersOnlineResponse
Example

getPageByURLId 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetPageByURLIdAPIResponse
Voorbeeld

getPageLikes 
Aantal likes voor een pagina, eventueel met de gebruikers die het hebben geliked.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| includeUserInfo | string | query | Nee | "public" weglaten gebruikers met privéprofielen, "include-private" omvat ze. |
Response
Returns: GetPageLikesAPIResponse
Example

getPageReacts 
Aangepaste react-tellingen voor een pagina, optioneel met de gebruikers die hebben gereageerd.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| includeUserInfo | string | query | Nee | "public" laat gebruikers met privéprofielen weg, "include-private" neemt ze op. |
Response
Retourneert: GetPageReactsAPIResponse
Voorbeeld

getPages 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetPagesAPIResponse
Voorbeeld

getPagesPublic 
List pagina's voor een tenant. Wordt gebruikt door de FChat desktopclient om de kamerlijst te vullen.
Vereist dat enableFChat true is in de opgeloste aangepaste configuratie voor elke pagina.
Pagina's die SSO vereisen worden gefilterd op basis van de groepsrechten van de verzoekende gebruiker.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| cursor | string | query | Nee | Onduidelijke pagineringscursor geretourneerd als nextCursor van een eerdere aanvraag. Gekoppeld aan dezelfde sortBy. |
| limit | integer | query | Nee | 1..200, standaard 50 |
| q | string | query | Nee | Optionele hoofdletterongevoelige titelvoorvoegselfilter. |
| sortBy | string | query | Nee | Sorteervolgorde. updatedAt (standaard, nieuwste eerst), commentCount (meeste reacties eerst), of title (alfabetisch). |
| hasComments | boolean | query | Nee | Indien true, alleen pagina's teruggeven met ten minste één reactie. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneert weergave-informatie van User / SSOUser. Wordt gebruikt door de commentaar-widget om gebruikers te verrijken die net zijn verschenen via een presence event. Geen pagina-context: privacy wordt uniform gehandhaafd (privéprofielen worden gemaskeerd).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | Door komma's gescheiden userIds. |
Antwoord
Retourneert: PageUsersInfoResponse
Voorbeeld

migratePages 
Plaatst een batchtaak in de wachtrij die opmerkingen, pagina's en gerelateerde records van de ene urlId of domein naar de andere verplaatst.
"urlId"-migraties komen alleen overeen met de exacte urlId. "domain"-migraties zoeken/vervangen de waarde binnen elke urlId en url.
Poll GET /api/v1/batch-jobs/{batchJobId}: zodra deze voltooid is, bevat hij per-migratie resultaten en een undoId.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: QueuePageMigrationJobAPIResponse
Example

patchPage 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: PatchPageAPIResponse
Voorbeeld

undoPageMigrations 
Queues a batch job that reverses every migration from one migrate-pages job, newest first. Beschikbaar gedurende 90 dagen.
Records changed since the migration are left alone, so a later edit is never overwritten. Records die sinds de migratie zijn gewijzigd, blijven onaangeroerd, zodat een latere bewerking nooit wordt overschreven.
Poll GET /api/v1/batch-jobs/{batchJobId} for the restored/skipped counts. Poll GET /api/v1/batch-jobs/{batchJobId} voor de herstelde/overgeslagen tellingen.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| undoId | string | path | Ja |
Response
Retourneert: QueuePageMigrationJobAPIResponse
Example

deletePendingWebhookEvent 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

getPendingWebhookEventCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee |
Respons
Retourneert: GetPendingWebhookEventCountResponse
Voorbeeld

getPendingWebhookEvents 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: GetPendingWebhookEventsResponse
Example

createPollVote 
Stem op een poll, of verplaats een bestaande stem naar een andere optie. Een stemmer heeft maximaal één stem per poll, dus het opnieuw aanroepen voor dezelfde stemmer verplaatst hun stem in plaats van er één toe te voegen.
Dit volgt de poll-instellingen van de site: als stemmen alleen is ingesteld voor ingelogde gebruikers, wordt een stem met alleen een anonUserId geweigerd, en anonieme stemmen worden per IP per poll beperkt in snelheid.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Geeft terug: CreatePollVoteResponse
Voorbeeld

deletePollVote 
Trek een stem terug. De optie waarop het werd uitgebracht, geeft de telling terug.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: DeletePollVoteResponse
Voorbeeld

getPollVote 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetPollVoteResponse
Example

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Een poll behoort tot een reactie, dus stemmen worden altijd per poll gelezen - commentId is vereist. Dat houdt elke query op de indexen die de collectie al heeft.
Houdt zich aan de privacy van de poll: de stemmen van een anonieme poll kunnen niet worden gelezen (poll-anonymous), hier of via id.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| voterId | string | query | Nee | |
| optionId | string | query | Nee | |
| skip | integer | query | Nee |
Response
Returns: GetPollVotesResponse
Example

deletePoll 
Verwijder een poll van de bijbehorende reactie, samen met alle uitgebrachte stemmen. De reactie zelf blijft onaangetast.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Voorbeeld

getPoll 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Respons
Retourneert: GetPollResponse
Voorbeeld

getPollVoters 
Wie heeft op welke optie gestemd. Anonieme peilingen antwoorden nooit, peilingen alleen voor admins antwoorden alleen voor een admin of moderator.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: GetPollVoterNamesSuccessResponse
Voorbeeld

patchPoll 
Edit een poll ter plaatse, behoudend de tellingen: wijzig de vraag, hernoem een optie, sluit deze af of open hem opnieuw, of wijzig wie de stemmers mag zien. Opties worden aangesproken via id - om ze toe te voegen, te verwijderen of te herschikken, gebruik PUT voor de volledige lijst.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja |
Respons
Retourneert: SavePollResponse
Voorbeeld

putPoll 
Voeg een poll toe aan een comment, of stel de volledige status in van de poll die deze al heeft.
Opties worden gematcht op id: een optie die wordt verzonden met de id van een bestaande optie behoudt zijn stemmen (en krijgt het nieuwe label en de nieuwe positie), een optie die zonder id wordt verzonden wordt toegevoegd, en bestaande opties die niet in de lijst staan worden verwijderd, samen met de op hen uitgebrachte stemmen.
Als je geen bestaande optie-ids behoudt op een poll waarop stemmen zijn uitgebracht, worden alle stemmen verwijderd, dus daarvoor is replaceVotes=true nodig.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| replaceVotes | boolean | query | No |
Response
Geeft terug: SavePollResponse
Example

votePoll 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: VotePollResponse
Voorbeeld

createQuestionConfig 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateQuestionConfigResponse
Voorbeeld

deleteQuestionConfig 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

getQuestionConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetQuestionConfigResponse
Voorbeeld

getQuestionConfigs 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionConfigsResponse
Voorbeeld

updateQuestionConfig 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

createQuestionResult 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Reactie
Retourneert: CreateQuestionResultResponse
Voorbeeld

deleteQuestionResult 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

getQuestionResult 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetQuestionResultResponse
Voorbeeld

getQuestionResults 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| startDate | string | query | Nee | |
| questionId | string | query | Nee | |
| questionIds | string | query | Nee | |
| skip | number | query | Nee |
Respons
Returns: GetQuestionResultsResponse
Voorbeeld

updateQuestionResult 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Reactie
Retourneert: APIEmptyResponse
Voorbeeld

aggregateQuestionResults 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| timeBucket | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee |
Response
Retourneert: AggregateQuestionResultsResponse
Example

bulkAggregateQuestionResults 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Respons
Retourneert: BulkAggregateQuestionResultsResponse
Voorbeeld

combineCommentsWithQuestionResults 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee | |
| minValue | number | query | Nee | |
| maxValue | number | query | Nee | |
| limit | number | query | Nee |
Respons
Retourneert: CombineQuestionResultsWithCommentsResponse
Voorbeeld

addSSOUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: AddSSOUserAPIResponse
Voorbeeld

deleteSSOUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Respons
Retourneert: DeleteSSOUserAPIResponse
Voorbeeld

getSSOUserByEmail 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Antwoord
Retourneert: GetSSOUserByEmailAPIResponse
Voorbeeld

getSSOUserById 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetSSOUserByIdAPIResponse
Voorbeeld

getSSOUsers 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Antwoord
Retourneert: GetSSOUsersResponse
Voorbeeld

patchSSOUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Response
Retourneert: PatchSSOUserAPIResponse
Voorbeeld

putSSOUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Respons
Retourneert: PutSSOUserAPIResponse
Voorbeeld

createSubscription 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateSubscriptionAPIResponse
Voorbeeld

deleteSubscription 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Response
Retourneert: DeleteSubscriptionAPIResponse
Example

getSubscriptions 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: GetSubscriptionsAPIResponse
Voorbeeld

updateSubscription 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: UpdateSubscriptionAPIResponse
Voorbeeld

getTenantDailyUsages 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respons
Retourneert: GetTenantDailyUsagesResponse
Voorbeeld

createTenantPackage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateTenantPackageResponse
Voorbeeld

deleteTenantPackage 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Voorbeeld

getTenantPackage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: GetTenantPackageResponse
Voorbeeld

getTenantPackages 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Geeft terug: GetTenantPackagesResponse
Voorbeeld

replaceTenantPackage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Voorbeeld

updateTenantPackage 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

createTenantUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateTenantUserResponse
Voorbeeld

deleteTenantUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Respons
Retourneert: APIEmptyResponse
Example

getTenantUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetTenantUserResponse
Voorbeeld

getTenantUsers 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetTenantUsersResponse
Voorbeeld

replaceTenantUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

sendLoginLink 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

updateTenantUser 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

createTenant 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Retourneert: CreateTenantResponse
Voorbeeld

deleteTenant 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

getTenant 
Parameters
| Name | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetTenantResponse
Voorbeeld

getTenants 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantsResponse
Voorbeeld

updateTenant 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Voorbeeld

changeTicketState 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: ChangeTicketStateResponse
Example

createTicket 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Antwoord
Retourneert: CreateTicketResponse
Voorbeeld

getTicket 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: GetTicketResponse
Voorbeeld

getTickets 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| state | number | query | Nee | |
| skip | number | query | Nee | |
| limit | number | query | Nee |
Response
Returns: GetTicketsResponse
Example

getTranslations 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Response
Retourneert: GetTranslationsResponse
Voorbeeld

uploadImage 
Afbeelding uploaden en schalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Grootte‑voorinstelling: "Default" (1000x1000px) of "CrossPlatform" (maakt groottes voor populaire apparaten) |
| urlId | string | query | No | Pagina‑id vanwaar de upload plaatsvindt, om te configureren |
Response
Retourneert: UploadImageResponse
Voorbeeld

getUserBadgeProgressById 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIGetUserBadgeProgressResponse
Voorbeeld

getUserBadgeProgressByUserId 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Respons
Geeft terug: APIGetUserBadgeProgressResponse
Voorbeeld

getUserBadgeProgressList 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: APIGetUserBadgeProgressListResponse
Voorbeeld

createUserBadge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: APICreateUserBadgeResponse
Voorbeeld

deleteUserBadge 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIEmptySuccessResponse
Voorbeeld

getUserBadge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIGetUserBadgeResponse
Voorbeeld

getUserBadges 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| badgeId | string | query | Nee | |
| type | number | query | Nee | |
| displayedOnComments | boolean | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: APIGetUserBadgesResponse
Voorbeeld

updateUserBadge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptySuccessResponse
Voorbeeld

getUserNotificationCount 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetUserNotificationCountResponse
Voorbeeld

getUserNotifications 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Wordt gebruikt om te bepalen of de huidige pagina geabonneerd is. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Response
Retourneert: GetMyNotificationsResponse
Example

resetUserNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ResetUserNotificationsResponse
Voorbeeld

resetUserNotifications 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| afterCreatedAt | integer | query | Nee | |
| unreadOnly | boolean | query | Nee | |
| dmOnly | boolean | query | Nee | |
| noDm | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ResetUserNotificationsResponse
Example

updateUserNotificationCommentSubscriptionStatus 
Schakel meldingen in of uit voor een specifieke reactie.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Geeft terug: UpdateUserNotificationCommentSubscriptionStatusResponse
Voorbeeld

updateUserNotificationPageSubscriptionStatus 
Schakel meldingen voor een pagina in of uit. Wanneer gebruikers op een pagina zijn geabonneerd, worden meldingen aangemaakt voor nieuwe root-opmerkingen, en ook
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: UpdateUserNotificationPageSubscriptionStatusResponse
Voorbeeld

updateUserNotificationStatus 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UpdateUserNotificationStatusResponse
Voorbeeld

getUserPresenceStatuses 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Respons
Retourneert: GetUserPresenceStatusesResponse
Voorbeeld

searchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Respons
Retourneert: SearchUsersResult
Voorbeeld

getUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetUserResponse
Voorbeeld

createVote 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: VoteResponse
Voorbeeld

deleteVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nee |
Antwoord
Retourneert: VoteDeleteResponse
Voorbeeld

getVotes 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetVotesResponse
Voorbeeld

getVotesForUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: GetVotesForUserResponse
Example

createWebhook 
Abonneert een URL op een commentaar‑evenement (REST‑hook‑abonnement). Het opnieuw abonneren van dezelfde
URL op hetzelfde evenement en domein retourneert de bestaande abonnement. Leveringen zijn HMAC‑ondertekend, zie de
webhooks‑gids; de verouderde token‑header wordt nooit verzonden naar API‑abonnementen.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Reactie
Retourneert: CreateWebhookResponse
Voorbeeld

deleteWebhook 
Unsubscribes (REST hook unsubscribe). Alleen abonnementen die via deze API zijn aangemaakt, kunnen hier worden verwijderd; dashboard-beheerde webhooks worden bewerkt in het dashboard.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

getWebhooks 
Lijst de webhooks die zijn geconfigureerd voor de tenant, zowel dashboard‑beheerde rijen als API‑abonnementen.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| event | string | query | Nee | |
| domain | string | query | Nee | |
| source | string | query | Nee | |
| skip | number | query | Nee |
Reactie
Returns: GetWebhooksResponse
Voorbeeld

getWebhookSamplePayloads 
Recente opmerkingen in precies de vorm die webhookleveringen gebruiken, voor het bouwen van integraties (bijvoorbeeld Zapier voorbeeldgegevens). Elk evenement levert hetzelfde opmerkingobject, dus event hoeft alleen geldig te zijn.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| event | string | query | Nee | |
| limit | number | query | Nee |
Respons
Retourneert: GetWebhookSamplePayloadsResponse
Voorbeeld

Hulp nodig?
Als u problemen ondervindt of vragen heeft over de Swift SDK, neem dan contact op via:
Bijdragen
Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.