
Језик 🇷🇸 Српски
Почетак
Документација
Агрегација
Дневници ревизије
Аутентификација
Блокирање из коментара
Провера блокираних коментара
Коментари
Коментари за корисника
Конфигурације домена
Шаблони е-поште
Дневник догађаја
Објаве фида
Означи коментар
Гифови
Хештегови
Модерација
Модератори
Број обавештења
Обавештења
Реакције странице
Странице
Нерешени догађаји вебхука
Конфигурације питања
Резултати питања
Агрегација резултата питања
SSO корисници
Претплате
Дневна употреба закупца
Пакети закупца
Корисници закупца
Тенанти
Тикети
Преводи
Отпремање слике
Напредак значке корисника
Значке корисника
Корисничка обавештења
Статуси присуства корисника
Претрага корисника
Корисници
Гласови
FastComments Python SDK
Ово је званични Python SDK за FastComments.
Званични Python SDK за FastComments API
Репозиторијум
Инсталација 
Install from GitHub
Install directly from a release tag (recommended, fully reproducible):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Pin the tag rather than a branch so builds are deterministic. The same form works in requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Each tagged GitHub Release also has a built wheel attached if you prefer to install a binary artifact directly.
Library Contents
This library contains two modules: the generated API client and the core Python library which contains hand-written utilities to make working with the API easier, including SSO support.
Public vs Secured APIs
For the API client, there are three classes, DefaultApi, PublicApi, and ModerationApi. The DefaultApi contains methods that require your API key, and PublicApi contains methods that can be made directly from a browser/mobile device/etc without authentication. The ModerationApi provides an extensive suite of live and fast moderation APIs. Every ModerationApi method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.
Брзи почетак 
Користење аутентификованих API (DefaultApi)
Важно: Морате поставити ваш API кључ у Configuration пре него што направите аутентификоване захтеве. Ако то не урадите, захтеви ће пропасти са грешком 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Креирајте и конфигуришите API клијент
config = Configuration()
config.host = "https://fastcomments.com"
# Потребно: Поставите ваш API кључ (преузмите га са вашег FastComments контролне табле)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Креирајте API пример са конфигурисаним клијентом
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Сада можете урадити аутентификоване API позиве
try:
# Пример: Додајте SSO корисника
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Чести грешке:
# - 401: API кључ недостаје или је неважећи
# - 400: Валидација захтева није успела
Коришћење јавних API (PublicApi)
Јавни крајњи тачке не захтевају аутентификацију:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Коришћење контролне табле за модерирање (ModerationApi)
ModerationApi управља контролном таблом за модератори. Методе се позивају у име модератора помоћу прослеђивања sso токена:
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Пребројајте коментаре који чекају модерирање
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Коришћење SSO (Single Sign-On)
SDK укључује алате за генерисање безбедних SSO токена:
from sso import FastCommentsSSO, SecureSSOUserData
# Креирајте податке о кориснику (id, email и username су потребни)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Потпишите га вашим API тајним (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Генеришите SSO токен који ће се проследити у widget или API позив
sso_token = sso.create_token()
# Користите овај токен у вашој фронтенд апликацији или га проследите у API позиве
print(f"SSO Token: {sso_token}")
За прост SSO (мање безбедан, за тестирање):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Уобичајени проблеми
- 401 "missing-api-key" грешка: Уверите се да сте поставили
config.api_key = {"api_key": "YOUR_KEY"}пре креирања DefaultApi инстанце. - Погрешна API класа: Користите
DefaultApiза серверске аутентификоване захтеве,PublicApiза клијентске/јавне захтеве иModerationApiза захтеве контролне табле модератора. - Грешке при увозу: Уверите се да увозите из исправног модула:
- API клијент:
from client import ... - SSO алати:
from sso import ...
- API клијент:
Напомене 
Broadcast IDs
Videćete da treba da prosledite broadcast_id u nekim API pozivima. Kada primite događaje, dobićete ovaj ID nazad, pa ćete znati da ignorišete događaj ako planirate da optimistično primenite izmene na klijentu (što ćete verovatno želeti, jer pruža najbolje iskustvo). Prosledite ovde UUID. ID treba da bude dovoljno jedinstven da se ne pojavi dva puta u okviru jedne sesije pregledača.
Захтеви 
- Python >= 3.8
Базична инсталација је чиста стандардна библиотека и пружа SSO помагала. Генерисани
API клијент (DefaultApi/PublicApi/ModerationApi) захтева client екстра,
који увлачи urllib3 >= 1.25.3, python-dateutil >= 2.8.2,
pydantic >= 2.0.0 и typing-extensions >= 4.0.0:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Различите операције (нпр. sum, countDistinct, avg, итд.) су подржане.
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Response
Returns: AggregateResponse
Example

