
Језик 🇧🇦 Српски (БиХ)
Dokumentacija
Početak
API Referenca
Korištenje
Agregat
Dnevnici revizije
Autentikacija
Blokiraj iz komentara
Provjeri blokirane komentare
Komentari
Komentari za korisnika
Postavke domena
Šabloni e-pošte
Dnevnik događaja
Objave u feedu
Označi komentar
Gifovi
Hashtagovi
Moderacija
Moderatori
Broj notifikacija
Notifikacije
Reakcije na stranicu
Stranice
Potencijalni webhook događaji
Pitanje konfiguracije
Rezultati pitanja
Agregacija rezultata pitanja
SSO korisnici
Pretplate
Dnevna upotreba stanara
Paketi stanara
Korisnici stanara
Stanari
Zahtjevi
Prijevodi
Učitaj sliku
Napredak značke korisnika
Korisničke značke
Korisničke notifikacije
Status prisutnosti korisnika
Pretraga korisnika
Korisnici
Glasanja
FastComments Nim SDK
Ово је званични Nim SDK за FastComments.
Званични Nim SDK за FastComments API
Репозиториј
Instalacija 
Korištenje Nimble
nimble install fastcomments
Izgradnja iz izvornog koda
nimble build
Sadržaj biblioteke
Ova biblioteka sadrži generisani API klijent i SSO pomoćne alate koji olakšavaju rad sa API-jem.
Javni i zaštićeni API-ji
Za API klijenta postoje tri API modula, api_default, api_public, i api_moderation. api_default sadrži metode koje zahtijevaju vaš API ključ, a api_public sadrži API pozive koji se mogu praviti direktno iz browsera/mobilnog uređaja/itd. bez autentifikacije. api_moderation modul sadrži metode za moderatorsku kontrolnu ploču.
api_moderation metode obuhvataju listanje, brojanje, pretraživanje i eksportovanje komentara i njihovih logova; moderatorske akcije poput uklanjanja/obnavljanja komentara, prijavljivanja, postavljanja statusa pregleda/spama/odobrenja, podešavanja glasova, i ponovnog otvaranja/zatvaranja niti; zabrane (zabrana korisnika od komentarisanja, poništavanje zabrane, sažeci prije zabrane, status zabrane i preferencije, i broj zabranjenih korisnika); i značke & povjerenje (dodjela/uklanjanje značke, listanje ručnih znački, dobijanje/postavljanje faktora povjerenja korisnika, i dohvatanje unutrašnjeg profila korisnika). Svaka api_moderation metoda prihvata sso parametar tako da je poziv autentifikovan kao SSO moderator.
Brzi početak 
Korištenje autentifikovanih API-ja (DefaultAPI)
Važno: Autentifikovani endpointi zahtijevaju da vaš API ključ bude postavljen kao zaglavlje x-api-key.
import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
# Napravite autentifikovane API pozive
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Korištenje javnih API-ja (PublicAPI)
Javni endpointi ne zahtijevaju autentifikaciju:
import httpclient
import fastcomments
import fastcomments/apis/api_public
let client = newHttpClient()
# Napravite javne API pozive
let (response, httpResponse) = getCommentsPublic(
httpClient = client,
tenantId = "your-tenant-id",
urlId = "your-url-id",
page = 0,
direction = SortDirections.DESC,
sso = "",
skip = 0,
skipChildren = 0,
limit = 0,
limitChildren = 0,
countChildren = false,
fetchPageForCommentId = "",
includeConfig = false,
countAll = false,
includei10n = false,
locale = "",
modules = "",
isCrawler = false,
includeNotificationCount = false,
asTree = false,
maxTreeDepth = 0,
useFullTranslationIds = false,
parentId = "",
searchText = "",
hashTags = @[],
userId = "",
customConfigStr = "",
afterCommentId = "",
beforeCommentId = ""
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Korištenje moderacijskih API-ja (ModerationAPI)
Moderacijski endpointi pokreću moderatorski kontrolni panel i autentifikuju se koristeći SSO token za moderatora koji djeluje:
import httpclient
import fastcomments
import fastcomments/apis/api_moderation
let client = newHttpClient()
# Prikažite komentare u moderatorskom kontrolnom panelu
let (response, httpResponse) = getApiComments(
httpClient = client,
page = 0,
count = 30,
textSearch = "",
byIPFromComment = "",
filters = "",
searchFilters = "",
sorts = "",
demo = false,
sso = "your-sso-token"
)
if response.isSome:
let resp = response.get()
echo "Found ", resp.comments.len, " comments"
Uobičajeni problemi
- 401 greška autentifikacije: Provjerite da li ste postavili zaglavlje
x-api-keyna svom HttpClient prije slanja DefaultAPI zahtjeva:client.headers["x-api-key"] = "your-api-key" - Pogrešna klasa API-ja: Koristite
api_defaultza autentifikovane zahtjeve sa serverske strane,api_publicza klijentske/javne zahtjeve, iapi_moderationza zahtjeve moderatorskog kontrolnog panela.
Pozivanje API-ja 
Sve API metode u ovom SDK-u vraćaju torke (Option[ResponseType], Response). Prvi element sadrži parsirani odgovor ako je uspješan, a drugi element je sirovi HTTP odgovor.
Primjer: Dohvatanje komentara
import httpclient
import options
import fastcomments
import fastcomments/apis/api_default
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if httpResponse.code == Http200:
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Napomene 
Broadcast идентификатори
Видећете да треба да проследите broadcastId у неким API позивима. Када примите догађаје, добићете овај ID назад, па ћете знати да игноришете догађај ако планирате да оптимистички примените промјене на клијенту (што ћете вјероватно желјети урадити јер пружа најбоље искуство). Проследите овдје UUID. ID би требао бити довољно јединствен да се не појави два пута током сесије прегледача.
SSO (једнократно пријављивање)
За примјере SSO-а, погледајте доле.
Korištenje SSO 
Jednostavan SSO
import fastcomments/sso
let user = newSimpleSSOUserData(
userId = "user-123",
email = "user@example.com",
avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()
echo "SSO Token: ", token
Siguran SSO
import fastcomments/sso
let user = newSecureSSOUserData(
userId = "user-123",
email = "user@example.com",
username = "johndoe",
avatar = "https://example.com/avatar.jpg"
)
let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()
echo "Secure SSO Token: ", token
Dokументација за fastcomments 
Документација за API Endpoint-ове
Све URI адресе су релативне у односу на https://fastcomments.com
| Класа | Метода | HTTP захтјев | Опис |
|---|---|---|---|
| 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 | Агрегира документе груписањем (ако је groupBy задат) и примјеном више операција. Подржане су различите операције (нпр. sum, countDistinct, avg, итд.). |
| 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 | потребно tenantId afterId |
| 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} | потребно tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | потребно tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | потребно tenantId afterId |
| 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} | потребно tenantId urlId userIdWS |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | Претходни коментатори на страници који ТРЕНУТНО нису онлине. Сортирано по displayName. Користите након што исцрпите /users/online да прикажете секцију "Чланови". Курсор пагинација по commenterName: сервер пролази кроз парцијални {tenantId, urlId, commenterName} индекс од afterName надаље преко $gt, без $skip трошка. |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | Тренутно онлине гледаоци странице: особе чија је websocket сесија тренутно претплаћена на страницу. Враћа anonCount + totalCount (сви претплаћени у соби, укључујући анонимне кориснике које не рачунамо појединачно). |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | Листа страница за tenant-а. Користи FChat десктоп клијент да попуни своју листу соба. Захтијева да је enableFChat постављен на true у прилагођеној конфигурацији за сваку страницу. Странице које захтијевају SSO се филтрирају према групном приступу корисника који је поставио захтјев. |
| 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 | Информације о више корисника за tenant-а. Дати userIds, враћа приказне информације из User / SSOUser. Користи се у видгету за коментаре ради обогаћивања корисника који се појаве путем присуства. Нема контекст странице: приватност се примјењује униформно (приватни профили се скривају). |
| 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 |
Документација за Моделе
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBase_meta
- 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
- AddDomainConfigResponse_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchType
- BannedUserMatch_matchedOnValue
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBody_tags_inner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponse_results_inner
- 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
- [DeletePage
agregiraj 
Agregira dokumente grupišući ih (ako je groupBy naveden) i primjenjujući više operacija. Podržane su različite operacije (npr. sum, countDistinct, avg, itd.).
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| aggregationRequest | AggregationRequest | Ne | |
| parentTenantId | string | Ne | |
| includeStats | bool | Ne |
Odgovor
Vraća: Option[AggregateResponse]
Primjer

getAuditLogs 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| limit | float64 | Не | |
| skip | float64 | Не | |
| order | SORTDIR | Не | |
| after | float64 | Не | |
| before | float64 | Не |
Одговор
Враћа: Option[GetAuditLogsResponse]
Пример

logoutPublic 
Одговор
Враћа: Option[APIEmptyResponse]
Пример

blockFromCommentPublic 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[BlockSuccess]
Primjer

unBlockCommentPublic 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[UnblockSuccess]
Primjer

checkedCommentsForBlocked 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentIds | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[CheckBlockedCommentsResponse]
Primjer

blockUserFromComment 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| blockFromCommentParams | BlockFromCommentParams | Не | |
| userId | string | Не | |
| anonUserId | string | Не |
Одговор
Враћа: Option[BlockSuccess]
Пример

createCommentPublic 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| broadcastId | string | Ne | |
| commentData | CommentData | Ne | |
| sessionId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[SaveCommentsResponseWithPresence]
Primjer

deleteComment 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| contextUserId | string | Ne | |
| isLive | bool | Ne |
Odgovor
Vraća: Option[DeleteCommentResult]
Primjer

deleteCommentPublic 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| editKey | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[PublicAPIDeleteCommentResponse]
Primjer

deleteCommentVote 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| voteId | string | Ne | |
| urlId | string | Da | |
| broadcastId | string | Ne | |
| editKey | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[VoteDeleteResponse]
Primjer

flagComment 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| userId | string | Не | |
| anonUserId | string | Не |
Одговор
Враћа: Option[FlagCommentResponse]
Пример

getComment 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[APIGetCommentResponse]
Primjer

getComments 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| page | int | Не | |
| limit | int | Не | |
| skip | int | Не | |
| asTree | bool | Не | |
| skipChildren | int | Не | |
| limitChildren | int | Не | |
| maxTreeDepth | int | Не | |
| urlId | string | Да | |
| userId | string | Не | |
| anonUserId | string | Не | |
| contextUserId | string | Не | |
| hashTag | string | Не | |
| parentId | string | Не | |
| direction | SortDirections | Не | |
| fromDate | int64 | Не | |
| toDate | int64 | Не |
Одговор
Враћа: Option[APIGetCommentsResponse]
Пример

getCommentsPublic 
req tenantId urlId
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| page | int | Ne | |
| direction | SortDirections | Ne | |
| sso | string | Ne | |
| skip | int | Ne | |
| skipChildren | int | Ne | |
| limit | int | Ne | |
| limitChildren | int | Ne | |
| countChildren | bool | Ne | |
| fetchPageForCommentId | string | Ne | |
| includeConfig | bool | Ne | |
| countAll | bool | Ne | |
| includei10n | bool | Ne | |
| locale | string | Ne | |
| modules | string | Ne | |
| isCrawler | bool | Ne | |
| includeNotificationCount | bool | Ne | |
| asTree | bool | Ne | |
| maxTreeDepth | int | Ne | |
| useFullTranslationIds | bool | Ne | |
| parentId | string | Ne | |
| searchText | string | Ne | |
| hashTags | seq[string] | Ne | |
| userId | string | Ne | |
| customConfigStr | string | Ne | |
| afterCommentId | string | Ne | |
| beforeCommentId | string | Ne |
Odgovor
Vraća: Option[GetCommentsResponseWithPresencePublicComment]
Primjer

getCommentText 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| editKey | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[PublicAPIGetCommentTextResponse]
Primjer

getCommentVoteUserNames 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| dir | int | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[GetCommentVoteUserNamesSuccessResponse]
Primjer

lockComment 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

pinComment 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ChangeCommentPinStatusResponse]
Primjer

