Die einzige Link-Audit-Software, die Du brauchst. | LRT in English | Kontakt +43 720 116 440+1 866 347-3660+44 800 011 9736+31 85 888 1541+353 76 680 1480+1 877 736-7787

API Dokumentation

Inhaltsverzeichnis


API Grundlagen

Der LinkResearchTools API erlaubt Ihnen JUICE Reporte für eine Liste von URLs und Werten zu starten. Um den 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.

Die Request URL für alle API Calls ist: http://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 JUICE Report starten

Um einen Report zu starten, senden Sie bitte einen Request mit in dieser Sektion beschrieben Daten zu der API URL.

FeldWertKommentar
api_keyIhr API KeyÜberprüfen Sie Ihre Accounteinstellungen für Ihren persönlichen API Key.
actionstart_report 
urls[]Liste der Input ULRsZum Beispiel: urls[0]=...&urls[1]=...&urls[2]=...
url_boostURL BoostErlaubt Ihnen das Maximum der Anzahl der URLs zu vervielfachen. Nimmt Werte von 1 -5.
values[]Liste von WertenamenSie können sogar eine List von verfügbaren Wertenamen über den API Key abrufen.
toolJUICEDas Tool das Sie benutzen wollen. Dieses Feld ist freiwillig und vorgegeben von JUICE.
titleReport TitelFreiwillig: Wenn nicht vorgegeben, wird der API automatisch einen Titel erstellen.
projectProjekt NameFreiwillig: Wenn nicht vorgegeben, wird das Project zum Default Project.

Response Objekt

Das Response Objekt ist ein Objekt mit folgenden Feldern.

FeldWertKommentar
statusDer Request Status CodeError Codes können hier gefunden werden.
messageEine beschreibende Status Nachricht 
reportEin Objekt mit Report InformationenDiese wird nur gesetzte wenn der API Call erfolgreich war.
       report_idDie ID des ReportsSie benötigen diese ID, um die Report-Daten anzufordern.
       titleDer Titel des Reports 
       urlsDie URLs für die der Report gestartet wurde. 
       value_namesDer Wert für den der Report gestartet wurde. 
       toolDas 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

FeldWertKommentar
api_keyIhr API KeyÜberprüfen Sie Ihre Accounteinstellungen für Ihren persönlichen API Key.
actionget_data 
report_idDie ID des ReportsSie erhielten diese ID beim Starten eines Reports.
data_sectionsAnreihung der Daten-Sektionen die abgerufen werdenUnten sehen Sie eine Liste von Daten-Sektionen für jedes Tool. Wenn nicht anders eingestellt, werden alle verfügbaren Daten-Sektionen abgerufen.
pageDie Seite, die Sie abrufen möchtenWenn 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_pageAnzahl der Daten Reihen pro SeiteDieser 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.

FeldWertKommentar
statusDer Request Status CodeError Codes können hier gefunden werden.
messageEine beschreibende Status Nachricht 
reportEin Objekt mit Report InformationenDiese wird nur gesetzte wenn der API Call erfolgreich war.
       report_idDie ID des ReportsSie benötigen diese ID um die Report Daten anzufordern.
       titleDer Titel des Reports 
       urlsDie URL(s), für die der Report gestartet wurde. 
       value_namesDer Wert für den der Report gestartet wurde. 
       toolDas Tool 
       statusDer Status des ReportsBasierend auf dem Status des Reports gibt es zusätzliche Felder.
       progressDer Fortschritt des ReportsNur vorhanden wenn status In Progress ist (Liste der Report Status Werte).
         overallDie Gesamtanzahl der JobsDer Fortschritt des Reports in Prozent 100 * done/overall.
         doneDie Anzahl der erledigten Jobs
   pagesDer Fortschritt des ReportsNur vorhanden wenn status Done, Done with errors oder Terminated ist (Liste mit Report Status Werten).
         columnsAnreihung von Spaltentitel 
         dataAnreihung 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

WertKommentar
QueuedReport wartet auf Bearbeitung.
In ProgressReport wird gerade bearbeitet.
DoneReport ist beendet.
Done with errorsReport ist beendet aber es sind massive Fehler aufgetreten.
BrokenReport ist aus einem Grund kaputt.
EmptyReport ist fertig, aber leer (passiert wenn BLP, SSPT etc. Reporte ohne input Werte zurückkommen).
SuspendedReport wurde unterbrochen. Das passiert wenn Sie keine Credits mehr haben oder Ihr Abonnement ausgelaufen ist.
removedReport wurde gelöscht.
TerminatedReport 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.


Error Codes

CodeBeschreibung
100API Call erfolgreich
200Interner API Fehler
201NutzerIn hat keinen API Key
202Kein API Key zur Verfügung gestellt oder falscher API Key
203Falscher Tool Name
204Falsche Wertenamen zur Verfügung gestellt
205Keine gültige(n) URL(s) zur Verfügung gestellt
206Nicht genügen Credits, um einen Report zu starten
207Es konnte kein Report erstellt werden
208Falsche Report ID
209Nicht unterstütze Aktion
210Falscher Account-Typ
211Account wurde von API blockiert
212Es 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!

Download API Beispiele


Fragen oder Feedback?

1. Uns ist bewusst, dass es anfänglich ein wenig komplex wirkt.
2. Daran wird permanent gearbeitet und wir freuen uns auf Ihr Feedback!
3. Wir würden uns freuen, zu hören wie Sie unsere API nutzen.

Sollten Sie Fragen oder Anmerkungen haben oder uns nur mitteilen wollen wie Sie den API verwenden, würden wir uns freuen von Ihnen zu hören – bitte kontaktieren Sie uns über unser Feedback Formular.