get_audit_logs 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| limit | number | query | Ne | |
| skip | number | query | Ne | |
| order | string | query | Ne | |
| after | number | query | Ne | |
| before | number | query | Ne |
Odgovor
Vraća: GetAuditLogsResponse
Primer

logout_public 
Одговор
Враћа: APIEmptyResponse
Пример

block_from_comment_public 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Одговор
Враћа: BlockSuccess
Пример

un_block_comment_public 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Одговор
Враћа: UnblockSuccess
Пример

checked_comments_for_blocked 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Листа идентификатора коментара, одвојених зарезом. |
| sso | string | query | Не |
Одговор
Враћа: CheckBlockedCommentsResponse
Пример

block_user_from_comment 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odgovor
Vraća: BlockSuccess
Primer

create_comment_public 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: SaveCommentsResponseWithPresence
Пример

delete_comment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Odgovor
Vraća: DeleteCommentResult
Primer

delete_comment_public 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: PublicAPIDeleteCommentResponse
Primer

delete_comment_vote 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Vraća: VoteDeleteResponse
Example

flag_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Одговор
Враћа: FlagCommentResponse
Пример

get_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIGetCommentResponse
Пример

get_comment_text 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: PublicAPIGetCommentTextResponse
Primer

get_comment_vote_user_names 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| dir | integer | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: GetCommentVoteUserNamesSuccessResponse
Пример

get_comments 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | упит | Да | |
| page | integer | упит | Не | |
| limit | integer | упит | Не | |
| skip | integer | упит | Не | |
| asTree | boolean | упит | Не | |
| skipChildren | integer | упит | Не | |
| limitChildren | integer | упит | Не | |
| maxTreeDepth | integer | упит | Не | |
| urlId | string | упит | Не | |
| userId | string | упит | Не | |
| anonUserId | string | упит | Не | |
| contextUserId | string | упит | Не | |
| hashTag | string | упит | Не | |
| parentId | string | упит | Не | |
| direction | string | упит | Не | |
| fromDate | integer | упит | Не | |
| toDate | integer | упит | Не |
Одговор
Returns: APIGetCommentsResponse
Пример

get_comments_public 
req tenantId urlId
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 |
Одговор
Враћа: GetCommentsResponseWithPresencePublicComment
Пример

lock_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Returns: APIEmptyResponse
Пример

pin_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: ChangeCommentPinStatusResponse
Пример

save_comment 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| isLive | boolean | query | Ne | |
| doSpamCheck | boolean | query | Ne | |
| sendEmails | boolean | query | Ne | |
| populateNotifications | boolean | query | Ne |
Odgovor
Vraća: APISaveCommentResponse
Primer

save_comments_bulk 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Odgovor
Vraća: SaveCommentsBulkResponse
Primer

set_comment_text 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: PublicAPISetCommentTextResponse
Primer

un_block_user_from_comment 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne | |
| anonUserId | string | query | Ne |
Odgovor
Returns: UnblockSuccess
Primer

un_flag_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Одговор
Враћа: FlagCommentResponse
Пример