saveComment 
Параметри
| Name | Type | Потребно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| createCommentParams | CreateCommentParams | Не | |
| isLive | bool | Не | |
| doSpamCheck | bool | Не | |
| sendEmails | bool | Не | |
| populateNotifications | bool | Не |
Одговор
Враћа: Option[APISaveCommentResponse]
Пример

saveCommentsBulk 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createCommentParams | seq[CreateCommentParams] | No | |
| isLive | bool | No | |
| doSpamCheck | bool | No | |
| sendEmails | bool | No | |
| populateNotifications | bool): (Option[seq[SaveCommentsBulkResponse]] | No | |
| id | string | No | |
| fromName | string | No |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

setCommentText 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Ne | |
| editKey | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[PublicAPISetCommentTextResponse]
Primjer

unBlockUserFromComment 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Не | |
| userId | string | Не | |
| anonUserId | string | Не |
Одговор
Враћа: Option[UnblockSuccess]
Пример

unFlagComment 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| userId | string | Не | |
| anonUserId | string | Не |
Одговор
Враћа: Option[FlagCommentResponse]
Пример

unLockComment 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

unPinComment 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ChangeCommentPinStatusResponse]
Primjer

updateComment 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updatableCommentParams | UpdatableCommentParams | Не | |
| contextUserId | string | Не | |
| doSpamCheck | bool | Не | |
| isLive | bool | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

