Schnittstelle
API-Referenz
Version 1, JSON über HTTPS. Jeder Aufruf braucht einen Schlüssel; diese Liste entspricht dem OpenAPI-Dokument.
Status: live
Anmeldung
Sende den Schlüssel als Kopfzeile Authorization: Bearer sd_… (alternativ X-Api-Key). Schlüssel legst du in deinem Konto unter „Berichte“ an.
Basis-Adresse: https://app.serpdash.dev/api/v1 · openapi.json
Aufrufe
| Methode | Pfad | Was er tut | Plan |
|---|---|---|---|
GET |
/api/v1/usage |
Limits und Nutzung: Einheiten und Antworten dieses Monats, Einheiten und Zeilen je Antwort deines Plans, Beginn des nächsten Monats. Kostet keine Einheit. | ab Pro |
GET |
/api/v1/sites |
Die Websites deiner Organisation. | ab Pro |
GET |
/api/v1/sites/{domain}/keywords |
Die Stichwörter, denen eine Website folgt. | ab Pro |
GET |
/api/v1/sites/{domain}/keywords.csv |
Dasselbe als CSV. | ab Pro |
GET |
/api/v1/sites/{domain}/ranks |
Aktuelle Positionen einer bestätigten Website: Platz in den Suchergebnissen, Änderung in 7 Tagen, Search-Console-Zahlen der letzten 28 Tage, jeweils mit Lesedatum. | ab Pro |
GET |
/api/v1/sites/{domain}/ranks.csv |
Dasselbe als CSV, mit Quelle und Tag in jeder Zeile. | ab Pro |
GET |
/api/v1/sites/{domain}/audit |
Das letzte Site-Audit einer bestätigten Website: Zähler und die wichtigsten Befunde. | ab Pro |
GET |
/api/v1/sites/{domain}/report |
Die Berichtszahlen der letzten vollen Woche oder des letzten vollen Monats.?periodweekly (Standard) oder monthly |
ab Pro |
GET |
/api/v1/sites/{domain}/report.csv |
Derselbe Bericht als CSV.?periodweekly (Standard) oder monthly |
ab Pro |
GET |
/api/v1/sites/{domain}/ai-visibility |
KI-Sichtbarkeit in einem Objekt: verfolgte Prompts, wie viele KI-Antworten die Website nennen, Prüfungen des Monats. Antworttexte werden nicht gespeichert. | ab Pro |
GET |
/api/v1/sites/{domain}/ai-visibility/prompts |
Die Prompts mit der letzten Prüfung je KI-Dienst. | ab Pro |
GET |
/api/v1/sites/{domain}/ai-visibility/prompts.csv |
Dasselbe als CSV. | ab Pro |
GET |
/api/v1/sites/{domain}/ai-visibility/gaps |
Seiten, die in KI-Antworten genannt werden, wo Wettbewerber vorkommen und die Website nicht. | ab Pro |
GET |
/api/v1/sites/{domain}/links |
Links auf die Website: die eigene Zählung (Bing Webmaster) und das gespeicherte Profil des Anbieters, je mit Quelle und Tag. Startet keinen bezahlten Abruf. | ab Pro |
GET |
/api/v1/sites/{domain}/links/referring-domains |
Die verweisenden Domains des gespeicherten Anbieterprofils. | ab Pro |
GET |
/api/v1/sites/{domain}/links/referring-domains.csv |
Dasselbe als CSV. | ab Pro |
GET |
/api/v1/sites/{domain}/links/opportunities |
Kaputte Links zum Zurückholen und Domains, die auf Wettbewerber verlinken, aber nicht auf dich: eine Liste für einen Menschen, nichts wird verschickt. | ab Pro |
GET |
/api/v1/sites/{domain}/competitors |
Die Wettbewerber deiner Liste und die Vorschläge aus gemeinsamen Ergebnissen. | ab Pro |
GET |
/api/v1/sites/{domain}/competitors/places |
Die Plätze der Wettbewerber für deine Stichwörter in den letzten Tagen, aus den ohnehin gemachten Abrufen.?daysZeitfenster in Tagen: 7, 28 (Standard) oder 90 |
ab Pro |
GET |
/api/v1/sites/{domain}/insights |
Search-Console-Summen des Zeitfensters mit dem Tag des Abrufs.?daysZeitfenster in Tagen: 7, 28 (Standard) oder 90 |
ab Pro |
GET |
/api/v1/sites/{domain}/insights/queries |
Die Suchanfragen der Website aus der Search Console, meiste Klicks zuerst.?daysZeitfenster in Tagen: 7, 28 (Standard) oder 90 |
ab Pro |
GET |
/api/v1/sites/{domain}/insights/queries.csv |
Dasselbe als CSV.?daysZeitfenster in Tagen: 7, 28 (Standard) oder 90 |
ab Pro |
GET |
/api/v1/sites/{domain}/easy-wins |
Suchanfragen knapp hinter Seite eins mit Schwierigkeit, wenn bekannt.?maxDifficultynur Suchanfragen bis zu dieser Schwierigkeit |
ab Pro |
GET |
/api/v1/sites/{domain}/export.md |
Alles zu einer Website als ein Markdown-Dokument für ein Modell („für KI exportieren“); jeder Abschnitt nennt Quelle und Tag.?partsranks, audit, search, ai, links, mit Komma (Standard alle)?langde oder en (Standard en) |
ab Pro |
GET |
/api/v1/examples/{name} |
Feste Beispielantwort zum Ausprobieren ohne Plan und ohne Schlüssel (sites, ranks, audit, report, ai-visibility, links, usage). Im Text und in der Kopfzeile X-SerpDash-Example als Beispiel gekennzeichnet, nie echte Daten. | ab Pro |
POST |
/api/v1/sites/{domain}/keywords |
Ein Stichwort verfolgen; Body {"keyword": "…"}. Das Stichwort-Limit des Plans gilt. | Team, Schlüssel mit Schreibrecht |
DELETE |
/api/v1/sites/{domain}/keywords |
Ein Stichwort nicht mehr verfolgen.?keyworddas Stichwort (Pflicht) |
Team, Schlüssel mit Schreibrecht |
{domain} ist die Domain einer bestätigten Website deiner Organisation, zum Beispiel example.com.
Fehlercodes
| Code | Bedeutung |
|---|---|
401 | Der Schlüssel fehlt, hat die falsche Form oder ist widerrufen. |
403 | Der Plan hat keine Schnittstelle (Free, Solo) oder der Schlüssel darf nicht schreiben. |
404 | Die Website gibt es nicht oder sie ist noch nicht bestätigt. |
409 | Das Stichwort-Limit des Plans ist erreicht. |
429 | Das Limit je Schlüssel und Minute ist erreicht (Pro 60, Team 300), oder die Einheiten des Monats sind aufgebraucht (Fehler units-exhausted, geht mit dem Monat weiter); die Kopfzeile Retry-After sagt, wann es weitergeht. |
Beispiel
curl -H "Authorization: Bearer sd_…" \
"https://app.serpdash.dev/api/v1/sites/example.com/ranks"
curl -X POST -H "Authorization: Bearer sd_…" \
-H "Content-Type: application/json" \
-d '{"keyword": "kaffeemaschine test"}' \
"https://app.serpdash.dev/api/v1/sites/example.com/keywords"
Jede Zahl der Antwort trägt ihr Lesedatum. Eine Website, die nicht bestätigt ist, antwortet 404.