un_lock_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

un_pin_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: ChangeCommentPinStatusResponse
Пример

update_comment 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Odgovor
Returns: APIEmptyResponse
Primer

vote_comment 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: VoteResponse
Primer

get_comments_for_user 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Response
Returns: GetCommentsForUserResponse
Example

add_domain_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: AddDomainConfigResponse
Пример

delete_domain_config 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Одговор
Враћа: DeleteDomainConfigResponse
Пример

get_domain_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Одговор
Враћа: GetDomainConfigResponse
Пример

get_domain_configs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: GetDomainConfigsResponse
Пример

patch_domain_config 
Параметри
| Name | Type | Location | Обавезно | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Одговор
Враћа: PatchDomainConfigResponse
Пример

put_domain_config 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| domainToUpdate | string | path | Da |
Odgovor
Vraća: PutDomainConfigResponse
Primer

create_email_template 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateEmailTemplateResponse
Пример

delete_email_template 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

delete_email_template_render_error 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| errorId | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_email_template 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetEmailTemplateResponse
Пример

get_email_template_definitions 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: GetEmailTemplateDefinitionsResponse
Пример

get_email_template_render_errors 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetEmailTemplateRenderErrorsResponse
Пример

get_email_templates 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetEmailTemplatesResponse
Пример

render_email_template 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Не |
Одговор
Враћа: RenderEmailTemplateResponse
Пример

update_email_template 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_event_log 
req tenantId urlId userIdWS
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Не |
Одговор
Враћа: GetEventLogResponse
Пример

get_global_event_log 
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Не |
Одговор
Враћа: GetEventLogResponse
Пример

create_feed_post 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Odgovor
Vraća: CreateFeedPostsResponse
Primer

create_feed_post_public 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Returns: CreateFeedPostResponse
Пример

delete_feed_post_public 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: DeleteFeedPostPublicResponse
Primer

get_feed_posts 
req tenantId afterId
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| afterId | string | query | Ne | |
| limit | integer | query | Ne | |
| tags | array | query | Ne |
Odgovor
Vraća: GetFeedPostsResponse
Primer

get_feed_posts_public 
req
tenantId
afterId
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 |
Response
Returns: PublicFeedPostsResponse
Пример

get_feed_posts_stats 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: FeedPostsStatsResponse
Пример

get_user_reacts_public 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| postIds | array | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: UserReactsResponse
Primer

react_feed_post_public 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| postId | string | path | Da | |
| isUndo | boolean | query | Ne | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ReactFeedPostResponse
Primer

update_feed_post 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vraća: APIEmptyResponse
Primer

update_feed_post_public 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Vraća: CreateFeedPostResponse
Primer

flag_comment_public 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

get_gif_large 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| largeInternalURLSanitized | string | query | Да |
Одговор
Враћа: GifGetLargeResponse
Пример

get_gifs_search 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| search | string | query | Da | |
| locale | string | query | Ne | |
| rating | string | query | Ne | |
| page | number | query | Ne |
Odgovor
Vraća: GetGifsSearchResponse
Primer

get_gifs_trending 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Одговор
Враћа: GetGifsTrendingResponse
Пример

add_hash_tag 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Vraća: CreateHashTagResponse
Primer

add_hash_tags_bulk 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Returns: BulkCreateHashTagsResponse
Primer

delete_hash_tag 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| tag | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_hash_tags 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | number | query | Не |
Одговор
Враћа: GetHashTagsResponse
Пример

patch_hash_tag 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| tag | string | path | Да |
Одговор
Враћа: UpdateHashTagResponse
Пример

delete_moderation_vote 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| voteId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: VoteDeleteResponse
Primer

get_api_comments 
Параметри
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| page | number | query | Ne | |
| count | number | query | Ne | |
| text-search | string | query | Ne | |
| byIPFromComment | string | query | Ne | |
| filters | string | query | Ne | |
| searchFilters | string | query | Ne | |
| sorts | string | query | Ne | |
| demo | boolean | query | Ne | |
| sso | string | query | Ne |
Одговор
Враћа: ModerationAPIGetCommentsResponse
Пример

