
Język 🇵🇱 Polski
Pierwsze kroki
Dokumentacja
Agregacja
Dzienniki audytu
Blokowanie z komentarza
Sprawdź zablokowane komentarze
Komentarze
Konfiguracje domen
Szablony e-mail
Dziennik zdarzeń
Wpisy w kanale
Zgłaszanie komentarza
Hashtagi
Moderatorzy
Licznik powiadomień
Powiadomienia
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne użycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Przesyłanie obrazu
Postęp odznak użytkownika
Odznaki użytkowników
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments Python SDK
To jest oficjalne SDK Pythona dla FastComments.
Oficjalne SDK Pythona dla API FastComments
Repozytorium
Instalacja 
PyPI
pip install fastcomments
Library Contents
Ta biblioteka zawiera dwa moduły: wygenerowanego klienta API oraz główną bibliotekę Pythona, która zawiera ręcznie napisane narzędzia ułatwiające pracę z API, w tym obsługę SSO.
Publiczne vs zabezpieczone API
Dla klienta API są dwie klasy, DefaultApi i PublicApi. DefaultApi zawiera metody, które wymagają twojego klucza API, natomiast PublicApi zawiera wywołania API, które można wykonywać bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelniania.
Szybki start 
Korzystanie z uwierzytelnionych API (DefaultApi)
Ważne: Musisz ustawić swój klucz API w Configuration przed wykonywaniem uwierzytelnionych żądań. Jeśli tego nie zrobisz, żądania zakończą się błędem 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Utwórz i skonfiguruj klienta API
config = Configuration()
config.host = "https://fastcomments.com/api"
# WYMAGANE: Ustaw swój klucz API (pobierz go z panelu FastComments)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Utwórz instancję API z skonfigurowanym klientem
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Teraz możesz wykonywać uwierzytelnione wywołania API
try:
# Przykład: Dodaj użytkownika SSO
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Typowe błędy:
# - 401: Brakujący lub nieprawidłowy klucz API
# - 400: Walidacja żądania nie powiodła się
Korzystanie z publicznych API (PublicApi)
Publiczne endpointy nie wymagają uwierzytelnienia:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
Korzystanie z SSO (Single Sign-On)
SDK zawiera narzędzia do generowania bezpiecznych tokenów SSO:
from sso import FastCommentsSSO, SecureSSOUserData
# Utwórz dane użytkownika
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Utwórz instancję SSO z Twoim sekretem API
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Wygeneruj token SSO
sso_token = sso.create_token()
# Użyj tego tokenu w frontendzie lub przekaż do wywołań API
print(f"SSO Token: {sso_token}")
Dla prostego SSO (mniej bezpieczne, do testów):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Częste problemy
- 401 "missing-api-key" error: Upewnij się, że ustawisz
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}przed utworzeniem instancji DefaultApi. - Zła klasa API: Użyj
DefaultApidla uwierzytelnionych żądań po stronie serwera,PublicApidla żądań po stronie klienta/publicznych. - Błędy importu: Upewnij się, że importujesz z poprawnego modułu:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
Uwagi 
Identyfikatory Broadcast
Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcast_id. Kiedy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli zamierzasz optymistycznie zastosować zmiany po stronie klienta (co prawdopodobnie będziesz chciał zrobić, ponieważ zapewnia to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, żeby nie wystąpił dwukrotnie w sesji przeglądarki.
Wymagania 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
Agreguj 
Agreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itp.).
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| parentTenantId | string | query | Nie | |
| includeStats | boolean | query | Nie |
Odpowiedź
Zwraca: AggregationResponse
Przykład

Pobierz dzienniki audytu 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| limit | number | query | Nie | |
| skip | number | query | Nie | |
| order | string | query | Nie | |
| after | number | query | Nie | |
| before | number | query | Nie |
Odpowiedź
Zwraca: GetAuditLogs200Response
Przykład

Zablokuj na podstawie komentarza (publiczne) 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

Odblokuj z komentarza (publiczne) 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

Sprawdź komentarze pod kątem zablokowanych 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy oddzielonych przecinkami. |
| sso | string | query | Nie |
Response
Zwraca: CheckedCommentsForBlocked200Response
Przykład