voteComment 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| urlId | string | Da | |
| broadcastId | string | Ne | |
| voteBodyParams | VoteBodyParams | Ne | |
| sessionId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[VoteResponse]
Primjer

getCommentsForUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| userId | string | Ne | |
| direction | SortDirections | Ne | |
| repliesToUserId | string | Ne | |
| page | float64 | Ne | |
| includei10n | bool | Ne | |
| locale | string | Ne | |
| isCrawler | bool | Ne |
Odgovor
Vraća: Option[GetCommentsForUserResponse]
Primjer

addDomainConfig 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| addDomainConfigParams | AddDomainConfigParams | Ne |
Odgovor
Vraća: Option[AddDomainConfigResponse]
Primjer

deleteDomainConfig 
Параметри
| Име | Тип | Потребно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| domain | string | Не |
Одговор
Враћа: Option[DeleteDomainConfigResponse]
Пример

getDomainConfig 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| domain | string | Не |
Одговор
Враћа: Option[GetDomainConfigResponse]
Пример

getDomainConfigs 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da |
Odgovor
Vraća: Option[GetDomainConfigsResponse]
Primjer

patchDomainConfig 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| domainToUpdate | string | Ne | |
| patchDomainConfigParams | PatchDomainConfigParams | Ne |
Odgovor
Vraća: Option[PatchDomainConfigResponse]
Primjer

putDomainConfig 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| domainToUpdate | string | Ne | |
| updateDomainConfigParams | UpdateDomainConfigParams | Ne |
Odgovor
Vraća: Option[PutDomainConfigResponse]
Primjer

createEmailTemplate 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| createEmailTemplateBody | CreateEmailTemplateBody | Не |
Одговор
Враћа: Option[CreateEmailTemplateResponse]
Пример

deleteEmailTemplate 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

deleteEmailTemplateRenderError 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| errorId | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

getEmailTemplate 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[GetEmailTemplateResponse]
Пример

getEmailTemplateDefinitions 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da |
Odgovor
Vraća: Option[GetEmailTemplateDefinitionsResponse]
Primjer