get_api_export_status 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: ModerationExportStatusResponse
Primer

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

get_ban_users_from_comment 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Response
Vraća: GetBannedUsersFromCommentResponse
Primer

get_comment_ban_status 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Одговор
Враћа: GetCommentBanStatusResponse
Пример

get_comment_children 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Returns: ModerationAPIChildCommentsResponse
Example

get_count 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| text-search | string | query | Ne | |
| byIPFromComment | string | query | Ne | |
| filter | string | query | Ne | |
| searchFilters | string | query | Ne | |
| demo | boolean | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationAPICountCommentsResponse
Primer

get_counts 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: GetBannedUsersCountResponse
Example

get_logs 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odgovor
Vraća: ModerationAPIGetLogsResponse
Primer

get_manual_badges 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: GetTenantManualBadgesResponse
Example

get_manual_badges_for_user 
Параметри
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: GetUserManualBadgesResponse
Primer

get_moderation_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Одговор
Returns: ModerationAPICommentResponse
Пример

get_moderation_comment_text 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Одговор
Returns: GetCommentTextResponse
Пример

get_pre_ban_summary 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| includeByUserIdAndEmail | boolean | query | Ne | |
| includeByIP | boolean | query | Ne | |
| includeByEmailDomain | boolean | query | Ne | |
| sso | string | query | Ne |
Response
Vraća: PreBanSummary
Example

get_search_comments_summary 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Response
Vraća: ModerationCommentSearchResponse
Example

get_search_pages 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| value | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationPageSearchResponse
Primer

get_search_sites 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| value | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Returns: ModerationSiteSearchResponse
Primer

get_search_suggest 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: ModerationSuggestResponse
Primer

get_search_users 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: ModerationUserSearchResponse
Primer

get_trust_factor 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: GetUserTrustFactorResponse
Primer

get_user_ban_preference 
Parametri
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Одговор
Враћа: APIModerateGetUserBanPreferencesResponse
Пример

get_user_internal_profile 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: GetUserInternalProfileResponse
Primer

post_adjust_comment_votes 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: AdjustVotesResponse
Пример

post_api_export 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| text-search | string | query | Ne | |
| byIPFromComment | string | query | Ne | |
| filters | string | query | Ne | |
| searchFilters | string | query | Ne | |
| sorts | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationExportResponse
Primer

post_ban_user_from_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| banEmail | boolean | query | Ne | |
| banEmailDomain | boolean | query | Ne | |
| banIP | boolean | query | Ne | |
| deleteAllUsersComments | boolean | query | Ne | |
| bannedUntil | string | query | Ne | |
| isShadowBan | boolean | query | Ne | |
| updateId | string | query | Ne | |
| banReason | string | query | Ne | |
| sso | string | query | Ne |
Response
Vraća: BanUserFromCommentResult
Primer

post_ban_user_undo 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vraća: APIEmptyResponse
Primer

post_bulk_pre_ban_summary 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
Vraća: BulkPreBanSummary
Primer

post_comments_by_ids 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vraća: ModerationAPIChildCommentsResponse
Primer

post_flag_comment 
Параметри
| Име | Тип | Локација | Обавезно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: APIEmptyResponse
Пример

post_remove_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: PostRemoveCommentApiResponse
Пример

post_restore_deleted_comment 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: APIEmptyResponse
Primer

post_set_comment_approval_status 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: SetCommentApprovedResponse
Primer

post_set_comment_review_status 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: APIEmptyResponse
Primer

post_set_comment_spam_status 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Returns: APIEmptyResponse
Пример

post_set_comment_text 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: SetCommentTextResponse
Primer

post_un_flag_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

post_vote 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: VoteResponse
Пример

