
Lingua 🇮🇹 Italiano
Documentazione
Iniziare
Tenant di agenti
Aggregazione
Registri di audit
Autenticazione
Processi batch
Blocco dal commento
Controlla commenti bloccati
Commenti
Commenti per utente
Configurazioni dominio
Modelli email
Registro eventi
Post del feed
Segnala commento
GIF
Hashtag
Io
Moderazione
Moderatori
Conteggio notifiche
Notifiche
Reazioni pagina
Pagine
Eventi webhook in sospeso
Voti sondaggio
Sondaggi
Configurazioni domanda
Risultati domanda
Aggregazione risultati domanda
Utenti SSO
Sottoscrizioni
Utilizzo giornaliero tenant
Pacchetti tenant
Utenti tenant
Tenant
Ticket
Traduzioni
Carica immagine
Progresso badge utente
Badge utente
Notifiche utente
Stato presenza utente
Ricerca utenti
Utenti
Voti
Webhook
FastComments Java SDK
Questo è l'SDK Java ufficiale di FastComments.
SDK Java ufficiale per l'API di FastComments
Repository
Agenti di codifica AI 
Fornisci al tuo agente di codifica il contesto FastComments di cui ha bisogno - widget, configurazione, Secure SSO, l'API REST e gli SDK:
npx skills add fastcomments/skills
Funziona con Claude Code, Codex, Cursor, Copilot, Gemini e tutti gli altri agenti supportati dal skills CLI.
Installazione 
Maven
Aggiungi il repository Repsy al POM del tuo progetto:
<repositories>
<repository>
<id>repsy</id>
<name>FastComments Maven Repository on Repsy</name>
<url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
</repository>
</repositories>
Quindi aggiungi le dipendenze di cui hai bisogno:
<dependencies>
<!-- API Client -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>client</artifactId>
<version>3.1.1</version>
</dependency>
<!-- Core Library (include SSO) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>core</artifactId>
<version>3.1.1</version>
</dependency>
<!-- PubSub Library (per eventi live) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>pubsub</artifactId>
<version>3.1.1</version>
</dependency>
</dependencies>
Gradle
Aggiungi il repository Repsy al tuo file build.gradle:
repositories {
mavenCentral()
maven {
url "https://repo.repsy.io/mvn/winrid/fastcomments"
}
}
dependencies {
// API Client
implementation "com.fastcomments:client:3.1.1"
// Core Library (include SSO)
implementation "com.fastcomments:core:3.1.1"
// PubSub Library (per eventi live)
implementation "com.fastcomments:pubsub:3.1.1"
}
Contenuto della Libreria
Questa libreria contiene tre moduli: il client API generato, la libreria Java core che contiene utilità scritte a mano
per semplificare l'interazione con l'API, e il modulo pubsub che è una libreria per sottoscriversi ai feed di modifiche.
- Documentazione della API Client Library
- Documentazione della Core Library, Inclusi Esempi SSO
- Documentazione della PubSub Library
API Pubbliche vs API Protette
Per il client API, esistono tre classi: DefaultApi, PublicApi e ModerationApi. La DefaultApi contiene metodi che richiedono la tua API key, mentre la PublicApi contiene metodi
che possono essere invocati direttamente da un browser/dispositivo mobile/ecc senza autenticazione.
La ModerationApi fornisce un'ampia suite di API di moderazione live e veloci. Ogni metodo di ModerationApi accetta un parametro sso e può autenticarsi tramite SSO o un cookie di sessione di FastComments.com.
Avvio rapido 
Utilizzo delle API Autenticate (DefaultApi)
Importante: Devi impostare la tua API key su ApiClient prima di effettuare richieste autenticate. Se non lo fai, le richieste falliranno con un errore 401.
import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.api.DefaultApi;
import com.fastcomments.model.*;
public class Example {
public static void main(String[] args) {
// Crea e configura il client API
ApiClient apiClient = new ApiClient();
// OBBLIGATORIO: Imposta la tua API key (prendila dalla dashboard di FastComments)
apiClient.setApiKey("YOUR_API_KEY_HERE");
// Crea l'istanza API con il client configurato
DefaultApi api = new DefaultApi(apiClient);
// Ora puoi effettuare chiamate API autenticate
try {
// Esempio: Aggiungi un utente SSO
CreateAPISSOUserData userData = new CreateAPISSOUserData();
userData.setId("user-123");
userData.setEmail("user@example.com");
userData.setDisplayName("John Doe");
AddSSOUserAPIResponse response = api.addSSOUser("YOUR_TENANT_ID", userData)
.execute();
System.out.println("User created: " + response);
} catch (ApiException e) {
System.err.println("Error: " + e.getResponseBody());
// Errori comuni:
// - 401: Mancante o invalida API key
// - 400: La validazione della richiesta è fallita
}
}
}
Utilizzo delle API Pubbliche (PublicApi)
Gli endpoint pubblici non richiedono autenticazione:
import com.fastcomments.api.PublicApi;
import com.fastcomments.invoker.ApiException;
PublicApi publicApi = new PublicApi();
try {
var response = publicApi.getCommentsPublic("YOUR_TENANT_ID", "page-url-id")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Utilizzo delle API di Moderazione (ModerationApi)
La ModerationApi gestisce la dashboard dei moderatori. Ogni metodo accetta un parametro sso che identifica il moderatore autenticato via SSO per conto del quale viene effettuata la richiesta:
import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;
ModerationApi moderationApi = new ModerationApi();
try {
// Elenca i commenti in attesa di moderazione
ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
.sso("YOUR_SSO_TOKEN")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Problemi comuni
- 401 "missing-api-key" error: Assicurati di chiamare
apiClient.setApiKey("YOUR_KEY")prima di creare l'istanza DefaultApi. - Classe API errata: Usa
DefaultApiper richieste autenticate lato server,PublicApiper richieste client-side/pubbliche. - Null API key: L'SDK salterà silenziosamente l'autenticazione se la API key è null, causando errori 401.
Note 
ID di broadcast
Vedrai che dovrai passare un broadcastId in alcune chiamate API. Quando riceverai eventi, ti verrà restituito questo ID, così saprai di ignorare l'evento se prevedi di applicare le modifiche in modo ottimistico sul client
(probabilmente vorrai farlo, perché offre la migliore esperienza). Passa un UUID qui. L'ID dovrebbe essere sufficientemente unico da non ripetersi due volte durante una sessione del browser.
createAgentTenant 
Crea un nuovo account di prova per un agente AI senza la registrazione da parte di un umano. Non è necessaria alcuna chiave API per chiamare questo.
La risposta contiene l'ID del tenant, una chiave API che funziona immediatamente contro l'API REST e il server MCP, e un URL di reclamo. Fornisci l'URL di reclamo all'umano per cui stai lavorando: aprirlo mentre sei connesso a FastComments associa l'account a loro. Gli account non reclamati, e le loro chiavi, vengono eliminati 72 ore dopo la creazione. Fino a quando non vengono reclamati, l'account ha i limiti standard di prova.
Response
Returns: CreateAgentTenantResponse
Example

aggregate 
Aggrega i documenti raggruppandoli (se groupBy è fornito) e applicando più operazioni. Sono supportate diverse operazioni (ad esempio sum, countDistinct, avg, ecc.).
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Risposta
Restituisce: AggregateResponse
Esempio

getAuditLogs 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | Il tenant per cui leggere i log di audit. |
| limit | integer | query | No | Quanti log restituire. Max 10000, valore predefinito 1000. |
| skip | integer | query | No | Quanti log saltare, per paginazione. |
| order | string | query | No | Direzione di ordinamento sul tempo dell'evento. Predefinito DESC (più recenti per primi). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Restituisce solo gli eventi eseguiti da questo nome utente. |
| ip | string | query | No | Restituisce solo gli eventi da questo indirizzo IP. |
| crudType | string | query | No | Restituisce solo gli eventi di questo tipo: c, r, u, d, o login. |
| resourceName | string | query | No | Restituisce solo gli eventi per questa risorsa, ad es. User o Moderator. |
| targetId | string | query | No | Restituisce solo gli eventi il cui oggetto interessato ha questo ID. |
| target | string | query | No | Corrispondenza di sottostringa non sensibile a maiuscole/minuscole sull'etichetta dell'oggetto interessato, ad es. un nome utente o email. |
| includeManagedTenants | boolean | query | No | Restituisce anche gli eventi dai tenant che questo tenant gestisce. |
Response
Restituisce: GetAuditLogsResponse
Esempio

logoutPublic 
Risposta
Restituisce: APIEmptyResponse
Esempio

getBatchJob 
Stato, avanzamento e, una volta completato, il risultato di un batch job.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetBatchJobAPIResponse
Esempio

getBatchJobs 
I lavori batch del tenant (importazioni, esportazioni, migrazioni di pagine...), più recenti per primi.
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| type | string | query | No | Solo lavori di questo tipo, ad esempio migrate-pages. |
| status | string | query | No | Solo lavori con questo stato: requested, running, success o failed. |
| skip | integer | query | No | Quanti lavori saltare, per paginazione. |
Response
Returns: GetBatchJobsAPIResponse
Example

blockFromCommentPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: BlockSuccess
Esempio

unBlockCommentPublic 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: UnblockSuccess
Esempio

checkedCommentsForBlocked 
Parametri
| Nome | Tipo | Location | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentIds | string | query | Sì | Una lista di ID dei commenti separati da virgole. |
| sso | string | query | No |
Risposta
Restituisce: CheckBlockedCommentsResponse
Esempio

blockUserFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: BlockSuccess
Esempio

createCommentPublic 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| broadcastId | string | query | Sì | |
| sessionId | string | query | No | |
| sso | string | query | No | |
| locale | string | query | No |
Response
Restituisce: SaveCommentsResponseWithPresence
Example

deleteComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Risposta
Restituisce: DeleteCommentResult
Esempio

deleteCommentPublic 
Parametri
| Name | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PublicAPIDeleteCommentResponse
Esempio

deleteCommentVote 
Parametri
| Nome | Type | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| voteId | string | path | Sì | |
| urlId | string | query | Sì | |
| broadcastId | string | query | Sì | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VoteDeleteResponse
Esempio

flagComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: FlagCommentResponse
Esempio

getComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIGetCommentResponse
Esempio

getComments 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Risposta
Restituisce: APIGetCommentsResponse
Esempio

getCommentsPublic 
req tenantId urlId
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Risposta
Restituisce: GetCommentsResponseWithPresencePublicComment
Esempio

getCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PublicAPIGetCommentTextResponse
Esempio

getCommentVoteUserNames 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| dir | integer | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetCommentVoteUserNamesSuccessResponse
Esempio

lockComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

pinComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ChangeCommentPinStatusResponse
Esempio

saveComment 
Parametri
| Name | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Risposta
Restituisce: APISaveCommentResponse
Esempio

saveCommentsBulk 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Risposta
Restituisce: SaveCommentsBulkResponse
Esempio

setCommentText 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PublicAPISetCommentTextResponse
Esempio

translateComments 
Traduce i commenti forniti nella lingua del widget. Disponibile solo quando la regola di personalizzazione del widget corrispondente ha la Traduzione dei Commenti impostata su Automatico o Manuale.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Risposta
Restituisce: CommentTranslationsResponse
Esempio

unBlockUserFromComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: UnblockSuccess
Esempio

unFlagComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: FlagCommentResponse
Esempio

unLockComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

unPinComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ChangeCommentPinStatusResponse
Esempio

updateComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

voteComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| urlId | string | query | Sì | |
| broadcastId | string | query | Sì | |
| sessionId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VoteResponse
Esempio

getCommentsForUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Risposta
Restituisce: GetCommentsForUserResponse
Esempio

addDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddDomainConfigResponse
Esempio

deleteDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domain | string | path | Sì |
Risposta
Restituisce: DeleteDomainConfigResponse
Esempio

getDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domain | string | path | Sì |
Risposta
Restituisce: GetDomainConfigResponse
Esempio

getDomainConfigs 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: GetDomainConfigsResponse
Esempio

patchDomainConfig 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domainToUpdate | string | path | Sì |
Risposta
Restituisce: PatchDomainConfigResponse
Esempio

putDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domainToUpdate | string | path | Sì |
Risposta
Restituisce: PutDomainConfigResponse
Esempio

createEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateEmailTemplateResponse
Esempio

deleteEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Response
Restituisce: APIEmptyResponse
Esempio

deleteEmailTemplateRenderError 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| errorId | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getEmailTemplate 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetEmailTemplateResponse
Esempio

getEmailTemplateDefinitions 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: GetEmailTemplateDefinitionsResponse
Esempio

getEmailTemplateRenderErrors 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetEmailTemplateRenderErrorsResponse
Esempio

getEmailTemplates 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetEmailTemplatesResponse
Esempio

renderEmailTemplate 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| locale | string | query | No |
Risposta
Restituisce: RenderEmailTemplateResponse
Esempio

updateEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getEventLog 
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
Risposta
Restituisce: GetEventLogResponse
Esempio

getGlobalEventLog 
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| userIdWS | string | query | Sì | |
| startTime | integer | query | Sì | |
| endTime | integer | query | No |
Risposta
Restituisce: GetEventLogResponse
Esempio

createFeedPost 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Risposta
Restituisce: CreateFeedPostsResponse
Esempio

createFeedPostPublic 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: CreateFeedPostResponse
Esempio

deleteFeedPostPublic 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: DeleteFeedPostPublicResponse
Esempio

getFeedPosts 
req tenantId afterId
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Risposta
Restituisce: GetFeedPostsResponse
Esempio

getFeedPostsPublic 
req tenantId afterId
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Risposta
Restituisce: PublicFeedPostsResponse
Esempio

getFeedPostsStats 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| postIds | array | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: FeedPostsStatsResponse
Esempio

getUserReactsPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| postIds | array | query | No | |
| sso | string | query | No |
Risposta
Restituisce: UserReactsResponse
Esempio

reactFeedPostPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ReactFeedPostResponse
Esempio

updateFeedPost 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateFeedPostPublic 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | percorso | Sì | |
| postId | string | percorso | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: CreateFeedPostResponse
Esempio

flagCommentPublic 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| isFlagged | boolean | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getGifLarge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| largeInternalURLSanitized | string | query | Sì |
Risposta
Restituisce: GifGetLargeResponse
Esempio

getGifsSearch 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| search | string | query | Sì | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Risposta
Restituisce: GetGifsSearchResponse
Esempio

getGifsTrending 
Parametri
| Nome | Tipo | Location | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Risposta
Restituisce: GetGifsTrendingResponse
Esempio

addHashTag 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateHashTagResponse
Esempio

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

deleteHashTag 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| tag | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getHashTags 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| page | number | query | No |
Risposta
Restituisce: GetHashTagsResponse
Esempio

patchHashTag 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Risposta
Restituisce: UpdateHashTagResponse
Esempio

getMe 
Identifica le credenziali in uso: il tenant a cui appartiene e, per i token OAuth, l'utente che le ha autorizzate. Le integrazioni usano questo per testare una connessione e etichettarla.
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Response
Restituisce: GetMeResponse
Example

deleteModerationVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VoteDeleteResponse
Esempio

getApiComments 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIGetCommentsResponse
Esempio

getApiExportStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationExportStatusResponse
Esempio

getApiIds 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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 |
Risposta
Restituisce: ModerationAPIGetCommentIdsResponse
Esempio

getBanUsersFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Returns: GetBannedUsersFromCommentResponse
Esempio

getCommentBanStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetCommentBanStatusResponse
Esempio

getCommentChildren 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIChildCommentsResponse
Esempio

getCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPICountCommentsResponse
Esempio

getCounts 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Risposta
Restituisce: GetBannedUsersCountResponse
Esempio

getLogs 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIGetLogsResponse
Esempio

getManualBadges 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetTenantManualBadgesResponse
Esempio

getManualBadgesForUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: GetUserManualBadgesResponse
Esempio

getModerationComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPICommentResponse
Esempio

getModerationCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetCommentTextResponse
Esempio

getPreBanSummary 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PreBanSummary
Esempio

getSearchCommentsSummary 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sSO | string | query | No |
Risposta
Restituisce: ModerationCommentSearchResponse
Esempio

getSearchPages 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationPageSearchResponse
Esempio

getSearchSites 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| value | string | query | No | |
| sso | string | query | No |
Response
Restituisce: ModerationSiteSearchResponse
Example

getSearchSuggest 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationSuggestResponse
Esempio

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

getTrustFactor 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: GetUserTrustFactorResponse
Esempio

getUserBanPreference 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIModerateGetUserBanPreferencesResponse
Esempio

getUserInternalProfile 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: GetUserInternalProfileResponse
Esempio

postAdjustCommentVotes 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: AdjustVotesResponse
Esempio

postApiExport 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationExportResponse
Esempio

postBanUserFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| 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 |
Risposta
Restituisce: BanUserFromCommentResult
Esempio

postBanUserUndo 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postBulkPreBanSummary 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: BulkPreBanSummary
Esempio

postCommentsByIds 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIChildCommentsResponse
Esempio

postFlagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postRemoveComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Returns: PostRemoveCommentApiResponse
Esempio

postRestoreDeletedComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postSetCommentApprovalStatus 
Parameters
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Restituisce: SetCommentApprovedResponse
Esempio

postSetCommentReviewStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postSetCommentSpamStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postSetCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: SetCommentTextResponse
Esempio

postUnFlagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VoteResponse
Esempio

putAwardBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| badgeId | string | query | Sì | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: AwardUserBadgeResponse
Esempio

putCloseThread 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

putRemoveBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: RemoveUserBadgeResponse
Esempio

putReopenThread 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Risposta
Returns: APIEmptyResponse
Esempio

setTrustFactor 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: SetUserTrustFactorResponse
Esempio

createModerator 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateModeratorResponse
Esempio

deleteModerator 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| sendEmail | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getModerator 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetModeratorResponse
Esempio

getModerators 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetModeratorsResponse
Esempio

sendInvite 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| fromName | string | query | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateModerator 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

deleteNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getCachedNotificationCount 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetCachedNotificationCountResponse
Esempio

getNotificationCount 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Risposta
Restituisce: GetNotificationCountResponse
Esempio

getNotifications 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetNotificationsResponse
Esempio

updateNotification 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

createV1PageReact 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| title | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: CreateV1PageReact
Esempio

createV2PageReact 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| id | string | query | Sì | |
| title | string | query | No | |
| sso | string | query | No |
Response
Restituisce: CreateV1PageReact
Esempio

deleteV1PageReact 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: CreateV1PageReact
Esempio

deleteV2PageReact 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| id | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: CreateV1PageReact
Esempio

getV1PageLikes 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Quando impostato, restituisce gli utenti che hanno messo "Mi piace" alla pagina (avatar e nomi utente). È accettato solo "public", che omette i profili privati. |
Risposta
Restituisce: GetV1PageLikes
Esempio

getV2PageReacts 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Quando impostato, restituisce gli utenti per ogni ID di reazione (avatar e nomi utente). Solo "public" è accettato, il che omette i profili privati. |
Risposta
Restituisce: GetV2PageReacts
Esempio

getV2PageReactUsers 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| id | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetV2PageReactUsersResponse
Esempio

addPage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddPageAPIResponse
Esempio

deletePage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: DeletePageAPIResponse
Esempio

getOfflineUsers 
Commentatori passati sulla pagina che NON sono attualmente online. Ordinati per displayName. Usalo dopo aver esaurito /users/online per mostrare una sezione "Membri". Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Page URL identifier (cleaned server-side). |
| afterName | string | query | No | Cursor: pass nextAfterName from the previous response. |
| afterUserId | string | query | No | Cursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries. |
Risposta
Restituisce: PageUsersOfflineResponse
Esempio

getOnlineUsers 
Visualizzatori attualmente online di una pagina: persone la cui sessione websocket è sottoscritta alla pagina in questo momento. Restituisce anonCount + totalCount (iscritti a livello di stanza, inclusi gli spettatori anonimi che non elenchiamo).
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | Identificatore dell'URL della pagina (ripulito lato server). |
| afterName | string | query | No | Cursore: passa nextAfterName dalla risposta precedente. |
| afterUserId | string | query | No | Cursore tie-breaker: passa nextAfterUserId dalla risposta precedente. Richiesto quando afterName è impostato in modo che i pareggi di nome non facciano perdere voci. |
Risposta
Restituisce: PageUsersOnlineResponse
Esempio

getPageByURLId 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetPageByURLIdAPIResponse
Esempio

getPageLikes 
Numero di like di una pagina, opzionalmente con gli utenti che hanno messo like.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| includeUserInfo | string | query | No | "public" omette gli utenti con profili privati, "include-private" li include. |
Risposta
Restituisce: GetPageLikesAPIResponse
Esempio

getPageReacts 
Conteggi personalizzati delle reazioni per una pagina, opzionalmente con gli utenti che hanno reagito.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| includeUserInfo | string | query | No | "public" omette gli utenti con profili privati, "include-private" li include. |
Risposta
Restituisce: GetPageReactsAPIResponse
Esempio

getPages 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: GetPagesAPIResponse
Esempio

getPagesPublic 
Elenca le pagine per un tenant. Utilizzato dal client desktop FChat per popolare l'elenco delle sue stanze.
Richiede che enableFChat sia true sulla configurazione personalizzata risolta per ogni pagina.
Le pagine che richiedono SSO sono filtrate in base all'accesso per gruppi dell'utente che effettua la richiesta.
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Cursore di paginazione opaco restituito come nextCursor da una richiesta precedente. Legato allo stesso sortBy. |
| limit | integer | query | No | 1..200, predefinito 50 |
| q | string | query | No | Filtro opzionale per prefisso del titolo, senza distinzione tra maiuscole e minuscole. |
| sortBy | string | query | No | Ordinamento. updatedAt (predefinito, i più recenti prima), commentCount (i più commentati prima), o title (alfabetico). |
| hasComments | boolean | query | No | Se true, restituisce solo le pagine con almeno un commento. |
Risposta
Restituisce: GetPublicPagesResponse
Esempio

getUsersInfo 
Informazioni utente in blocco per un tenant. Dati gli userIds, restituisce le informazioni di visualizzazione da User / SSOUser. Usato dal widget dei commenti per arricchire gli utenti appena comparsi tramite un evento di presenza. Nessun contesto di pagina: la privacy è applicata in modo uniforme (i profili privati sono oscurati).
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds separati da virgola. |
Response
Restituisce: PageUsersInfoResponse
Esempio

migratePages 
Accoda un lavoro batch che sposta commenti, pagine e record correlati da un urlId o dominio a un altro.
Le migrazioni "urlId" corrispondono solo all'esatto urlId. Le migrazioni "domain" trovano/sostituiscono il valore all'interno di ogni urlId e url.
Esegui il polling GET /api/v1/batch-jobs/{batchJobId}: una volta completato, restituisce i risultati per migrazione e un undoId.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: QueuePageMigrationJobAPIResponse
Esempio

patchPage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: PatchPageAPIResponse
Esempio

undoPageMigrations 
Accoda un lavoro batch che annulla ogni migrazione da un lavoro migrate‑pages, dal più recente al più vecchio. Disponibile per 90 giorni.
I record modificati dopo la migrazione vengono lasciati invariati, così una modifica successiva non viene mai sovrascritta.
Esegui il polling GET /api/v1/batch-jobs/{batchJobId} per ottenere i conteggi di ripristinati/ignorati.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| undoId | string | path | Sì |
Risposta
Restituisce: QueuePageMigrationJobAPIResponse
Esempio

deletePendingWebhookEvent 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getPendingWebhookEventCount 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Risposta
Restituisce: GetPendingWebhookEventCountResponse
Esempio

getPendingWebhookEvents 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetPendingWebhookEventsResponse
Esempio

createPollVote 
Registra un voto su un sondaggio, o sposta uno esistente su un'opzione diversa. Un elettore può avere al massimo un voto per sondaggio, quindi chiamare nuovamente questo endpoint per lo stesso elettore sposta il suo voto invece di aggiungerne uno.
Questo rispetta le impostazioni del sondaggio del sito: se il voto è impostato solo per utenti autenticati, un voto con solo anonUserId viene rifiutato, e i voti anonimi sono limitati per IP per sondaggio.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Risposta
Restituisce: CreatePollVoteResponse
Esempio

deletePollVote 
Ritira un voto. L'opzione su cui è stato espresso restituisce il suo conteggio.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: DeletePollVoteResponse
Esempio

getPollVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetPollVoteResponse
Esempio

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Un sondaggio appartiene a un commento, quindi i voti vengono sempre letti un sondaggio alla volta - commentId è obbligatorio. Questo mantiene ogni query sugli indici già presenti nella collezione.
Rispetta la privacy del sondaggio: i voti di un sondaggio anonimo non possono essere letti (poll-anonymous), né qui né tramite ID.
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| voterId | string | query | No | |
| optionId | string | query | No | |
| skip | integer | query | No |
Response
Restituisce: GetPollVotesResponse
Esempio

deletePoll 
Rimuovi un sondaggio dal suo commento, insieme a tutti i voti espressi su di esso. Il commento stesso rimane intatto.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Risposta
Returns: APIEmptyResponse
Esempio

getPoll 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì |
Risposta
Restituisce: GetPollResponse
Esempio

getPollVoters 
Chi ha votato per quale opzione. I sondaggi anonimi non rispondono mai, i sondaggi solo per amministratori rispondono solo per un amministratore o moderatore.
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Response
Restituisce: GetPollVoterNamesSuccessResponse
Example

patchPoll 
Modifica un sondaggio in loco, mantenendo i suoi risultati: cambia la domanda, rinomina un’opzione, chiudi o riapri il sondaggio, o modifica chi può vedere i votanti. Le opzioni sono identificate tramite id – per aggiungerle, rimuoverle o riordinarle, esegui un PUT dell’elenco completo.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Risposta
Restituisce: SavePollResponse
Esempio

putPoll 
Allega un sondaggio a un commento, oppure imposta lo stato completo del sondaggio che possiede già.
Le opzioni vengono abbinate tramite id: un'opzione inviata con l'id di un'opzione esistente conserva i suoi voti (e assume la nuova etichetta e posizione), un'opzione inviata senza id viene aggiunta, e le opzioni esistenti omesse dall'elenco vengono rimosse insieme ai voti espressi su di esse.
Non mantenere nessun id di opzione esistente su un sondaggio che ha voti li elimina tutti, quindi in quel caso è necessario replaceVotes=true.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| replaceVotes | boolean | query | No |
Risposta
Restituisce: SavePollResponse
Esempio

votePoll 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| urlId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VotePollResponse
Esempio

createQuestionConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateQuestionConfigResponse
Esempio

deleteQuestionConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getQuestionConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetQuestionConfigResponse
Esempio

getQuestionConfigs 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Risposta
Restituisce: GetQuestionConfigsResponse
Esempio

updateQuestionConfig 
Parametri
| Nome | Type | Location | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

createQuestionResult 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateQuestionResultResponse
Esempio

deleteQuestionResult 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getQuestionResult 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetQuestionResultResponse
Esempio

getQuestionResults 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetQuestionResultsResponse
Esempio

updateQuestionResult 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

aggregateQuestionResults 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Risposta
Restituisce: AggregateQuestionResultsResponse
Esempio

bulkAggregateQuestionResults 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| forceRecalculate | boolean | query | No |
Response
Restituisce: BulkAggregateQuestionResultsResponse
Esempio

combineCommentsWithQuestionResults 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Risposta
Restituisce: CombineQuestionResultsWithCommentsResponse
Esempio

addSSOUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddSSOUserAPIResponse
Esempio

deleteSSOUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Risposta
Restituisce: DeleteSSOUserAPIResponse
Esempio

getSSOUserByEmail 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| string | path | Sì |
Risposta
Restituisce: GetSSOUserByEmailAPIResponse
Esempio

getSSOUserById 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetSSOUserByIdAPIResponse
Esempio

getSSOUsers 
Parametri
| Nome | Type | Location | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | integer | query | No |
Risposta
Restituisce: GetSSOUsersResponse
Esempio

patchSSOUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| updateComments | boolean | query | No |
Risposta
Restituisce: PatchSSOUserAPIResponse
Esempio

putSSOUser 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| updateComments | boolean | query | No |
Risposta
Restituisce: PutSSOUserAPIResponse
Esempio

createSubscription 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateSubscriptionAPIResponse
Esempio

deleteSubscription 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: DeleteSubscriptionAPIResponse
Esempio

getSubscriptions 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No |
Risposta
Restituisce: GetSubscriptionsAPIResponse
Esempio

updateSubscription 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: UpdateSubscriptionAPIResponse
Esempio

getTenantDailyUsages 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantDailyUsagesResponse
Esempio

createTenantPackage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateTenantPackageResponse
Esempio

deleteTenantPackage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: APIEmptyResponse
Esempio

getTenantPackage 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetTenantPackageResponse
Esempio

getTenantPackages 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantPackagesResponse
Esempio

replaceTenantPackage 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateTenantPackage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

createTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateTenantUserResponse
Esempio

deleteTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetTenantUserResponse
Esempio

getTenantUsers 
Parametri
| Nome | Tipo | Location | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantUsersResponse
Esempio

replaceTenantUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| updateComments | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

sendLoginLink 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateTenantUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| updateComments | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

createTenant 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateTenantResponse
Esempio

deleteTenant 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getTenant 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetTenantResponse
Esempio

getTenants 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| meta | string | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantsResponse
Esempio

updateTenant 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

changeTicketState 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: ChangeTicketStateResponse
Esempio

createTicket 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | Sì |
Risposta
Restituisce: CreateTicketResponse
Esempio

getTicket 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: GetTicketResponse
Esempio

getTickets 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Risposta
Restituisce: GetTicketsResponse
Esempio

getTranslations 
Parametri
| Nome | Tipo | Location | Obbligatorio | Descrizione |
|---|---|---|---|---|
| namespace | string | path | Sì | |
| component | string | path | Sì | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Risposta
Restituisce: GetTranslationsResponse
Esempio

uploadImage 
Carica e ridimensiona un'immagine
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| sizePreset | string | query | No | Preimpostazione dimensione: "Default" (1000x1000px) oppure "CrossPlatform" (crea dimensioni per dispositivi popolari) |
| urlId | string | query | No | ID della pagina da cui avviene il caricamento, per configurare |
Risposta
Restituisce: UploadImageResponse
Esempio

getUserBadgeProgressById 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: APIGetUserBadgeProgressResponse
Esempio

getUserBadgeProgressByUserId 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | path | Sì |
Risposta
Restituisce: APIGetUserBadgeProgressResponse
Esempio

getUserBadgeProgressList 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: APIGetUserBadgeProgressListResponse
Esempio

createUserBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: APICreateUserBadgeResponse
Esempio

deleteUserBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptySuccessResponse
Esempio

getUserBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIGetUserBadgeResponse
Esempio

getUserBadges 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: APIGetUserBadgesResponse
Esempio

updateUserBadge 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptySuccessResponse
Esempio

getUserNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetUserNotificationCountResponse
Esempio

getUserNotifications 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | No | Usato per determinare se la pagina corrente è sottoscritta. |
| 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 |
Risposta
Restituisce: GetMyNotificationsResponse
Esempio

resetUserNotificationCount 
Parameters
| Nome | Type | Location | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ResetUserNotificationsResponse
Esempio

resetUserNotifications 
Parametri
| Nome | Type | Location | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ResetUserNotificationsResponse
Esempio

updateUserNotificationCommentSubscriptionStatus 
Abilita o disabilita le notifiche per un commento specifico.
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Risposta
Restituisce: UpdateUserNotificationCommentSubscriptionStatusResponse
Esempio

updateUserNotificationPageSubscriptionStatus 
Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, vengono create notifiche per i nuovi commenti principali, e anche
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| url | string | query | Sì | |
| pageTitle | string | query | Sì | |
| subscribedOrUnsubscribed | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: UpdateUserNotificationPageSubscriptionStatusResponse
Esempio

updateUserNotificationStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| notificationId | string | path | Sì | |
| newStatus | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: UpdateUserNotificationStatusResponse
Esempio

getUserPresenceStatuses 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlIdWS | string | query | Sì | |
| userIds | string | query | Sì |
Risposta
Restituisce: GetUserPresenceStatusesResponse
Esempio

searchUsers 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Risposta
Restituisce: SearchUsersResult
Esempio

getUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetUserResponse
Esempio

createVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | query | Sì | |
| direction | string | query | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: VoteResponse
Esempio

deleteVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Risposta
Restituisce: VoteDeleteResponse
Esempio

getVotes 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetVotesResponse
Esempio

getVotesForUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: GetVotesForUserResponse
Esempio

createWebhook 
Iscrive un URL a un evento di commento (sottoscrizione REST hook). Iscrivere nuovamente lo stesso URL allo stesso evento e dominio restituisce l'iscrizione esistente. Le consegne sono firmate con HMAC, vedere la guida sui webhook; l'intestazione legacy token non viene mai inviata alle iscrizioni API.
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Response
Returns: CreateWebhookResponse
Example

deleteWebhook 
Annullamento iscrizioni (REST hook unsubscribe). Solo le sottoscrizioni create tramite questa API possono essere eliminate qui; i webhook gestiti dal dashboard vengono modificati nel dashboard.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getWebhooks 
Elenca i webhook configurati per il tenant, sia le righe gestite dalla dashboard sia le sottoscrizioni API.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| event | string | query | No | |
| domain | string | query | No | |
| source | string | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetWebhooksResponse
Esempio

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier
sample data). Every event delivers the same comment object, so event only has to be valid.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| event | string | query | No | |
| limit | number | query | No |
Risposta
Restituisce: GetWebhookSamplePayloadsResponse
Esempio

Hai bisogno di aiuto?
Se riscontri problemi o hai domande sul Java SDK, per favore:
Contribuire
I contributi sono benvenuti! Consulta il repository GitHub per le linee guida per contribuire.