getEmailTemplateRenderErrors 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| skip | float64 | Не |
Одговор
Враћа: Option[GetEmailTemplateRenderErrorsResponse]
Пример

getEmailTemplates 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetEmailTemplatesResponse]
Primjer

renderEmailTemplate 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Ne | |
| locale | string | Ne |
Odgovor
Vraća: Option[RenderEmailTemplateResponse]
Primjer

updateEmailTemplate 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getEventLog 
req tenantId urlId userIdWS
Parametri
| Name | Type | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| userIdWS | string | Ne | |
| startTime | int64 | Ne | |
| endTime | int64 | Ne |
Odgovor
Vraća: Option[GetEventLogResponse]
Primjer

getGlobalEventLog 
req tenantId urlId userIdWS
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| userIdWS | string | Ne | |
| startTime | int64 | Ne | |
| endTime | int64 | Ne |
Odgovor
Vraća: Option[GetEventLogResponse]
Primjer

createFeedPost 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| createFeedPostParams | CreateFeedPostParams | Ne | |
| broadcastId | string | Ne | |
| isLive | bool | Ne | |
| doSpamCheck | bool | Ne | |
| skipDupCheck | bool | Ne |
Odgovor
Vraća: Option[CreateFeedPostsResponse]
Primjer

createFeedPostPublic 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| createFeedPostParams | CreateFeedPostParams | Не | |
| broadcastId | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[CreateFeedPostResponse]
Пример

deleteFeedPostPublic 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| postId | string | Ne | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[DeleteFeedPostPublicResponse]
Primjer

getFeedPosts 
req tenantId afterId
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| afterId | string | Ne | |
| limit | int | Ne | |
| tags | seq[string] | Ne |
Odgovor
Vraća: Option[GetFeedPostsResponse]
Primjer

getFeedPostsPublic 
req tenantId afterId
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| afterId | string | Ne | |
| limit | int | Ne | |
| tags | seq[string] | Ne | |
| sso | string | Ne | |
| isCrawler | bool | Ne | |
| includeUserInfo | bool | Ne |
Odgovor
Vraća: Option[PublicFeedPostsResponse]
Primjer

getFeedPostsStats 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| postIds | seq[string] | Не | |
| sso | string | Не |
Одговор
Враћа: Option[FeedPostsStatsResponse]
Пример

getUserReactsPublic 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| postIds | seq[string] | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[UserReactsResponse]
Primjer

reactFeedPostPublic 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| postId | string | Ne | |
| reactBodyParams | ReactBodyParams | Ne | |
| isUndo | bool | Ne | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ReactFeedPostResponse]
Primjer

updateFeedPost 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| feedPost | FeedPost | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

updateFeedPostPublic 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| postId | string | Не | |
| updateFeedPostParams | UpdateFeedPostParams | Не | |
| broadcastId | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[CreateFeedPostResponse]
Пример

flagCommentPublic 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| isFlagged | bool | Не | |
| sso | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getGifLarge 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| largeInternalURLSanitized | string | No |
Одговор
Враћа: Option[GifGetLargeResponse]
Пример

getGifsSearch 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| search | string | Ne | |
| locale | string | Ne | |
| rating | string | Ne | |
| page | float64 | Ne |
Odgovor
Vraća: Option[GetGifsSearchResponse]
Primjer

getGifsTrending 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| locale | string | Не | |
| rating | string | Не | |
| page | float64 | Не |
Одговор
Враћа: Option[GetGifsTrendingResponse]
Пример

addHashTag 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createHashTagBody | CreateHashTagBody | Ne |
Odgovor
Vraća: Option[CreateHashTagResponse]
Primjer

addHashTagsBulk 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Не |
Одговор
Враћа: Option[BulkCreateHashTagsResponse]
Пример

deleteHashTag 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tag | string | Не | |
| tenantId | string | Да | |
| deleteHashTagRequestBody | DeleteHashTagRequestBody | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getHashTags 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| page | float64 | Ne |
Odgovor
Vraća: Option[GetHashTagsResponse]
Primjer

patchHashTag 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tag | string | Не | |
| tenantId | string | Да | |
| updateHashTagBody | UpdateHashTagBody | Не |
Одговор
Враћа: Option[UpdateHashTagResponse]
Примјер

deleteModerationVote 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| voteId | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[VoteDeleteResponse]
Пример

getApiComments 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| page | float64 | Ne | |
| count | float64 | Ne | |
| textSearch | string | Ne | |
| byIPFromComment | string | Ne | |
| filters | string | Ne | |
| searchFilters | string | Ne | |
| sorts | string | Ne | |
| demo | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationAPIGetCommentsResponse]
Primjer

getApiExportStatus 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| batchJobId | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[ModerationExportStatusResponse]
Пример

getApiIds 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| textSearch | string | Ne | |
| byIPFromComment | string | Ne | |
| filters | string | Ne | |
| searchFilters | string | Ne | |
| afterId | string | Ne | |
| demo | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationAPIGetCommentIdsResponse]
Primjer

getBanUsersFromComment 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[GetBannedUsersFromCommentResponse]
Пример

getCommentBanStatus 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[GetCommentBanStatusResponse]
Пример

getCommentChildren 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[ModerationAPIChildCommentsResponse]
Пример

