
Lingua 🇮🇹 Italiano
Primi passi
Riferimento API
Documentazione
Autenticazione
Aggregazione
Log di audit
Blocco commento
Verifica commenti bloccati
Commenti
Commenti per utente
Configurazioni dominio
Modelli email
Registro eventi
Post del feed
Segnala commento
GIF
Hashtag
Moderazione
Moderatori
Conteggio notifiche
Notifiche
Reazioni pagina
Pagine
Eventi webhook pendenti
Configurazioni domande
Risultati domande
Aggregazione risultati domande
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
SDK PHP di FastComments
Questo è l'SDK PHP ufficiale per FastComments.
SDK PHP ufficiale per l'API di FastComments
Repository
Installazione e utilizzo 
Requisiti
PHP 7.4 e versioni successive. Dovrebbe funzionare anche con PHP 8.0.
Composer
Per installare i binding tramite Composer, aggiungi quanto segue a composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
Poi esegui composer install
Installazione manuale
Scarica i file e includi autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Primi passi 
Segui la procedura di installazione e poi esegui quanto segue:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configura l'autenticazione mediante chiave API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Decommenta la riga sottostante per impostare un prefisso (es. Bearer) per la chiave API, se necessario
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
// Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
new GuzzleHttp\Client(),
$config
);
$tenant_id = 'tenant_id_example'; // stringa
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
try {
$result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}
Client API 
L'SDK espone tre classi client API:
DefaultApi- metodi autenticati con chiave API per uso lato server. Configura una chiave API come mostrato in Getting Started.PublicApi- metodi pubblici che non richiedono una chiave API, sicuri da chiamare da browser e app mobili.ModerationApi- una suite completa di API di moderazione in tempo reale e veloce. Ogni metodoModerationApiaccetta un parametro$ssoe può autenticarsi tramite SSO o un cookie di sessione FastComments.com.
Utilizzo di PublicApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// I metodi pubblici non richiedono una chiave API.
$apiInstance = new FastComments\Client\Api\PublicApi(
new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
$result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}
Utilizzo di ModerationApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - Payload SSO che autentica il moderatore
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}
Metodi API 
Tutti gli URI sono relativi a https://fastcomments.com
| Classe | Metodo | Richiesta HTTP | Descrizione |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Modelli 
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponseAnyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchMatchedOnValue
- BannedUserMatchType
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponseResultsInner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponseAnyOf
- GetDomainConfigsResponseAnyOf1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponseProfile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponseImagesInnerInner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Autorizzazione 
Schemi di autenticazione definiti per l'API:
api_key
- Tipo: Chiave API
- Nome del parametro della chiave API: x-api-key
- Posizione: HTTP header
aggregate 
Aggrega i documenti raggruppandoli (se è fornito groupBy) e applicando più operazioni.
Sono supportate diverse operazioni (ad es. sum, countDistinct, avg, ecc.).
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Risposta
Restituisce: AggregateResponse
Esempio

getAuditLogs 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Risposta
Restituisce: GetAuditLogsResponse
Esempio

logoutPublic 
Risposta
Restituisce: APIEmptyResponse
Esempio

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

checkedCommentsForBlocked 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentIds | string | query | Sì | Un elenco separato da virgole di ID dei commenti. |
| 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 
Parametri
| 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 |
Risposta
Restituisce: SaveCommentsResponseWithPresence
Esempio

deleteComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Risposta
Restituisce: DeleteCommentResult
Esempio

deleteCommentPublic 
Parametri
| Nome | 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 | Tipo | 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| 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 |
Response
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 |
Risposta
Restituisce: GetCommentsResponseWithPresencePublicComment
Esempio

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

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

lockComment 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Response
Restituisce: APIEmptyResponse
Example

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

saveComment 
Parametri
| Nome | 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
Returns: APISaveCommentResponse
Esempio

saveCommentsBulk 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Risposta
Restituisce: SaveCommentsBulkResponse
Esempio

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

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

unFlagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Risposta
Restituisce: ChangeCommentPinStatusResponse
Esempio

updateComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddDomainConfigResponse
Esempio

deleteDomainConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Risposta
Restituisce: DeleteDomainConfigResponse
Esempio

getDomainConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domain | string | path | Sì |
Risposta
Restituisce: GetDomainConfigResponse
Esempio

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

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

putDomainConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Risposta
Restituisce: PutDomainConfigResponse
Esempio

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

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

deleteEmailTemplateRenderError 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | 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 | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Risposta
Returns: GetEmailTemplateRenderErrorsResponse
Esempio

getEmailTemplates 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Risposta
Returns: GetEmailTemplatesResponse
Esempio

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

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

getEventLog 
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Posizione | Obbligatorio | 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

getGlobalEventLog 
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Posizione | Obbligatorio | 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 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Response
Restituisce: CreateFeedPostsResponse
Esempio

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

deleteFeedPostPublic 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| postId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: DeleteFeedPostPublicResponse
Esempio

getFeedPosts 
req
tenantId
afterId
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | Yes | |
| 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 | Sì | |
| postId | string | path | Sì | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ReactFeedPostResponse
Esempio

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

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

flagCommentPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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 | Yes | |
| largeInternalURLSanitized | string | query | Yes |
Risposta
Restituisce: GifGetLargeResponse
Esempio

getGifsSearch 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Risposta
Restituisce: GetGifsSearchResponse
Esempio

getGifsTrending 
Parametri
| Nome | Tipo | Posizione | 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 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: BulkCreateHashTagsResponse
Esempio

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 | Sì | |
| tag | string | path | Sì |
Risposta
Restituisce: UpdateHashTagResponse
Esempio

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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Response
Restituisce: GetBannedUsersFromCommentResponse
Example

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 | Obbligatorio | 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 | Yes | |
| 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 | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetBannedUsersCountResponse
Esempio

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

getManualBadges 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Response
Restituisce: GetTenantManualBadgesResponse
Example

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

getModerationComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Risposta
Returns: 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 
Parameters
| 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 |
Response
Restituisce: ModerationCommentSearchResponse
Esempio

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

getSearchSites 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| value | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationSiteSearchResponse
Esempio

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

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| 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 | Yes | |
| sso | string | query | No |
Risposta
Restituisce: APIModerateGetUserBanPreferencesResponse
Esempio

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

postAdjustCommentVotes 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Restituisce: AdjustVotesResponse
Example

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
| Name | Type | Location | Required | Descrizione |
|---|---|---|---|---|
| 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 |
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 | Yes | |
| 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 | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postRemoveComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| 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 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
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 | Yes | |
| commentId | string | path | Yes | |
| 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 | Sì | |
| commentId | string | path | Sì | |
| 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 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| sso | string | query | No |
Response
Restituisce: APIEmptyResponse
Example

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
Restituisce: 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| sendEmail | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

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

getNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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 | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

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

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

deleteV1PageReact 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Response
Restituisce: CreateV1PageReact
Example

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

getV1PageLikes 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetV1PageLikes
Esempio

getV2PageReacts 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetV2PageReacts
Esempio

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

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

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

getOfflineUsers 
Past commentatori sulla pagina che NON sono attualmente online. Ordinati per displayName.
Usa questo dopo aver esaurito /users/online per rendere una sezione “Members”.
Paginazione con cursore su commenterName: il server scorre il sotto‑insieme {tenantId, urlId, commenterName} a partire da afterName in avanti tramite $gt, senza alcun costo $skip.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identificatore della URL della pagina (ripulito sul server). |
| afterName | string | query | No | Cursore: passa nextAfterName dalla risposta precedente. |
| afterUserId | string | query | No | Cursore per risolvere i pareggi: passa nextAfterUserId dalla risposta precedente. Necessario quando afterName è impostato affinché i pareggi di nome non omettano voci. |
Risposta
Restituisce: PageUsersOfflineResponse
Esempio

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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | Identificatore URL della pagina (pulito lato server). |
| afterName | string | query | No | Cursore: passa nextAfterName dalla risposta precedente. |
| afterUserId | string | query | No | Cursore per risolvere il pareggio: passa nextAfterUserId dalla risposta precedente. Obbligatorio quando afterName è impostato così i pareggi di nome non eliminano voci. |
Response
Restituisce: PageUsersOnlineResponse
Esempio

