Dokumentacja APIGET

Lista wzmianek

Wyświetl wzmianki ocenione przez AI z Reddita, Hacker News, X, Bluesky i Facebooka, z filtrami i paginacją.

GEThttps://ai.redreplier.com/ai-app/api/v1/mentions

Wyświetl wzmianki ocenione przez AI z Reddita, Hacker News, X, Bluesky i Facebooka, z filtrami i paginacją.

Token Bearer (token API RedReplier)

Uwierzytelnianie

Wysyłaj token API RedReplier jako token Bearer w każdym żądaniu. Tokeny zaczynają się od redreplier_; RedReplier ustala konto na podstawie tokena. Wyślij X-Workspace-Id, aby działać w obszarze roboczym innym niż domyślny; zobacz Lista obszarów roboczych.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • websiteId (zapytanie, UUID, opcjonalny): Filtr do jednej strony.
  • statuses (zapytanie, powtarzalny, opcjonalny): Statusy wzmianek: NEW, APPROVED, REJECTED.
  • scoreBuckets (zapytanie, powtarzalny, opcjonalny): Przedziały trafności: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH.
  • includeLowRelevance (zapytanie, boolean, opcjonalny): Uwzględnij wzmianki poniżej minimalnej oceny strony (domyślnie 30).
  • minScore (zapytanie, integer, opcjonalny, 0-100): Tylko wzmianki z co najmniej taką oceną. Wzmianki bez oceny są pomijane. Minimalna ocena strony nadal obowiązuje, chyba że includeLowRelevance ma wartość true.
  • keywords (zapytanie, powtarzalny, opcjonalny): Filtr według wartości słów kluczowych.
  • sources (zapytanie, powtarzalny, opcjonalny): Źródła wzmianek: REDDIT_POST, REDDIT_COMMENT, TWITTER (X), BLUESKY, HACKERNEWS, FACEBOOK, FACEBOOK_GROUP.
  • sort (zapytanie, opcjonalny): Kolejność sortowania: RELEVANCE lub RECENT.
  • from, to (zapytanie, ISO string, opcjonalny): Zakres dat pobrania.
  • limit (zapytanie, integer, opcjonalny, 1-500, domyślnie 50): Rozmiar strony wyników.
  • offset (zapytanie, integer, opcjonalny, min. 0, domyślnie 0): Przesunięcie paginacji.

Treść żądania

Ten endpoint nie wymaga treści JSON.

Odpowiedź

Zwraca publiczne obiekty Mention z paginacją.

  • mentions (Mention[]): Wzmianki na bieżącej stronie wyników.
  • total (number): Łączna liczba pasujących wzmianek.
  • limit (number): Rozmiar strony wyników użyty w odpowiedzi.
  • offset (number): Przesunięcie paginacji użyte w odpowiedzi.

Obiekt Mention

  • id (string): UUID wzmianki.
  • websiteId (string | null): UUID strony.
  • source (string): REDDIT_POST, REDDIT_COMMENT, TWITTER (X), BLUESKY, HACKERNEWS, FACEBOOK lub FACEBOOK_GROUP.
  • keyword (string | null): Wartość dopasowanego słowa kluczowego.
  • title, contentText, url, author, subreddit (string | null): Kontekst: tytuł, treść i link. subreddit zawiera nazwę subreddita dla źródeł z Reddita oraz identyfikator grupy dla FACEBOOK_GROUP, a dla pozostałych źródeł ma wartość null.
  • status (string): NEW, APPROVED lub REJECTED.
  • relevanceScore (number | null): Ocena trafności od AI w skali od 0 do 100 lub null.
  • relevanceReason (string | null): Wyjaśnienie dopasowania od AI lub null.
  • aiReplySuggestion (string | null): Szkic odpowiedzi od AI do przejrzenia przez człowieka przed publikacją lub null.
  • tags (string[]): Tagi trafności wygenerowane przez AI.
  • publishedAt, ingestedAt, reviewedAt, createdAt, updatedAt (ISO string | null): Znaczniki czasu publikacji, pobrania, przeglądu, utworzenia i aktualizacji w formacie ISO 8601 lub null.

Przykładowe żądanie

curl -s 'https://ai.redreplier.com/ai-app/api/v1/mentions?statuses=NEW&minScore=50&sort=RECENT&limit=20' \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Uwagi

Domyślnie wzmianki REJECTED są wykluczone, a wzmianki poniżej minimalnej oceny strony (domyślnie 30) są ukryte. minScore dodatkowo zawęża wyniki i sam nigdy nie obniża tego progu. Przedziały: VERY_LOW <10, LOW 10-29, MEDIUM 30-49, HIGH 50-74, VERY_HIGH >=75.

Błędy

  • 400 Bad Request: Nieprawidłowe dane wejściowe, URL, UUID, wartość enum, parametr zapytania lub treść żądania.
  • 401 Unauthorized: Brak tokena Bearer lub nieprawidłowy token albo code: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.
  • 403 Forbidden: code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API, code: "workspace_access_denied", gdy X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych poświadczeń, lub code: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnienia redreplier.write (mają je Administrator i Edytor).
  • 404 Not Found: Zasób nie istnieje dla konta powiązanego z tokenem.
  • 429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną w Retry-After.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.
Przykładowe żądanie (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/mentions?websiteId=9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10&statuses=NEW&minScore=50&sort=RELEVANCE&limit=25 \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "mentions": [
    {
      "id": "6a9f0e8b-2c65-44f7-b6e6-7f88a7df8301",
      "websiteId": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
      "source": "REDDIT_POST",
      "keyword": "agency CRM",
      "title": "Best CRM for a small agency?",
      "contentText": "We need a lightweight CRM for client follow-ups and deal tracking.",
      "url": "https://reddit.com/r/sales/comments/example/best_crm_for_a_small_agency",
      "author": "agency_ops",
      "subreddit": "sales",
      "status": "NEW",
      "relevanceScore": 86,
      "relevanceReason": "The thread asks for an agency CRM, which directly matches the monitored product category.",
      "aiReplySuggestion": "We built Acme CRM for small agencies with exactly this problem. Happy to share how teams set up follow-up reminders.",
      "tags": ["recommendation-request", "high-intent"],
      "publishedAt": "2026-05-29T09:20:00.000Z",
      "ingestedAt": "2026-05-29T09:24:12.000Z",
      "reviewedAt": null,
      "createdAt": "2026-05-29T09:24:12.000Z",
      "updatedAt": "2026-05-29T09:24:12.000Z"
    }
  ],
  "total": 1,
  "limit": 25,
  "offset": 0
}