getCount 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| textSearch | string | Ne | |
| byIPFromComment | string | Ne | |
| filter | string | Ne | |
| searchFilters | string | Ne | |
| demo | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationAPICountCommentsResponse]
Primjer

getCounts 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| sso | string | Не |
Одговор
Враћа: Option[GetBannedUsersCountResponse]
Пример

getLogs 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[ModerationAPIGetLogsResponse]
Пример

getManualBadges 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| sso | string | Не |
Одговор
Враћа: Option[GetTenantManualBadgesResponse]
Пример

getManualBadgesForUser 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| badgesUserId | string | Не | |
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[GetUserManualBadgesResponse]
Пример

getModerationComment 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| commentId | string | Da | |
| includeEmail | bool | Ne | |
| includeIP | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationAPICommentResponse]
Primjer

getModerationCommentText 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| sso | string | Ne |
Odgovor
Vraća: Option[GetCommentTextResponse]
Primjer

getPreBanSummary 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| includeByUserIdAndEmail | bool | Ne | |
| includeByIP | bool | Ne | |
| includeByEmailDomain | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[PreBanSummary]
Primjer

getSearchCommentsSummary 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| value | string | Ne | |
| filters | string | Ne | |
| searchFilters | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationCommentSearchResponse]
Primjer

getSearchPages 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| value | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationPageSearchResponse]
Primjer

getSearchSites 
Parametri
| Naziv | Type | Obavezno | Opis |
|---|---|---|---|
| value | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationSiteSearchResponse]
Primjer

getSearchSuggest 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| textSearch | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[ModerationSuggestResponse]
Пример

getSearchUsers 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| value | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[ModerationUserSearchResponse]
Пример

getTrustFactor 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| userId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[GetUserTrustFactorResponse]
Primjer

getUserBanPreference 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| sso | string | Ne |
Odgovor
Vraća: Option[APIModerateGetUserBanPreferencesResponse]
Primjer

getUserInternalProfile 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[GetUserInternalProfileResponse]
Пример

postAdjustCommentVotes 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| adjustCommentVotesParams | AdjustCommentVotesParams | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[AdjustVotesResponse]
Primjer

postApiExport 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| textSearch | string | Не | |
| byIPFromComment | string | Не | |
| filters | string | Не | |
| searchFilters | string | Не | |
| sorts | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[ModerationExportResponse]
Пример

postBanUserFromComment 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| banEmail | bool | Не | |
| banEmailDomain | bool | Не | |
| banIP | bool | Не | |
| deleteAllUsersComments | bool | Не | |
| bannedUntil | string | Не | |
| isShadowBan | bool | Не | |
| updateId | string | Не | |
| banReason | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[BanUserFromCommentResult]
Пример

postBanUserUndo 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| banUserUndoParams | BanUserUndoParams | Не | |
| sso | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

postBulkPreBanSummary 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| bulkPreBanParams | BulkPreBanParams | Ne | |
| includeByUserIdAndEmail | bool | Ne | |
| includeByIP | bool | Ne | |
| includeByEmailDomain | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[BulkPreBanSummary]
Primjer

postCommentsByIds 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentsByIdsParams | CommentsByIdsParams | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[ModerationAPIChildCommentsResponse]
Primjer

postFlagComment 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

postRemoveComment 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[PostRemoveCommentResponse]
Пример

postRestoreDeletedComment 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| sso | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

postSetCommentApprovalStatus 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| approved | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[SetCommentApprovedResponse]
Primjer

postSetCommentReviewStatus 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| reviewed | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

postSetCommentSpamStatus 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| spam | bool | Ne | |
| permNotSpam | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

postSetCommentText 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| setCommentTextParams | SetCommentTextParams | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[SetCommentTextResponse]
Primjer

postUnFlagComment 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| commentId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

postVote 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| commentId | string | Da | |
| direction | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[VoteResponse]
Primjer

putAwardBadge 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| badgeId | string | Ne | |
| userId | string | Ne | |
| commentId | string | Da | |
| broadcastId | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[AwardUserBadgeResponse]
Primjer

putCloseThread 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| urlId | string | Да | |
| sso | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

putRemoveBadge 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| badgeId | string | Не | |
| userId | string | Не | |
| commentId | string | Да | |
| broadcastId | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[RemoveUserBadgeResponse]
Пример

putReopenThread 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| urlId | string | Da | |
| sso | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

setTrustFactor 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| userId | string | Ne | |
| trustFactor | string | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[SetUserTrustFactorResponse]
Primjer

createModerator 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| createModeratorBody | CreateModeratorBody | Не |
Одговор
Враћа: Option[CreateModeratorResponse]
Пример

deleteModerator 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| sendEmail | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

getModerator 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[GetModeratorResponse]
Пример

getModerators 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| skip | float64 | Не |
Одговор
Враћа: Option[GetModeratorsResponse]
Примјер

updateModerator 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| updateModeratorBody | UpdateModeratorBody | No |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

deleteNotificationCount 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getCachedNotificationCount 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[GetCachedNotificationCountResponse]
Primjer

getNotificationCount 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| urlId | string | Да | |
| fromCommentId | string | Не | |
| viewed | bool | Не |
Одговор
Враћа: Option[GetNotificationCountResponse]
Пример

getNotifications 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| userId | string | Ne | |
| urlId | string | Da | |
| fromCommentId | string | Ne | |
| viewed | bool | Ne | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetNotificationsResponse]
Primjer