Zablokuj użytkownika z komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

Utwórz komentarz (publiczny) 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateCommentPublic200Response
Przykład

Usuń komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| contextUserId | string | query | Nie | |
| isLive | boolean | query | Nie |
Odpowiedź
Zwraca: DeleteComment200Response
Przykład

Usuń komentarz (publiczny) 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentPublic200Response
Przykład

Usuń głos komentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | 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 |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

Zgłoś komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

Pobierz komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetComment200Response
Przykład

Pobierz treść komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| editKey | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetCommentText200Response
Przykład

Pobierz nazwy użytkowników głosujących na komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNames200Response
Przykład

Pobierz komentarze 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | integer | query | Nie | |
| limit | integer | query | Nie | |
| skip | integer | query | Nie | |
| asTree | boolean | query | Nie | |
| skipChildren | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie | |
| contextUserId | string | query | Nie | |
| hashTag | string | query | Nie | |
| parentId | string | query | Nie | |
| direction | string | query | Nie |
Odpowiedź
Zwraca: GetComments200Response
Przykład

Pobierz komentarze (publiczne) 
żądanie tenantId urlId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| page | integer | zapytanie | Nie | |
| direction | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie | |
| skip | integer | zapytanie | Nie | |
| skipChildren | integer | zapytanie | Nie | |
| limit | integer | zapytanie | Nie | |
| limitChildren | integer | zapytanie | Nie | |
| countChildren | boolean | zapytanie | Nie | |
| fetchPageForCommentId | string | zapytanie | Nie | |
| includeConfig | boolean | zapytanie | Nie | |
| countAll | boolean | zapytanie | Nie | |
| includei10n | boolean | zapytanie | Nie | |
| locale | string | zapytanie | Nie | |
| modules | string | zapytanie | Nie | |
| isCrawler | boolean | zapytanie | Nie | |
| includeNotificationCount | boolean | zapytanie | Nie | |
| asTree | boolean | zapytanie | Nie | |
| maxTreeDepth | integer | zapytanie | Nie | |
| useFullTranslationIds | boolean | zapytanie | Nie | |
| parentId | string | zapytanie | Nie | |
| searchText | string | zapytanie | Nie | |
| hashTags | array | zapytanie | Nie | |
| userId | string | zapytanie | Nie | |
| customConfigStr | string | zapytanie | Nie | |
| afterCommentId | string | zapytanie | Nie | |
| beforeCommentId | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetCommentsPublic200Response
Przykład

Zablokuj komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

Przypnij komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| broadcastId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

Zapisz komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string |
Lokalizacja | Tak | |
| isLive | boolean |
Lokalizacja | Nie | |
| doSpamCheck | boolean |
Lokalizacja | Nie | |
| sendEmails | boolean |
Lokalizacja | Nie | |
| populateNotifications | boolean |
Lokalizacja | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

Zapisz komentarze zbiorczo 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

Ustaw treść komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetCommentText200Response
Przykład

Odblokuj użytkownika z komentarza 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak | |
| userId | string | zapytanie | Nie | |
| anonUserId | string | zapytanie | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

Cofnij zgłoszenie komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

Odblokuj komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

Odepnij komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

Zaktualizuj komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| contextUserId | string | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| isLive | boolean | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Oddaj głos na komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

Dodaj konfigurację domeny 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: AddDomainConfig200Response
Przykład

Usuń konfigurację domeny 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Odpowiedź
Zwraca: DeleteDomainConfig200Response
Przykład

Pobierz konfigurację domeny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

Pobierz konfiguracje domen 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetDomainConfigs200Response
Przykład

Zaktualizuj częściowo konfigurację domeny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

Zastąp konfigurację domeny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

Utwórz szablon e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateEmailTemplate200Response
Przykład

Usuń szablon e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Usuń błąd renderowania szablonu e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz szablon e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetEmailTemplate200Response
Przykład

Pobierz definicje szablonów e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetEmailTemplateDefinitions200Response
Przykład

Pobierz błędy renderowania szablonów e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrors200Response
Przykład

Pobierz szablony e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplates200Response
Przykład