getPageByURLId 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Risposta
Restituisce: GetPageByURLIdAPIResponse
Esempio

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

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Richiede che enableFChat sia true nella configurazione personalizzata risolta per ogni pagina.
Le pagine che richiedono SSO sono filtrate in base all'accesso del gruppo dell'utente richiedente.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Cursor di paginazione opaco restituito come nextCursor da una richiesta precedente. Legato allo stesso sortBy. |
| limit | integer | query | No | 1..200, default 50 |
| q | string | query | No | Filtro opzionale del prefisso del titolo, non sensibile al maiuscolo/minuscolo. |
| sortBy | string | query | No | Ordine di ordinamento. updatedAt (predefinito, più recenti per primi), commentCount (più commenti per primi) o title (alfabetico). |
| hasComments | boolean | query | No | Se true, restituisce solo le pagine con almeno un commento. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | UserIds delimitati da virgola. |
Response
Returns: PageUsersInfoResponse
Example

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

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

getPendingWebhookEventCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| 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 | Yes | |
| 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

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

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

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

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

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

createQuestionResult 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes |
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: GetQuestionResultResponse
Esempio

getQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: APIEmptyResponse
Esempio

aggregateQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| 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 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| forceRecalculate | boolean | query | No |
Risposta
Restituisce: BulkAggregateQuestionResultsResponse
Esempio

combineCommentsWithQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| 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 | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| 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 | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| updateComments | boolean | query | No |
Risposta
Returns: PutSSOUserAPIResponse
Esempio

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

deleteSubscription 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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 | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Risposta
Restituisce: UpdateSubscriptionAPIResponse
Esempio

getTenantDailyUsages 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantDailyUsagesResponse
Esempio

createTenantPackage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes |
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 | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetTenantPackageResponse
Esempio

getTenantPackages 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Response
Restituisce: GetTenantPackagesResponse
Esempio

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

updateTenantPackage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
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
Returns: 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 | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantUsersResponse
Esempio

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

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

updateTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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 | Sì | |
| id | string | path | Sì | |
| sure | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

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

getTenants 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| meta | string | query | No | |
| skip | number | query | No |
Response
Restituisce: GetTenantsResponse
Example

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

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

createTicket 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | Sì |
Risposta
Restituisce: CreateTicketResponse
Esempio

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

getTickets 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Risposta
Restituisce: GetTranslationsResponse
Esempio

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

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

getUserBadgeProgressByUserId 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | path | Sì |
Risposta
Restituisce: APIGetUserBadgeProgressResponse
Esempio

getUserBadgeProgressList 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: APIEmptySuccessResponse
Esempio

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

getUserBadges 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Response
Returns: APIGetUserBadgesResponse
Example

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

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

resetUserNotifications 
Parametri
| Nome | Tipo | Posizione | 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 
Enable o disabilita le notifiche per un commento specifico.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| notificationId | string | path | Sì | |
| optedInOrOut | string | path | Sì | |
| commentId | string | query | Sì | |
| sso | string | query | No |
Response
Restituisce: UpdateUserNotificationCommentSubscriptionStatusResponse
Esempio

updateUserNotificationPageSubscriptionStatus 
Enable o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, le notifiche vengono create per i nuovi commenti radice, e anche
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Restituisce: UpdateUserNotificationPageSubscriptionStatusResponse
Example

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 | Obbligatorio | 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: GetUserResponse
Esempio

createVote 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| 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
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetVotesResponse
Esempio

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

Hai bisogno di aiuto?
Se riscontri problemi o hai domande riguardo l'SDK PHP, per favore:
Contribuire
I contributi sono benvenuti! Visita il repository GitHub per le linee guida per i contributi.