updateNotification 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updateNotificationBody | UpdateNotificationBody | Не | |
| userId | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

createV1PageReact 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| title | string | Ne |
Odgovor
Vraća: Option[CreateV1PageReact]
Primjer

createV2PageReact 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| id | string | Не | |
| title | string | Не |
Одговор
Враћа: Option[CreateV1PageReact]
Пример

deleteV1PageReact 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да |
Одговор
Враћа: Option[CreateV1PageReact]
Пример

deleteV2PageReact 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[CreateV1PageReact]
Primjer

getV1PageLikes 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да |
Одговор
Враћа: Option[GetV1PageLikes]
Пример

getV2PageReacts 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da |
Odgovor
Vraća: Option[GetV2PageReacts]
Primjer

getV2PageReactUsers 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[GetV2PageReactUsersResponse]
Primjer

addPage 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| createAPIPageData | CreateAPIPageData | Не |
Одговор
Враћа: Option[AddPageAPIResponse]
Пример

deletePage 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[DeletePageAPIResponse]
Пример

getOfflineUsers 
Prethodni komentatori na stranici koji trenutno NISU online. Sortirano po displayName. Koristite ovo nakon što iscrpite /users/online za prikaz odjeljka "Članovi". Paginacija pomoću kursora po commenterName: server prelazi djelimični {tenantId, urlId, commenterName} indeks od afterName naprijed koristeći $gt, bez troška $skip.
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| afterName | string | Ne | |
| afterUserId | string | Ne |
Odgovor
Vraća: Option[PageUsersOfflineResponse]
Primjer

getOnlineUsers 
Trenutno-online gledatelji stranice: osobe čija je websocket sesija trenutno pretplaćena na stranicu. Vraća anonCount + totalCount (pretplatnici u sobi, uključujući anonimne gledaoce koje ne nabrajamo).
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| afterName | string | Ne | |
| afterUserId | string | Ne |
Odgovor
Vraća: Option[PageUsersOnlineResponse]
Primjer

getPageByURLId 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да |
Одговор
Враћа: Option[GetPageByURLIdAPIResponse]
Пример

getPages 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da |
Odgovor
Vraća: Option[GetPagesAPIResponse]
Primjer

getPagesPublic 
Листати странице за tenant. Користи се од стране FChat десктоп клијента да попуни своју листу соба.
Захтијева да enableFChat буде true на решеном прилагођеном конфигу за сваку страницу.
Странице које захтијевају SSO се филтрирају према приступу групе корисника који прави захтев.
Параметри
| Име | Тип | Потребно | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| cursor | string | No | |
| limit | int | No | |
| q | string | No | |
| sortBy | PagesSortBy | No | |
| hasComments | bool | No |
Одговор
Враћа: Option[GetPublicPagesResponse]
Пример

getUsersInfo 
Grupne informacije o korisnicima za tenant. Za zadane userIds, vraća informacije za prikaz iz User / SSOUser. Koristi ga widget za komentare da obogati korisnike koji su se upravo pojavili putem događaja prisutnosti. Bez konteksta stranice: privatnost se dosljedno provodi (privatni profili su zamaskirani).
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| ids | string | Ne |
Odgovor
Vraća: Option[PageUsersInfoResponse]
Primjer

patchPage 
Parametri
| Name | Type | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| updateAPIPageData | UpdateAPIPageData | Ne |
Odgovor
Vraća: Option[PatchPageAPIResponse]
Primjer

deletePendingWebhookEvent 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getPendingWebhookEventCount 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| externalId | string | Ne | |
| eventType | string | Ne | |
| domain | string | Ne | |
| attemptCountGT | float64 | Ne |
Odgovor
Vraća: Option[GetPendingWebhookEventCountResponse]
Primjer

getPendingWebhookEvents 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| externalId | string | Ne | |
| eventType | string | Ne | |
| domain | string | Ne | |
| attemptCountGT | float64 | Ne | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetPendingWebhookEventsResponse]
Primjer

createQuestionConfig 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createQuestionConfigBody | CreateQuestionConfigBody | Ne |
Odgovor
Vraća: Option[CreateQuestionConfigResponse]
Primjer

deleteQuestionConfig 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getQuestionConfig 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[GetQuestionConfigResponse]
Primjer

getQuestionConfigs 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| skip | float64 | Не |
Одговор
Враћа: Option[GetQuestionConfigsResponse]
Пример

updateQuestionConfig 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

createQuestionResult 
Параметри
| Name | Type | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| createQuestionResultBody | CreateQuestionResultBody | Не |
Одговор
Враћа: Option[CreateQuestionResultResponse]
Примјер

deleteQuestionResult 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

getQuestionResult 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[GetQuestionResultResponse]
Primjer

getQuestionResults 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| userId | string | Ne | |
| startDate | string | Ne | |
| questionId | string | Ne | |
| questionIds | string | Ne | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetQuestionResultsResponse]
Primjer

updateQuestionResult 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| updateQuestionResultBody | UpdateQuestionResultBody | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

aggregateQuestionResults 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| questionId | string | Не | |
| questionIds | seq[string] | Не | |
| urlId | string | Да | |
| timeBucket | AggregateTimeBucket | Не | |
| startDate | string | Не | |
| forceRecalculate | bool | Не |
Одговор
Враћа: Option[AggregateQuestionResultsResponse]
Пример