Wyrenderuj szablon e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| locale | string | query | Nie |
Odpowiedź
Zwraca: RenderEmailTemplate200Response
Przykład

Zaktualizuj szablon e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz dziennik zdarzeń 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| userIdWS | string | zapytanie | Tak | |
| startTime | integer | zapytanie | Tak | |
| endTime | integer | zapytanie | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

Pobierz globalny dziennik zdarzeń 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

Utwórz wpis w kanale 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPost200Response
Przykład

Utwórz wpis w kanale (publiczny) 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

Usuń wpis w kanale (publiczny) 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteFeedPostPublic200Response
Przykład

Pobierz wpisy w kanale 
req tenantId afterId
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie |
Odpowiedź
Zwraca: GetFeedPosts200Response
Przykład

Pobierz wpisy w kanale (publiczne) 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie | |
| sso | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeUserInfo | boolean | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsPublic200Response
Przykład

Pobierz statystyki wpisów w kanale 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsStats200Response
Przykład

Pobierz reakcje użytkownika (publiczne) 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserReactsPublic200Response
Przykład

Zareaguj na wpis w kanale (publiczne) 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| isUndo | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ReactFeedPostPublic200Response
Przykład

Zaktualizuj wpis w kanale 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Zaktualizuj wpis w kanale (publiczne) 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

Zgłoś komentarz (publiczne) 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| isFlagged | boolean | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Dodaj hashtag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTag200Response
Przykład

Dodaj hashtagi zbiorczo 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTagsBulk200Response
Przykład

Usuń hashtag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | ścieżka | Yes | |
| tenantId | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz hashtagi 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTags200Response
Przykład

Zaktualizuj częściowo hashtag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Tak | |
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: PatchHashTag200Response
Przykład

Utwórz moderatora 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateModerator200Response
Przykład

Usuń moderatora 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sendEmail | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz moderatora 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetModerator200Response
Przykład

Pobierz moderatorów 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModerators200Response
Przykład

Wyślij zaproszenie 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| fromName | string | query | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Zaktualizuj moderatora 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Usuń licznik powiadomień 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz zbuforowany licznik powiadomień 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetCachedNotificationCount200Response
Przykład

Pobierz liczbę powiadomień 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie |
Odpowiedź
Zwraca: GetNotificationCount200Response
Przykład

Pobierz powiadomienia 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetNotifications200Response
Przykład

Zaktualizuj powiadomienie 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Dodaj stronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: AddPageAPIResponse
Przykład

Usuń stronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

Pobierz stronę po identyfikatorze URL 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetPageByURLIdAPIResponse
Przykład

Pobierz strony 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

Zaktualizuj częściowo stronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: PatchPageAPIResponse
Przykład

Usuń oczekujące zdarzenie webhook 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz liczbę oczekujących zdarzeń webhook 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEventCount200Response
Przykład

Pobierz oczekujące zdarzenia webhook 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEvents200Response
Przykład

Utwórz konfigurację pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfig200Response
Przykład

Usuń konfigurację pytania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz konfigurację pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionConfig200Response
Przykład

Pobierz konfiguracje pytań 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionConfigs200Response
Przykład

Zaktualizuj konfigurację pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Utwórz wynik pytania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateQuestionResult200Response
Przykład

Usuń wynik pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz wynik pytania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionResult200Response
Przykład

Pobierz wyniki pytań 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| startDate | string | query | Nie | |
| questionId | string | query | Nie | |
| questionIds | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionResults200Response
Przykład

Zaktualizuj wynik pytania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Agreguj wyniki pytań 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| timeBucket | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: AggregateQuestionResults200Response
Przykład

Masowa agregacja wyników pytań 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: BulkAggregateQuestionResults200Response
Przykład

Połącz komentarze z wynikami pytań 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie | |
| minValue | number | query | Nie | |
| maxValue | number | query | Nie | |
| limit | number | query | Nie |
Odpowiedź
Zwraca: CombineCommentsWithQuestionResults200Response
Przykład

Dodaj użytkownika SSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

Usuń użytkownika SSO 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | boolean | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: DeleteSSOUserAPIResponse
Przykład

