Seobility API-Dokumentation
1. Einführung
1.1 Übersicht
Die Seobility SEO API bietet Dir Zugriff auf die Seobility SEO-Softwaretechnologie für das Crawling und die SEO-Analyse von Websites. Sie liefert Dir wertvolle Einblicke in den Zustand Deiner Website und die Suchmaschinenoptimierung sowie eine einfache Fehlerbehebung für eine gesamte Website.
Für eine einfache Integration der Technologie in Deine individuelle Umgebung ist die API als RESTful-Service aufgebaut und stellt Daten im JSON-Format bereit.
1.2 Single Page Check API
Der Single Page Check ist ein weiterer Teil der SEO API. Er umfasst den SEO Check und den Keyword Check, da beide nur eine bestimmte URL für die durchgeführte Analyse berücksichtigen. Nutze diesen Teil der API entweder zur Ergänzung der Site Audit API oder zur Durchführung (isolierter) Einzelseitenanalysen.
1.3 API-Creditsystem
Die Kosten sind für jede Methode entsprechend dokumentiert.
Credit-Pakete sind auf monatlicher Basis erhältlich. Für weitere Informationen und ein Angebot basierend auf Deinen individuellen Bedürfnissen kontaktieren Sie uns bitte hier
1.4 Support
Der Support für die API ist auf Englisch und Deutsch verfügbar.
Bei Fragen zur Seobility SEO API oder wenn Du ein Angebot basierend auf Deinen individuellen Anforderungen erhalten möchtest, kontaktieren Sie uns bitte hier
2. Site Audit API
Ersetzt durch neue API, bitte kontaktiere unser Support-Team.
3. Single Page Check API
3.1 SEO Check
seocheck - Crawlt eine URL und gibt eine Vielzahl von Informationen über die SEO-Optimierung dieser Seite zurück. Bitte beachten Sie, dass die URL live gecrawlt wird, weshalb die Antwortzeit variieren kann.
Credits: 100
Beispiel-Aufruf:
GET
https://api.seobility.net/en/resellerapi/seocheck?apikey={yourapikey}&url=https://www.wikipedia.org/
Anfrageparameter:
Feld | Type | Pflichtfeld | Erklärung |
|---|---|---|---|
url | string | ja | Ziel-URL |
Antwortparameter (JSON):
Feld
Typ
Erklärung
-
array
Antwort-Array
Parameter | Typ | Beschreibung |
|---|---|---|
success | boolean | Gibt an, ob die Anfrage erfolgreich war |
request | array | Die bereitgestellten Informationen zur Anfrage |
keyword | string | Das in der Anfrage angegebene Keyword |
searchengine | string | Die in der Anfrage angegebene Suchmaschine (z. B. Google.com, Google.de, Google.com.pk etc.) |
platform | string | Die in der Anfrage angegebene Zielplattform (1=desktop, 2=mobile) |
lat | int | Der Breitengrad des in der Anfrage angegebenen Standorts |
lon | int | Der Längengrad des in der Anfrage angegebenen Standorts |
city | string | Der Name des in der Anfrage angegebenen Standorts |
logbase | int | Die logarithmische Basis, die für diese Berechnung der TF*IDF-Bewertung verwendet wurde |
resultamount | int | Die Anzahl der für diese TF*IDF-Prüfung analysierten Top-SERP-Ergebnisse |
url | string | Die angegebene URL, die als Vergleichsbasis für die TF*IDF-Prüfung verwendet wurde |
text | string | Der angegebene Text, der als Berechnungsgrundlage für diese TF*IDF-Prüfung diente |
textlength | int | Die Textlänge, die als Berechnungsgrundlage für diese TF*IDF-Prüfung diente |
calltime | datetime | Zeitpunkt dieser Anfrage |
stats | array | Relevante Keywords und deren statistische Daten |
Index | array | Index des Statistik-Eintrags |
keyword | string | Keyword für die entsprechenden angehängten Werte |
avgtfidfused | int | Durchschnittlicher TF*IDF-Wert für alle Ergebnisse, die diesen Begriff enthalten |
avgtfidftotal | int | Durchschnittlicher TF*IDF-Wert für alle Ergebnisse |
occurrence | int | Die Anzahl der Vorkommen |
maxtfidf | int | Maximaler TF*IDF-Wert für diesen Begriff |
maxtf | int | Maximaler TF-Wert für diesen Begriff |
(...) | ||
results | array | Die Ergebnisse für die Anfrage |
Index | array | Index des Ergebnisses |
link | string | Ergebnis-URL laut Google SERP |
title | string | SERP-Titel |
description | string | Beschreibung des SERP-Titels |
rank | int | Rang in den SERPs (1-100) |
domain | string | Ergebnis-Domain |
tfidf | array | Liste der Keywords mit entsprechendem TF*IDF dieses Ergebnisses |
keyword | int | Das Keyword und sein entsprechender TF*IDF-Wert |
(...) | ||
loadtime | int | Zeit, die zum Laden des Ergebnisses benötigt wurde |
wordcount | int | Anzahl der Wörter im HTML des Ergebnisses |
crawlerror | boolean | Fehler beim Crawlen aufgetreten |
(...) | ||
termsuggestions | array | Term-Vorschläge |
more | array | Wörter, die häufiger verwendet werden sollten |
less | array | Wörter, die seltener verwendet werden sollten |
suggestedamount | array | Empfohlene optimale Häufigkeit/Spanne dieses Keywords im Text, basierend auf der aktuellen Textlänge. |
ok | array | Perfekt optimierte Wörter |
text | string | Der Text auf der Seite (nur relevant, wenn eine URL Teil der Anfrage war) |
3.2 Keyword Check
keywordcheck - Crawlt eine URL und liefert Informationen darüber, wie gut die Seite für das angegebene Keyword optimiert ist. Bitte beachten Sie, dass die URL live gecrawlt wird, weshalb die Antwortzeit variieren kann.
Credits: 20
Beispiel-Aufruf:
GET
https://api.seobility.net/en/resellerapi/keywordcheck?apikey={yourapikey}&url=https://www.wikipedia.org/&keyword=wiki
Request-Parameter:
Feld | Type | Pflichtfeld | Erklärung |
|---|---|---|---|
url | string | ja | Ziel-URL |
keyword | string | ja | Keyword, das überprüft werden soll |
Response-Parameter (JSON):
Feld | Type | Erklärung |
|---|---|---|
- | array | Alle Informationen zur Keyword-Optimierung der Seite |
4. TF*IDF Check API
4.1 TF*IDF-Check
tfidfcheck - Führt eine TF*IDF-Prüfung für ein bestimmtes Keyword durch. Mehrere Parameter ermöglichen individuelle und lokalisierte Analyseeinstellungen. Gibt die vollständigen TF*IDF-Analysedaten und einen ersten Satz von Term-Vorschlägen zurück. Bitte beachten Sie, dass eine erste tfidfcheck-Anfrage einen Moment dauert, da die Analyse Live-Daten aus mehreren Quellen erfordert. Aufeinanderfolgende Aktualisierungen einer Analyse mit unveränderten Parametern erfolgen ohne Verzögerung.
Credits: 175
Beispiel-Aufruf:
GET
https://api.seobility.net/en/resellerapi/tfidfcheck?apikey={yourapikey}&keyword=example&searchengine=google.com
Anfrage-Parameter:
Feld | Type | Pflichtfeld | Erklärung |
|---|---|---|---|
keyword | string | ja | Das Ziel-Keyword |
searchengine | string | ja | Die Ziel-Suchmaschine (z. B. Google.com, Google.de, Google.com.pk etc.) |
platform | int | nein | Die Ziel-Plattform (1=Desktop, 2=Mobil; Standard=1) |
city | string | nein | Der Name des Standorts für die Abfrage (erfordert lat und lon) |
lat | float | nein | Der Breitengrad des Standorts für die Abfrage (erfordert city und lon) |
lon | float | nein | Der Längengrad des Standorts für die Abfrage (erfordert city und lat) |
logbase | float | nein | Die logarithmische Basis für die Berechnung der TF*IDF-Bewertung (Standard = 1.05185); nur ändern, wenn Du weißt, was Du tust |
resultamount | int | nein | Die Anzahl der Top-SERP-Ergebnisse, die für die TF*IDF-Prüfung analysiert werden (Standard=10, möglich: 3, 7, 10, 15 oder 20) |
url | string | nein | Die URL mit dem zu optimierenden Text (verwenden Sie entweder url, text oder textlength) |
text | string | nein | Zu optimierender Text (verwenden Sie entweder url, text oder textlength) |
textlength | int | nein | Wortanzahl des Zieltextes (verwenden Sie entweder url, text oder textlength) |
textmode | string | nein | Text-Parsing-Modus. Verwenden Sie "singleword" für reine Ein-Wort-Keywords (Standard) oder "multiword" für die Unterstützung von Mehr-Wort-Keywords. |
Antwort-Parameter (JSON):
Feld | Typ | Erklärung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
- | array | Antwort-Array
|
5. Term Suggestion API
5.1 TF*IDF Term Suggestion
termsuggestion - Liefert Term-Vorschläge zur Optimierung eines Textes für ein bestimmtes Keyword, z. B. in einem Texteditor. Die zugrunde liegende Analyse basiert auf TF*IDF. Mehrere Parameter ermöglichen individuelle und lokalisierte Analyseeinstellungen. Bitte beachten Sie, dass eine erste termsuggestion-Anfrage einen Moment dauern kann, da die Analyse Live-Daten aus verschiedenen Quellen erfordert. Aufeinanderfolgende Aktualisierungen einer Analyse mit unveränderten Parametern erfolgen ohne Verzögerung.
Credits: 20
Beispiel-Aufruf:
GET
https://api.seobility.net/en/resellerapi/termsuggestion?apikey={yourapikey}&keyword=example&url=https://example.com&searchengine=google.com
Request-Parameter:
Feld | Typ | Pflichtfeld | Erklärung |
|---|---|---|---|
keyword | string | ja | Das Ziel-Keyword |
searchengine | string | ja | Die Ziel-Suchmaschine (z. B. Google.com, Google.de, Google.com.pk etc.) |
platform | int | nein | Die Ziel-Plattform (1=Desktop, 2=Mobile; Standard=1) |
city | string | nein | Der Name des Standorts für die Abfrage (erfordert lat und lon) |
lat | float | nein | Der Breitengrad des Standorts für die Abfrage (erfordert city und lon) |
lon | float | nein | Der Längengrad des Standorts für die Abfrage (erfordert city und lat) |
logbase | float | nein | Die logarithmische Basis für die Berechnung der TF*IDF-Bewertung (Standard = 1.05185); nur ändern, wenn Du weißt, was Du tust |
resultamount | int | nein | Die Anzahl der Top-SERP-Ergebnisse, die für die TF*IDF-Prüfung analysiert werden (Standard=10, Möglich: 3, 7, 10, 15 oder 20) |
url | string | ja | Die URL mit dem zu optimierenden Text (verwenden Sie entweder url oder text) |
text | string | ja | Zu optimierender Text (verwenden Sie entweder url oder text) |
Response-Parameter (JSON):
Feld | Typ | Erklärung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
- | array | Antwort-Array
|
6. Ranking-API
6.1 Ranking (Echtzeit)
ranking - Gibt die SERP-Rankings (SERP = Search Engine Result Pages) für einen bestimmten Suchbegriff oder ein Keyword zurück.Dies ist eine synchrone (direkte) API. Die durchschnittliche Antwortzeit beträgt 30 Sekunden.
Credits: 3
Beispiel-Aufruf:
GET
https://api.seobility.net/en/resellerapi/ranking?apikey={yourapikey}&keyword=example&searchengine=google.com
Anfrage-Parameter:
Feld | Typ | Pflichtfeld | Erklärung |
|---|---|---|---|
keyword | string | ja | Das Ziel-Keyword |
searchengine | string | ja | Die Domain der Ziel-Suchmaschine (z. B. Google.com oder Google.co.uk) |
platform | int | nein | Zielplattform (1=Desktop, 2=Mobile) (Standard: Desktop) |
city | string | nein | Name des Standorts für die Abfrage (erfordert city, lat und lon) |
lat | float | nein | Breitengrad der Abfrage (erfordert city, lat und lon) |
lon | float | nein | Längengrad der Abfrage (erfordert city, lat und lon) |
url | string | nein | URL, deren Position ermittelt werden soll |
Antwort-Parameter (JSON):
Feld | Typ | Erklärung |
|---|---|---|
success | boolean | Ob die Anfrage erfolgreich war |
request | object | Die bereitgestellten Anfrage-Informationen |
keyword | string | Das in der Anfrage angegebene Keyword |
searchengine | string | Die in der Anfrage angegebene Suchmaschine (z. B. Google.com, Google.de, Google.com.pk etc.) |
platform | string | Der Gerätetyp, z. B. MOBILE |
lat | int | Breitengrad für Google Maps |
lon | int | Längengrad für Google Maps |
city | string | Stadt für die Google Maps Lokalisierung |
targeturl | string | Als Ziel für die Ergebnisse angegebene URL |
calltime | datetime | Zeitpunkt der TF*IDF-Analyse |
targeturlresult | array | Ergebnisse der Ziel-URL; wird nur bereitgestellt, wenn die Ziel-URL in den Top-SERPs liegt |
rank | int | Das Ranking der Ziel-URL |
link | string | Link zur Ziel-URL |
description | string | Die Meta-Beschreibung der Ziel-URL |
title | string | Der Titel der Ziel-URL |
results | array | Die Ergebnisse für die Anfrage |
rank | int | Das Ranking der Seite |
link | string | Link zur Seite |
description | string | Die Meta-Beschreibung der Seite |
title | string | Der Titel der Seite |
domain | string | Die Domain der Seite |
7. Fehlerbehandlung
Wenn ein Fehler aufgetreten ist oder Du eine ungültige Anfrage gestellt hast, gibt die API eine Fehlermeldung zurück.
Das zurückgegebene JSON ist wie folgt strukturiert:
{
"error" : "{errormessage}"
}