bulkAggregateQuestionResults 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Не | |
| forceRecalculate | bool | Не |
Одговор
Враћа: Option[BulkAggregateQuestionResultsResponse]
Примјер

combineCommentsWithQuestionResults 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| questionId | string | Ne | |
| questionIds | seq[string] | Ne | |
| urlId | string | Da | |
| startDate | string | Ne | |
| forceRecalculate | bool | Ne | |
| minValue | float64 | Ne | |
| maxValue | float64 | Ne | |
| limit | float64 | Ne |
Odgovor
Vraća: Option[CombineQuestionResultsWithCommentsResponse]
Primjer

addSSOUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createAPISSOUserData | CreateAPISSOUserData | Ne |
Odgovor
Vraća: Option[AddSSOUserAPIResponse]
Primjer

deleteSSOUser 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| deleteComments | bool | Не | |
| commentDeleteMode | string | Не |
Одговор
Враћа: Option[DeleteSSOUserAPIResponse]
Пример

getSSOUserByEmail 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| string | Не |
Одговор
Враћа: Option[GetSSOUserByEmailAPIResponse]
Пример

getSSOUserById 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[GetSSOUserByIdAPIResponse]
Пример

getSSOUsers 
Параметри
| Назив | Тип | Потребно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| skip | int | Не |
Одговор
Враћа: Option[GetSSOUsersResponse]
Пример

patchSSOUser 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updateAPISSOUserData | UpdateAPISSOUserData | Не | |
| updateComments | bool | Не |
Одговор
Враћа: Option[PatchSSOUserAPIResponse]
Пример

putSSOUser 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updateAPISSOUserData | UpdateAPISSOUserData | Не | |
| updateComments | bool | Не |
Одговор
Враћа: Option[PutSSOUserAPIResponse]
Пример

createSubscription 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Ne |
Odgovor
Vraća: Option[CreateSubscriptionAPIResponse]
Primer

deleteSubscription 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| userId | string | Ne |
Odgovor
Vraća: Option[DeleteSubscriptionAPIResponse]
Primjer

getSubscriptions 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не |
Одговор
Враћа: Option[GetSubscriptionsAPIResponse]
Примјер

updateSubscription 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updateAPIUserSubscriptionData | UpdateAPIUserSubscriptionData | Не | |
| userId | string | Не |
Одговор
Враћа: Option[UpdateSubscriptionAPIResponse]
Пример

getTenantDailyUsages 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| yearNumber | float64 | Ne | |
| monthNumber | float64 | Ne | |
| dayNumber | float64 | Ne | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetTenantDailyUsagesResponse]
Primjer

createTenantPackage 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| createTenantPackageBody | CreateTenantPackageBody | Не |
Одговор
Враћа: Option[CreateTenantPackageResponse]
Пример

deleteTenantPackage 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primer

getTenantPackage 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[GetTenantPackageResponse]
Primjer

getTenantPackages 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetTenantPackagesResponse]
Primjer

replaceTenantPackage 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

updateTenantPackage 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| updateTenantPackageBody | UpdateTenantPackageBody | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

createTenantUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createTenantUserBody | CreateTenantUserBody | Ne |
Odgovor
Vraća: Option[CreateTenantUserResponse]
Primjer

deleteTenantUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| deleteComments | string | Ne | |
| commentDeleteMode | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

getTenantUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Vraća: Option[GetTenantUserResponse]
Primer

getTenantUsers 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| skip | float64 | Ne |
Odgovor
Vraća: Option[GetTenantUsersResponse]
Primjer

replaceTenantUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| replaceTenantUserBody | ReplaceTenantUserBody | Ne | |
| updateComments | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

sendLoginLink 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| redirectURL | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

updateTenantUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| updateTenantUserBody | UpdateTenantUserBody | Ne | |
| updateComments | string | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

createTenant 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createTenantBody | CreateTenantBody | Ne |
Odgovor
Vraća: Option[CreateTenantResponse]
Primjer

deleteTenant 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| sure | string | Не |
Одговор
Враћа: Option[APIEmptyResponse]
Пример

getTenant 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[GetTenantResponse]
Примјер

getTenants 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| meta | string | Не | |
| skip | float64 | Не |
Одговор
Враћа: Option[GetTenantsResponse]
Примјер

updateTenant 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| updateTenantBody | UpdateTenantBody | Ne |
Odgovor
Vraća: Option[APIEmptyResponse]
Primjer

changeTicketState 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| userId | string | Ne | |
| id | string | Ne | |
| changeTicketStateBody | ChangeTicketStateBody | Ne |
Odgovor
Vraća: Option[ChangeTicketStateResponse]
Primjer

createTicket 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| userId | string | Ne | |
| createTicketBody | CreateTicketBody | Ne |
Odgovor
Vraća: Option[CreateTicketResponse]
Primjer

getTicket 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не | |
| userId | string | Не |
Одговор
Враћа: Option[GetTicketResponse]
Пример

getTickets 
Parametri
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Da | |
| userId | string | Ne | |
| state | float64 | Ne | |
| skip | float64 | Ne | |
| limit | float64 | Ne |
Odgovor
Vraća: Option[GetTicketsResponse]
Primjer

