v1Ressourcen/SEO/getFelder für lokale Keywords abrufen
Felder für lokale Keywords abrufen
Gibt die benutzerdefinierten Felder der lokalen Keywords eines Standorts zurück, archivierte Felder eingeschlossen, mit ihren Werten, alles in einer Antwort.
get
seo:read/api/v1/seo/keywords/fieldsQuery-Parameter
locationIdstringerforderlich
Der Standort, dessen Felder für lokale Keywords zurückgegeben werden. Erforderlich.
Antwort
dataobjectoptional
Die benutzerdefinierten Felder und gespeicherten Werte für einen Datensatztyp in einem Bereich.
agencyIdstringoptional
Die ID Ihres Workspace (Ihrer Agentur).
userIdstringoptional
Die ID der Person, als die die Anfrage ausgeführt wird: der Ersteller des API-Schlüssels.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)optional
Die Art von Datensatz, zu der der Satz gehört: local_keyword, task, aeo_prompt, post, series, review_campaign oder listing.
scopeIdstringoptional
Die ID des Bereichs, dem der Satz gehört: der Standort oder Kunde, die Website bei AEO-Prompts oder der Workspace bei Aufgaben.
canManagebooleanoptional
Ob der Ersteller des Schlüssels in diesem Satz Felder erstellen, umbenennen und archivieren darf.
fieldsarray of objectoptional
Alle Felder des Satzes, archivierte eingeschlossen, in Anzeigereihenfolge.
idstringoptional
Die ID des Felds. Verwenden Sie sie als fieldId beim Setzen von Werten.
labelstringoptional
Der Anzeigename des Felds. Namen sind innerhalb eines Feldsatzes eindeutig, archivierte Felder eingeschlossen.
typestring (text | number | date | single_select | multi_select)optional
Der Feldtyp: text, number, date, single_select oder multi_select.
optionsarray of objectoptional
Die Auswahlmöglichkeiten eines single_select- oder multi_select-Felds. Bei anderen Typen leer.
idstringerforderlich
Die ID der Option. Auswahlwerte speichern diese ID, nicht das Label.
labelstringerforderlich
Der Anzeigename der Option, innerhalb des Felds eindeutig.
archivedbooleanoptional
True, wenn die Option stillgelegt ist: Werte, die sie bereits enthalten, behalten sie, aber sie kann nicht neu ausgewählt werden.
versionintegeroptional
Die aktuelle Version des Felds, die bei jeder Änderung steigt. Übergeben Sie sie als expectedVersion in field_update.
orderintegeroptional
Die Position des Felds im Satz, beginnend bei 0.
archivedAtstringoptional
Zeitpunkt der Archivierung des Felds oder null, solange es aktiv ist. Archivierte Felder werden weiterhin zurückgegeben.
valuesobjectoptional
Gespeicherte Werte, nach recordId und dann nach fieldId geordnet, jeweils mit value und version. Nur Datensätze ohne gespeicherte Werte fehlen; ein gelöschter Wert bleibt als null mit seiner gespeicherten Version erhalten.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
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.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Befolgen Sie die Hinweise zur Wiederholung für diesen Vorgang.
get/api/v1/seo/keywords/fields
Ihr API-Schlüssel
locationId *
{}Anleitungen, die diese Ressource verwenden
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.
- How to Track Local Rankings with an APITrack local search rankings on a geo grid through an API, add keywords, read the grid and trend, and compare against competitors and citation coverage.
- How to Monitor Local SEO Across Multiple LocationsMonitor local SEO across hundreds of locations through rollup endpoints, with rank and AI visibility per location and the weakest surfaced first.
- Fetch Local Keyword Rankings via APITrack local search rankings on a geo grid with the Synup API, add keywords for a location, and read the rank trend once the background scan lands.