Pobierz użytkownika SSO po e-mailu 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

Pobierz użytkownika SSO po identyfikatorze 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: GetSSOUserByIdAPIResponse
Przykład

Pobierz użytkowników SSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsers200Response
Przykład

Zaktualizuj częściowo użytkownika SSO 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

Zastąp użytkownika SSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

Utwórz subskrypcję 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateSubscriptionAPIResponse
Przykład

Usuń subskrypcję 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

Pobierz subskrypcje 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: GetSubscriptionsAPIResponse
Przykład

Pobierz dzienne użycie najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| yearNumber | number | query | Nie | |
| monthNumber | number | query | Nie | |
| dayNumber | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantDailyUsages200Response
Przykład

Utwórz pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantPackage200Response
Przykład

Usuń pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz pakiet najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantPackage200Response
Przykład

Pobierz pakiety najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetTenantPackages200Response
Przykład

Zastąp pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Zaktualizuj pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Utwórz użytkownika najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateTenantUser200Response
Przykład

Usuń użytkownika najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz użytkownika najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantUser200Response
Przykład

Pobierz użytkowników najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsers200Response
Przykład

Zastąp użytkownika najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Wyślij link do logowania 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| redirectURL | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Zaktualizuj użytkownika najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak | |
| updateComments | string | zapytanie | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Utwórz najemcę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenant200Response
Przykład

Usuń najemcę 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sure | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz najemcę 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenant200Response
Przykład

Pobierz najemców 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| meta | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenants200Response
Przykład

Zaktualizuj najemcę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Prześlij obraz 
Prześlij i zmień rozmiar obrazu
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| sizePreset | string | query | Nie | Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | Nie | Id strony, z której odbywa się przesyłanie, do konfiguracji |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

Pobierz postęp odznaki użytkownika po identyfikatorze 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

Pobierz postęp odznaki po identyfikatorze użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

Pobierz listę postępów odznak użytkowników 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadgeProgressList200Response
Przykład

Utwórz odznakę użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateUserBadge200Response
Przykład

Usuń odznakę użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: UpdateUserBadge200Response
Przykład

Pobierz odznakę użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadge200Response
Przykład

Pobierz odznaki użytkownika 
Parametry
| Name | Type | Location | Wymagane | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| badgeId | string | query | Nie | |
| type | number | query | Nie | |
| displayedOnComments | boolean | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadges200Response
Przykład

Zaktualizuj odznakę użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: UpdateUserBadge200Response
Przykład

Pobierz liczbę powiadomień użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetUserNotificationCount200Response
Przykład

Pobierz powiadomienia użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| pageSize | integer | query | Nie | |
| afterId | string | query | Nie | |
| includeContext | boolean | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| includeTranslations | boolean | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: GetUserNotifications200Response
Przykład

Zresetuj licznik powiadomień użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ResetUserNotifications200Response
Przykład

Zresetuj powiadomienia użytkownika 
Parametry
| Nazwa | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotifications200Response
Przykład

Zaktualizuj status subskrypcji powiadomień o komentarzach użytkownika 
Włącz lub wyłącz powiadomienia dla konkretnego komentarza.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

Zaktualizuj status subskrypcji powiadomień o stronie użytkownika 
Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy subskrybują stronę, tworzone są powiadomienia dla nowych komentarzy głównych, a także
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

Zaktualizuj status powiadomienia użytkownika 
Parametry
| Nazwa | Typ | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| newStatus | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

Pobierz statusy obecności użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Odpowiedź
Zwraca: GetUserPresenceStatuses200Response
Przykład

Wyszukaj użytkowników 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| usernameStartsWith | string | query | Tak | |
| mentionGroupIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SearchUsers200Response
Przykład

Pobierz użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUser200Response
Przykład

Utwórz głos 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Tak | |
| direction | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

Usuń głos 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| editKey | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

Pobierz głosy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotes200Response
Przykład

Pobierz głosy użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: GetVotesForUser200Response
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK Pythona, prosimy:
Contributing
Wkład jest mile widziany! Proszę odwiedzić repozytorium GitHub w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.