Synup
Schlüssel erstellen
v1Ressourcen/SEO/getStandortübergreifendes Ranking-Rollup abrufen

Standortübergreifendes Ranking-Rollup abrufen

Liefert eine zusammenfassende Zeile je Standort mit mindestens einem Ranking-Bericht, optional eingeschränkt auf einen Kunden und/oder Standort-Tags. Ein auf bestimmte Kunden beschränkter Schlüssel muss clientId übergeben.

get/api/v1/seo/rollup
seo:read
Query-Parameter
clientIdstringoptional
Ergebnisse auf einen Kunden beschränken. Ist Ihr Schlüssel auf bestimmte Kunden beschränkt, ist dies erforderlich.
tagsstringoptional
Kommagetrennte Liste von Standort-Tag-Namen. Nur Standorte mit mindestens einem dieser Tags werden einbezogen.
Antwort
dataobjectoptional
countnumberoptional
Anzahl der zurückgegebenen Zeilen.
rowsarray of objectoptional
Eine Zeile je Standort mit mindestens einem Ranking-Bericht.
idstringoptional
Eindeutige Kennung des Standorts.
locationNamestringoptional
Der Firmenname des Standorts.
citystringoptional
Stadt, oder null.
avgRanknumberoptional
Mittlerer durchschnittlicher Rang über die aktiven Keywords des Standorts, oder null.
top3Pctnumberoptional
Mittlerer Prozentsatz der Rasterpunkte in den Top 3 über die Keywords des Standorts, oder null.
top10Pctnumberoptional
Mittlerer Prozentsatz der Rasterpunkte in den Top 10 über die Keywords des Standorts, oder null.
bestKeywordobjectoptional
Das bestrankende Keyword des Standorts, oder null.
keywordstringoptional
avgRanknumberoptional
tagsarray of stringoptional
Die internen Tags des Standorts.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/seo/rollup
Ihr API-Schlüssel
clientId
tags
{
  "data": {
    "count": 2,
    "rows": [
      {
        "id": "cm_loc_1",
        "locationName": "Acme Dental — Downtown",
        "city": "Austin",
        "avgRank": 4.2,
        "top3Pct": 44,
        "top10Pct": 78,
        "bestKeyword": {
          "keyword": "dentist near me",
          "avgRank": 4.2
        },
        "tags": [
          "priority",
          "downtown"
        ]
      }
    ]
  }
}

Anleitungen, die diesen Endpunkt verwenden