Endpunkte und Authentifizierung
Nutzen Sie GET und den Schlüssel von redditlistening.com in Authorization: Bearer oder X-API-Key. /v1/search sucht in title und text. /v1/posts legt den Typ post fest und /v1/comments den Typ comment; beide Listen benötigen keine id. /v1/item benötigt dagegen id und akzeptiert ausschließlich diesen Parameter für einen einzelnen Datensatz, nicht die allgemeinen Filter der Inhaltssuche.
Inhaltssuchen unterstützen q, subreddit, author, kind, from, to, min_score, limit und page. kind akzeptiert post oder comment. from und to erwarten YYYY-MM-DD in UTC und filtern created_utc, den Erstellungszeitpunkt des Inhalts. to schließt den gesamten Endtag ein. Abrufzeit und Aufnahme in das Archiv sind damit nicht gemeint. min_score ist ein Mindestwertfilter, keine Sortierung nach Beliebtheit oder Stimmung.
/v1/subreddits akzeptiert prefix und limit für Community-Namen, aber weder page noch die Inhaltsfilter. Die dortigen Zählwerte sind kein exaktes Gesamtinventar. /v1/status ist öffentlich und unberechnet. Es liefert eine statische Auskunft und bestätigt eine HTTP-Antwort, ohne Suchsystem, verfügbare Datensätze, Schlüssel oder Guthaben zu prüfen. Verwenden Sie es nicht als Beleg für die Erreichbarkeit bestimmter Archivtexte.
Grenzen, Reihenfolge und Gesamtzahlen
Bei Inhaltssuchen liegen limit und page zwischen 1 und 100. Ergebnisse folgen _doc, nicht einer chronologischen oder nach Relevanz beziehungsweise Punktzahl sortierten Folge. Das Durchlaufen aller zulässigen Seiten beweist keine vollständige Erfassung. Eine Aufteilung nach Zeiträumen kann die Arbeit ordnen, sichert aber weder alle passenden Einträge noch eine Auswahl ohne Duplikate. Dokumentieren Sie daher die Grenzen Ihres Abrufs.
Die Gesamtzahl muss zusammen mit ihrer Relation gelesen werden: eq bedeutet exakt, gte eine Untergrenze und unknown, dass keine verlässliche Gesamtzahl vorliegt; der Wert kann null sein. Unbekannt ist nicht gleich null Treffer. Speichern Sie diese Angaben mit den Parametern. Ein Suchtotal beschreibt weder die Zahl aller Käufer noch alle Gespräche, die jemals über das Produkt geführt wurden.
Antworten bestehen aus flachen Datensätzen, nicht aus serverseitig aufgebauten Gesprächsbäumen. Wenn parent_id und link_id vorhanden sind, können Sie lokal Beziehungen bilden, ohne vollständige Elternketten vorauszusetzen. Beide Felder sind keine Suchfilter. Forschungslabels wie Verschleiß oder Reparatur werden von Ihrem Team vergeben und sollten als eigene Daten getrennt von den gelieferten Feldern gespeichert werden.
Fehler und Abrechnung einordnen
HTTP 400 kennzeichnet eine ungültige Anfrage, 401 einen fehlenden oder ungültigen Schlüssel, 402 unzureichendes Guthaben und 429 eine Anfrageratenbegrenzung. Beheben Sie die Ursache vor weiteren Versuchen. Abgewiesene Anfragen verbrauchen keine Credits; Fehler der Datenquelle geben die Reservierung zurück. Eine lokal unklare Textinterpretation ist hingegen kein Fehler des Abrufdienstes und löst keine Erstattung aus.
Ein erfolgreicher Abruf kostet einen Credit, auch bei leerem Ergebnis. Verliert Ihr Client die Antwort nach einem Servererfolg, kann der Abruf bereits berechnet sein. Ein erfolgreicher neuer Versuch kostet erneut. Das erneute Lesen oder Codieren einer gespeicherten Antwort ist keine weitere API-Anfrage. Getrennte Protokolle für Abruf und Analyse helfen, die Kosten und den Forschungsprozess richtig zu erklären.