put_award_badge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: AwardUserBadgeResponse
Пример

put_close_thread 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vraća: APIEmptyResponse
Primer

put_remove_badge 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: RemoveUserBadgeResponse
Primer

put_reopen_thread 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vraća: APIEmptyResponse
Primer

set_trust_factor 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Response
Vraća: SetUserTrustFactorResponse
Primer

create_moderator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateModeratorResponse
Пример

delete_moderator 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| sendEmail | string | query | Ne |
Odgovor
Vraća: APIEmptyResponse
Primer

get_moderator 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetModeratorResponse
Пример

get_moderators 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetModeratorsResponse
Пример

send_invite 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Респонс
Враћа: APIEmptyResponse
Пример

update_moderator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

delete_notification_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Враћа: APIEmptyResponse
Пример

get_cached_notification_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetCachedNotificationCountResponse
Пример

get_notification_count 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne | |
| urlId | string | query | Ne | |
| fromCommentId | string | query | Ne | |
| viewed | boolean | query | Ne | |
| type | string | query | Ne |
Odgovor
Vraća: GetNotificationCountResponse
Primer

get_notifications 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Odgovor
Vraća: GetNotificationsResponse
Primer

update_notification 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Враћа
Returns: APIEmptyResponse
Пример

create_v1_page_react 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
Одговор
Враћа: CreateV1PageReact
Пример

create_v2_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да | |
| title | string | query | Не |
Одговор
Враћа: CreateV1PageReact
Пример

delete_v1_page_react 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da |
Odgovor
Vraća: CreateV1PageReact
Primer

delete_v2_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да |
Одговор
Враћа: CreateV1PageReact
Пример

get_v1_page_likes 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Одговор
Враћа: GetV1PageLikes
Пример

get_v2_page_react_users 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да |
Одговор
Vraća: GetV2PageReactUsersResponse
Primer

get_v2_page_reacts 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Одговор
Враћа: GetV2PageReacts
Пример

add_page 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: AddPageAPIResponse
Пример

delete_page 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: DeletePageAPIResponse
Пример

get_offline_users 
Past коментатори на страници који ТРЕНУТНО НИСУ онлајн. Сортирани по displayName.
Користите ово након што исцрпите /users/online да прикажете секцију „Members“.
Курсорска пагинација на commenterName: сервер пролази кроз парцијални {tenantId, urlId, commenterName} индекс од afterName напред помоћу $gt, без $skip трошка.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Идентификатор URL‑а странице (очишћен на серверу). |
| afterName | string | query | No | Курсор: проследите nextAfterName из претходног одговора. |
| afterUserId | string | query | No | Курсор за решавање везног догађаја: проследите nextAfterUserId из претходног одговора. Потребно када је afterName постављен како би се у случају истица имена улази не изгубили. |
Response
Returns: PageUsersOfflineResponse
Example

get_online_users 
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identifikator URL-a stranice (čišćen na serveru). |
| afterName | string | query | No | Kursor: prosledite nextAfterName iz prethodnog odgovora. |
| afterUserId | string | query | No | Kursor za razrešavanje neravnoteže: prosledite nextAfterUserId iz prethodnog odgovora. Obavezno kada je postavljen afterName kako bi se imena sa istim vrednostima ne izostavljala. |
Response
Returns: PageUsersOnlineResponse
Example

get_page_by_urlid 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Одговор
Враћа: GetPageByURLIdAPIResponse
Пример

get_pages 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: GetPagesAPIResponse
Пример

get_pages_public 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Neprozirni kursor paginacije vraćen kao nextCursor iz prethodnog zahteva. Vezao se za isti sortBy. |
| limit | integer | query | No | 1..200, podrazumevano 50 |
| q | string | query | No | Opcioni filter prefiksa naslova neosetljivog na veličinu slova. |
| sortBy | string | query | No | Redosled sortiranja. updatedAt (podrazumevano, najnoviji prvo), commentCount (najviše komentara prvo), ili title (abecedno). |
| hasComments | boolean | query | No | Ako je true, vraća samo stranice sa najmanje jednim komentarom. |
Response
Vraća: GetPublicPagesResponse
Example

