LRT Dokumentation- 03 LRT Entdecken
- 3 API Integrationen
- LRT API Schnittstelle
- LRT API Spezifikation
LRT API Spezifikation
API Grundlagen
Die LinkResearchTools API erlaubt Ihnen Bulk URL Analyzer (URL, JUICE) Reporte für eine Liste von URLs und Werten zu starten. Um die API zu nutzen, benötigen Sie einen einmaligen API Key den Sie auf der Einstellungsseite Ihres Kontos finden können.
Sie können auf die API Funktionalität einfach über einen HTTP POST oder GET Request zugreifen. Die Response ist JSON-formatted.
API URL
Die Request URL für alle API Calls ist: https://app.linkresearchtools.com/toolkit/api.php
Der LinkResearchTools API ist nur für interne Kundenanwendungen entworfen und erlaubt ausdrücklich keinen Wiederverkauf (wie eine Integration von Daten in öffentlich verfügbare Anwendungen) jeglicher Daten, die von LinkResearchTools gestellt werden. Für alle Wiederverkaufslizenzen, kontaktieren Sie uns bitte. Wir stellen Ihnen gerne Daten für Ihre Anwendung zur Verfügung.
Einen Bulk URL Analyzer (URL) Report starten
Um einen Report zu starten, senden Sie bitte einen Request mit in dieser Sektion beschrieben Daten zu der API URL.
| Feld | Wert | Kommentar |
|---|---|---|
api_key |
Ihr API Key | Überprüfen Sie Ihre Accounteinstellungen für Ihren persönlichen API Key. |
action |
start_report |
|
urls[] |
Liste der Input ULRs | Zum Beispiel: urls[0]=...&urls[1]=...&urls[2]=... |
url_boost |
URL Boost | Erlaubt Ihnen das Maximum der Anzahl der URLs zu vervielfachen. Nimmt Werte von 1 -5. |
values[] |
Liste von Wertenamen | Sie können sogar eine List von verfügbaren Wertenamen über den API Key abrufen. |
tool |
JUICE |
Das Tool das Sie benutzen wollen. Dieses Feld ist freiwillig und vorgegeben von JUICE. |
title |
Report Titel | Freiwillig: Wenn nicht vorgegeben, wird der API automatisch einen Titel erstellen. |
project |
Projekt Name | Freiwillig: Wenn nicht vorgegeben, wird das Project zum Default Project. |
Response Objekt
Das Response Objekt ist ein Objekt mit folgenden Feldern.
| Feld | Wert | Kommentar |
|---|---|---|
status |
Der Request Status Code | Error Codes können hier gefunden werden. |
message |
Eine beschreibende Status Nachricht | |
report |
Ein Objekt mit Report Informationen | Diese wird nur gesetzte wenn der API Call erfolgreich war. |
report_id |
Die ID des Reports | Sie benötigen diese ID, um die Report-Daten anzufordern. |
title |
Der Titel des Reports | |
urls |
Die URLs für die der Report gestartet wurde. | |
value_names |
Der Wert für den der Report gestartet wurde. | |
tool |
Das Tool |
Abruf der Report Daten
Um Report-Daten zu erhalten, senden Sie bitte einen Request mit in dieser Sektion beschrieben Daten zu der API URL.
Request
| Feld | Wert | Kommentar |
|---|---|---|
api_key |
Ihr API Key | Überprüfen Sie Ihre Accounteinstellungen für Ihren persönlichen API Key. |
action |
get_data |
|
report_id |
Die ID des Reports | Sie erhielten diese ID beim Starten eines Reports. |
data_sections |
Anreihung der Daten-Sektionen die abgerufen werden | Unten sehen Sie eine Liste von Daten-Sektionen für jedes Tool. Wenn nicht anders eingestellt, werden alle verfügbaren Daten-Sektionen abgerufen. |
page |
Die Seite, die Sie abrufen möchten | Wenn Sie mehr als 25 eingehende URLs in Ihrem Report haben, müssen Sie womöglich Daten in verschiedenen Schüben erhalten. Automatisch wird die erste Seite angezeigt. |
per_page |
Anzahl der Daten Reihen pro Seite | Dieser Parameter definiert wie viele Daten Reihen (eingehende URLs + Kennzahlen) pro Seite angezeigt werden. Es ist normalerweise eine gute Idee nicht mehr als 1000 Ergebnisse in einem Schub, sondern lieber einige kleine Requests zu laden. Default-Wert ist 25. |
Response
Die Response ist ein Objekt mit folgenden Feldern.
| Feld | Wert | Kommentar |
|---|---|---|
status |
Der Request Status Code | Error Codes können hier gefunden werden. |
message |
Eine beschreibende Status Nachricht | |
report |
Ein Objekt mit Report Informationen | Diese wird nur gesetzte wenn der API Call erfolgreich war. |
report_id |
Die ID des Reports | Sie benötigen diese ID um die Report Daten anzufordern. |
title |
Der Titel des Reports | |
urls |
Die URL(s), für die der Report gestartet wurde. | |
value_names |
Der Wert für den der Report gestartet wurde. | |
tool |
Das Tool | |
status |
Der Status des Reports | Basierend auf dem Status des Reports gibt es zusätzliche Felder. |
progress |
Der Fortschritt des Reports | Nur vorhanden wenn status In Progress ist (Liste der Report Status Werte). |
overall |
Die Gesamtanzahl der Jobs | Der Fortschritt des Reports in Prozent 100 * done/overall. |
done |
Die Anzahl der erledigten Jobs | |
pages |
Der Fortschritt des Reports | Nur vorhanden wenn status Done, Done with errors oder Terminated ist (Liste mit Report Status Werten). |
columns |
Anreihung von Spaltentitel | |
data |
Anreihung von Reihen mit Spaltenwerten |
Zusätzlich sind in den Report Objekten auch returned Daten-Sektionen. Jede Daten-Sektion ist ein Objekt mit columns und data Attributen. Wahlweiße können dort auch rows Attribute sein. Die columns und rows Attribute sind Felder mit Spalten und Zeilenköpfe der Daten. Die data Attribute sind Anreihungen von Reihen mit Werten, die mit Spalten/Reihen verbunden sind. Das innere Feld hält den Wert für eine Reihe.
Report Status Werte
Das Status Feld kann folgende Werte haben
| Wert | Kommentar |
|---|---|
Queued |
Report wartet auf Bearbeitung. |
In Progress |
Report wird gerade bearbeitet. |
Done |
Report ist beendet. |
Done with errors |
Report ist beendet aber es sind massive Fehler aufgetreten. |
Broken |
Report ist aus einem Grund kaputt. |
Empty |
Report ist fertig, aber leer (passiert wenn BLP, SSPT etc. Reporte ohne input Werte zurückkommen). |
Suspended |
Report wurde unterbrochen. Das passiert wenn Sie keine Credits mehr haben oder Ihr Abonnement ausgelaufen ist. |
removed |
Report wurde gelöscht. |
Terminated |
Report wurde beendet. Die Daten, die bis jetzt gecrwalt wurden, sind verfügbar. |
Abruf einer Liste von SEO Metriken (Werte Namen)
Ein Request zu der API URL mit zur Verfügung gestellten api_key, dem tool und den action=list_value_names Parametern, gibt ein json decodiertes Objekt mit dem Attribut value_nameszurück. Der Wert dieser Attribute ist eine Anreihung von verfügbaren Wertenamen als Objektbezeichnungen (mit Attributen name und title).
Nebenbei bemerkt: Intern nennen wir unsere SEO Metriken „Wertenamen“, deswegen gibt es die Unterscheidung zwischen API Dokumentation und dem Toolkit.
Abruf einer Liste von Reporten
Ein Request zu der API URL mit zur Verfügung gestellten api_key und den action=list_reports Parametern, gibt ein json decodiertes Objekt mit dem Attribut reports zurück, das eine Liste von Objekten ist die einen Report beschreiben, der von dem API gestartet wurde. Die Report Beschreibung besteht aus den Attributen report_id, date, title und url_count.
API Fehler Codes
| Code | Beschreibung |
|---|---|
| 100 | API Call erfolgreich |
| 200 | Interner API Fehler |
| 201 | NutzerIn hat keinen API Key |
| 202 | Kein API Key zur Verfügung gestellt oder falscher API Key |
| 203 | Falscher Tool Name |
| 204 | Falsche Wertenamen zur Verfügung gestellt |
| 205 | Keine gültige(n) URL(s) zur Verfügung gestellt |
| 206 | Nicht genügen Credits, um einen Report zu starten |
| 207 | Es konnte kein Report erstellt werden |
| 208 | Falsche Report ID |
| 209 | Nicht unterstütze Aktion |
| 210 | Falscher Account-Typ |
| 211 | Account wurde von API blockiert |
| 212 | Es wurden keine Reporte für den Account gefunden |
Herunterladen eines Beispiel Scripts
Wir haben eine Test Implementation in PHP und Ruby (mit und ohne CURL) vorbereitet, das Ihnen helfen sollte schnell zu coden.
Sollten Sie Probleme oder Fragen haben, kontaktieren Sie uns bitte über unser Feedback Formular!
Fragen oder Feedback?
Uns ist bewusst, dass es anfänglich ein wenig komplex wirkt, aber wir hoffen, dass die Beispiele hilfreich sind.
Wir würden uns freuen, zu hören wie Sie unsere API nutzen oder planen zu nutzen.