getTranslations 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| namespace | string | Не | |
| component | string | Не | |
| locale | string | Не | |
| useFullTranslationIds | bool | Не |
Одговор
Враћа: Option[GetTranslationsResponse]
Пример

uploadImage 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| file | string | Ne | |
| sizePreset | SizePreset | Ne | |
| urlId | string | Da |
Odgovor
Vraća: Option[UploadImageResponse]
Primjer

getUserBadgeProgressById 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[APIGetUserBadgeProgressResponse]
Пример

getUserBadgeProgressByUserId 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| userId | string | Ne |
Odgovor
Vraća: Option[APIGetUserBadgeProgressResponse]
Primjer

getUserBadgeProgressList 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| limit | float64 | Не | |
| skip | float64 | Не |
Одговор
Враћа: Option[APIGetUserBadgeProgressListResponse]
Пример

createUserBadge 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| createUserBadgeParams | CreateUserBadgeParams | Ne |
Odgovor
Vraća: Option[APICreateUserBadgeResponse]
Primjer

deleteUserBadge 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[APIEmptySuccessResponse]
Primjer

getUserBadge 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Не |
Одговор
Враћа: Option[APIGetUserBadgeResponse]
Пример

getUserBadges 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| badgeId | string | Не | |
| displayedOnComments | bool | Не | |
| limit | float64 | Не | |
| skip | float64 | Не |
Одговор
Враћа: Option[APIGetUserBadgesResponse]
Пример

updateUserBadge 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| updateUserBadgeParams | UpdateUserBadgeParams | Ne |
Odgovor
Vraća: Option[APIEmptySuccessResponse]
Primjer

getUserNotificationCount 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| sso | string | Ne |
Odgovor
Vraća: Option[GetUserNotificationCountResponse]
Primjer

getUserNotifications 
Parametri
| Name | Type | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da | |
| pageSize | int | Ne | |
| afterId | string | Ne | |
| includeContext | bool | Ne | |
| afterCreatedAt | int64 | Ne | |
| unreadOnly | bool | Ne | |
| dmOnly | bool | Ne | |
| noDm | bool | Ne | |
| includeTranslations | bool | Ne | |
| includeTenantNotifications | bool | Ne | |
| sso | string | Ne |
Odgovor
Vraća: Option[GetMyNotificationsResponse]
Primjer

resetUserNotificationCount 
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| sso | string | Ne |
Odgovor
Vraća: Option[ResetUserNotificationsResponse]
Primjer

resetUserNotifications 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| afterId | string | No | |
| afterCreatedAt | int64 | No | |
| unreadOnly | bool | No | |
| dmOnly | bool | No | |
| noDm | bool | No | |
| sso | string | No |
Odgovor
Vraća: Option[ResetUserNotificationsResponse]
Primjer

updateUserNotificationCommentSubscriptionStatus 
Omogući ili onemogući obavještenja za određeni komentar.
Parametri
| Ime | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| notificationId | string | Ne | |
| optedInOrOut | string | Ne | |
| commentId | string | Da | |
| sso | string | Ne |
Odgovor
Vraća: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]
Primjer

updateUserNotificationPageSubscriptionStatus 
Омогућите или онемогућите обавештења за страницу. Када су корисници претплаћени на страницу, креирају се обавештења за нове root коментаре, и такође
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| url | string | Не | |
| pageTitle | string | Не | |
| subscribedOrUnsubscribed | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[UpdateUserNotificationPageSubscriptionStatusResponse]
Пример

updateUserNotificationStatus 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| notificationId | string | Не | |
| newStatus | string | Не | |
| sso | string | Не |
Одговор
Враћа: Option[UpdateUserNotificationStatusResponse]
Пример

getUserPresenceStatuses 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlIdWS | string | Не | |
| userIds | string | Не |
Одговор
Враћа: Option[GetUserPresenceStatusesResponse]
Пример

searchUsers 
Параметри
| Назив | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| usernameStartsWith | string | Не | |
| mentionGroupIds | seq[string] | Не | |
| sso | string | Не | |
| searchSection | string | Не |
Одговор
Враћа: Option[SearchUsersResult]
Пример

getUser 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne |
Odgovor
Vraća: Option[GetUserResponse]
Primjer

createVote 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| commentId | string | Da | |
| direction | string | Ne | |
| userId | string | Ne | |
| anonUserId | string | Ne |
Odgovor
Vraća: Option[VoteResponse]
Primjer

deleteVote 
Parametri
| Naziv | Tip | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| id | string | Ne | |
| editKey | string | Ne |
Odgovor
Vraća: Option[VoteDeleteResponse]
Primjer

getVotes 
Parametri
| Name | Type | Obavezno | Opis |
|---|---|---|---|
| tenantId | string | Da | |
| urlId | string | Da |
Odgovor
Vraća: Option[GetVotesResponse]
Primjer

getVotesForUser 
Параметри
| Име | Тип | Обавезно | Опис |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Одговор
Враћа: Option[GetVotesForUserResponse]
Пример

Trebate pomoć?
Ako naiđete na bilo kakve probleme ili imate pitanja u vezi Nim SDK-a, molimo:
Doprinosi
Doprinosi su dobrodošli! Molimo posjetite GitHub repozitorij za upute za doprinos.