get_users_info 
Масовне информације о корисницима за тенанта. За дате userIds, враћа информације за приказ из User / SSOUser. Користи га comment widget да обогати кориснике који су се управо појавили путем догађаја присуства. Нема контекста странице: приватност се примењује једнако (приватни профили су замагљени).
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| ids | string | query | Да | userIds одвојени зарезом. |
Одговор
Враћа: PageUsersInfoResponse
Пример

patch_page 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: PatchPageAPIResponse
Пример

delete_pending_webhook_event 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_pending_webhook_event_count 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Vraća: GetPendingWebhookEventCountResponse
Primer

get_pending_webhook_events 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Vraća: GetPendingWebhookEventsResponse
Primer

create_question_config 
Параметри
| Име | Тип | Локација | Захтевано | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateQuestionConfigResponse
Пример

delete_question_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_question_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetQuestionConfigResponse
Пример

get_question_configs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetQuestionConfigsResponse
Пример

update_question_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

create_question_result 
Параметри
| Име | Тип | Локација | Захтевано | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateQuestionResultResponse
Пример

delete_question_result 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_question_result 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetQuestionResultResponse
Пример

get_question_results 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Ne | |
| userId | string | query | Ne | |
| startDate | string | query | Ne | |
| questionId | string | query | Ne | |
| questionIds | string | query | Ne | |
| skip | number | query | Ne |
Odgovor
Vraća: GetQuestionResultsResponse
Primer

update_question_result 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

aggregate_question_results 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Returns: AggregateQuestionResultsResponse
Primer

bulk_aggregate_question_results 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| forceRecalculate | boolean | query | Не |
Одговор
Враћа: BulkAggregateQuestionResultsResponse
Пример

combine_comments_with_question_results 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Vraća: CombineQuestionResultsWithCommentsResponse
Primer

add_sso_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: AddSSOUserAPIResponse
Пример

delete_sso_user 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Response
Returns: DeleteSSOUserAPIResponse
Example

get_sso_user_by_email 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| string | path | Да |
Одговор
Враћа: GetSSOUserByEmailAPIResponse
Пример

get_sso_user_by_id 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetSSOUserByIdAPIResponse
Пример

get_sso_users 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Не |
Одговор
Враћа: GetSSOUsersResponse
Пример

patch_sso_user 
Параметри
| Назив | Тип | Локација | Захтевано | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Одговор
Враћа: PatchSSOUserAPIResponse
Пример

put_sso_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Одговор
Враћа: PutSSOUserAPIResponse
Пример

create_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateSubscriptionAPIResponse
Пример

delete_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Одговор
Враћа: DeleteSubscriptionAPIResponse
Пример

get_subscriptions 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не |
Одговор
Враћа: GetSubscriptionsAPIResponse
Пример

update_subscription 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Одговор
Враћа: UpdateSubscriptionAPIResponse
Пример

get_tenant_daily_usages 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Одговор
Returns: GetTenantDailyUsagesResponse
Пример

create_tenant_package 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateTenantPackageResponse
Пример

delete_tenant_package 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_tenant_package 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetTenantPackageResponse
Пример

get_tenant_packages 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetTenantPackagesResponse
Пример

replace_tenant_package 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

update_tenant_package 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

create_tenant_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Response
Враћа: CreateTenantUserResponse
Пример

delete_tenant_user 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Odgovor
Returns: APIEmptyResponse
Primer

get_tenant_user 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetTenantUserResponse
Пример

get_tenant_users 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetTenantUsersResponse
Пример

replace_tenant_user 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

send_login_link 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

update_tenant_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

create_tenant 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateTenantResponse
Пример

delete_tenant 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

get_tenant 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetTenantResponse
Пример

get_tenants 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Одговор
Враћа: GetTenantsResponse
Пример

update_tenant 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

change_ticket_state 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: ChangeTicketStateResponse
Пример

create_ticket 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да |
Одговор
Враћа: CreateTicketResponse
Пример

get_ticket 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Одговор
Враћа: GetTicketResponse
Пример

get_tickets 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Odgovor
Vraća: GetTicketsResponse
Primer

get_translations 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Одговор
Враћа: GetTranslationsResponse
Пример

upload_image 
Upload and resize an image
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| sizePreset | string | query | Не | Претподешавање величине: "Default" (1000x1000px) or "CrossPlatform" (creates sizes for popular devices) |
| urlId | string | query | Не | Идентификатор странице са које се врши отпремање, за подешавање |
Одговор
Враћа: UploadImageResponse
Пример

get_user_badge_progress_by_id 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIGetUserBadgeProgressResponse
Пример

get_user_badge_progress_by_user_id 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Одговор
Враћа: APIGetUserBadgeProgressResponse
Пример

get_user_badge_progress_list 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Odgovor
Vraća: APIGetUserBadgeProgressListResponse
Primer

create_user_badge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: APICreateUserBadgeResponse
Пример

delete_user_badge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptySuccessResponse
Пример

get_user_badge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIGetUserBadgeResponse
Пример

get_user_badges 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| badgeId | string | query | Не | |
| type | number | query | Не | |
| displayedOnComments | boolean | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Одговор
Враћа: APIGetUserBadgesResponse
Пример

update_user_badge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptySuccessResponse
Пример

get_user_notification_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: GetUserNotificationCountResponse
Пример

get_user_notifications 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Koristi se da se utvrdi da li je trenutna stranica pretplaćena. |
| 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
Vraća: GetMyNotificationsResponse
Primer

reset_user_notification_count 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: ResetUserNotificationsResponse
Пример

reset_user_notifications 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| afterId | string | query | Ne | |
| afterCreatedAt | integer | query | Ne | |
| unreadOnly | boolean | query | Ne | |
| dmOnly | boolean | query | Ne | |
| noDm | boolean | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ResetUserNotificationsResponse
Primer

update_user_notification_comment_subscription_status 
Omogućite ili onemogućite obaveštenja za određeni komentar.
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vraća: UpdateUserNotificationCommentSubscriptionStatusResponse
Primer

update_user_notification_page_subscription_status 
Омогућите или онемогућите обавештења за страницу. Када су корисници претплаћени на страницу, обавештења се креирају за нове коренске коментаре, и такође
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Не |
Одговор
Враћа: UpdateUserNotificationPageSubscriptionStatusResponse
Пример

update_user_notification_status 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| notificationId | string | path | Da | |
| newStatus | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: UpdateUserNotificationStatusResponse
Primer

get_user_presence_statuses 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlIdWS | string | query | Да | |
| userIds | string | query | Да |
Одговор
Враћа: GetUserPresenceStatusesResponse
Пример

search_users 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| usernameStartsWith | string | query | Ne | |
| mentionGroupIds | array | query | Ne | |
| sso | string | query | Ne | |
| searchSection | string | query | Ne |
Response
Vraća: SearchUsersResult
Example

get_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetUserResponse
Пример

create_vote 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odgovor
Vraća: VoteResponse
Primer

delete_vote 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| editKey | string | query | Не |
Одговор
Враћа: VoteDeleteResponse
Пример

get_votes 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Одговор
Враћа: GetVotesResponse
Пример

get_votes_for_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Одговор
Враћа: GetVotesForUserResponse
Пример

Потребна помоћ?
Ако наиђете на било какве проблеме или имате питања у вези са Python SDK, молимо вас:
Допринеси
Доприноси су добродошли! Молимо посетите репозиторијум на GitHub-у за смернице о доприносу.