v1Ressourcen/AEO/getVerfolgte AEO-Prompts einer Website auflisten
Verfolgte AEO-Prompts einer Website auflisten
Liefert die für eine Website-Entität verfolgten Prompts und das, was die nächste Prüfung misst: Anzahl aktiver und pausierter Prompts, die Limits, die Set-Revision für eine Änderung, einen ungefähren Aufwand pro Prüfung und den Prüfzeitplan. Nur lesend: Es wird nie eine Prüfung gestartet und es werden keine Credits verbraucht. Prompt-Tracking gibt es nur für Website-Entitäten — ein physischer Standort, den Sie sehen können, liefert 422 entity_type_not_supported — und es setzt die Funktion für Website-Entitäten in Ihrer Agentur voraus (sonst 403 feature_disabled). Das Token handelt als die Person, die es ausgestellt hat, in dieser Agentur: Deren Zugriff auf die AEO-Seite und deren Kundensichtbarkeit gelten, ein auf Kunden beschränktes Token wird auf diese Kunden eingeengt, und eine Website außerhalb dieser Reichweite liefert 404. Lesen funktioniert weiter, wenn die Prompt-Verwaltung für die Agentur ausgeschaltet ist; canEdit ist dann false. Bis zur ersten gespeicherten Änderung zeigt eine Website ihre zwischengespeicherte bestehende Prompt-Liste als importierte Prompts (managed false, origin existing): Ihre Herkunft ist unbekannt, und sie müssen nicht dem entsprechen, was ein Bericht gemessen hat.
get
aeo:read/api/v1/aeo/promptsQuery-Parameter
locationIdstringerforderlich
Die Standort-ID der Website-Entität. Eine Website, die Sie nicht sehen können oder die nicht existiert, liefert 404; ein physischer Standort liefert 422 entity_type_not_supported.
statusstring (all | active | paused)optional
Als Listenfilter: all (Standard), active oder paused; jeder andere Wert listet alle. Bei einer Aktualisierung: active, um den Prompt fortzusetzen, paused, um ihn zu pausieren. Ein pausierter Prompt bleibt im Set, wird aber nicht geprüft.
Antwort
dataobjectoptional
locationIdstringoptional
Die Standort-ID der Website-Entität.
namestringoptional
Der Name der Website.
eligibleboolean (true)optional
Immer true: Nur eine Website-Entität hat eine Liste verfolgter Prompts.
canEditbooleanoptional
Ob die Person, die das Token ausgestellt hat, dieses Set gerade ändern kann: Sie hat die Berechtigung Manage AEO prompts, die Prompt-Verwaltung ist für die Agentur eingeschaltet, und die frühere Prompt-Liste muss nicht abgeglichen werden.
managedbooleanoptional
false, solange die Website noch ihre zwischengespeicherte bestehende Prompt-Liste verwendet (als importierte Prompts unbekannter Herkunft angezeigt); true ab der ersten gespeicherten Änderung.
revisionintegeroptional
Die Revision des Sets, die jede gespeicherte Änderung erhöht. Senden Sie sie als expectedRevision oder bei DELETE in If-Match.
maxActiveintegeroptional
Die maximale Anzahl gleichzeitig aktiver Prompts (16).
maxLengthintegeroptional
Die maximale Länge eines Prompts in Zeichen (500).
countsobjectoptional
Anzahl aktiver und pausierter Prompts.
activeintegeroptional
pausedintegeroptional
itemsarray of objectoptional
Die Prompts in der Reihenfolge des Sets, gefiltert nach dem Parameter status.
idstringoptional
Eindeutige Kennung des Prompts.
textstringoptional
Der Wortlaut des Prompts. In einer Prüfung oder einem Verlaufseintrag der Wortlaut, den diese Prüfung gemessen hat.
normalizedTextstringoptional
Der Wortlaut getrimmt, mit zusammengefassten Leerzeichen und in Kleinbuchstaben: der Schlüssel zur Erkennung von Duplikaten.
wordingVersionintegeroptional
Die Version des Wortlauts: 1 bei der Erstellung, nach jeder Änderung des Wortlauts um eins höher. Senden Sie sie als expectedWordingVersion zurück.
statusstring (active | paused)optional
active (wird von der nächsten Prüfung gemessen) oder paused (bleibt erhalten, wird aber nicht geprüft).
originstring (existing | custom | generated | integration)optional
Herkunft des Prompts: existing (aus der früheren Prompt-Liste der Website importiert, Herkunft unbekannt), custom (in der App hinzugefügt), generated oder integration (über die API oder MCP hinzugefügt).
createdViastring (ui | api | mcp | import)optional
Wie der Prompt erstellt wurde: ui, api, mcp oder import.
createdByUserIdstringoptional
Die Person, die den Prompt erstellt hat, oder null, wenn unbekannt (importierte Prompts).
updatedByUserIdstringoptional
Die Person, die den Prompt zuletzt geändert hat, oder null, wenn unbekannt.
positionintegeroptional
Die Stelle des Prompts in der Reihenfolge des Sets.
createdAtstringoptional
Wann der Prompt erstellt wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann der Prompt zuletzt geändert wurde, als ISO-8601-Zeitstempel.
deletedAtstringoptional
Wann der Prompt entfernt wurde, oder null. Entfernte Prompts werden nicht aufgeführt, bleiben aber in den Prüfungen, die sie erfasst haben.
latestobjectoptional
Das neueste verwertbare Ergebnis für den aktuellen Wortlaut, aus einer abgeschlossenen Prüfung mit complete, partial oder failed oder aus einem nachweislich übereinstimmenden importierten Alt-Wortlaut: state checked mit at, measured und expected. Eine Prüfung mit held bleibt im Verlauf und aktualisiert es nicht. Sonst state not_checked, auch direkt nach einer Bearbeitung.
statestring (not_checked | checked)optional
atstringoptional
Wann diese Prüfung abgeschlossen wurde, als ISO-8601-Zeitstempel.
measuredintegeroptional
Wie viele Engines eine verwertbare Antwort zu diesem Wortlaut gaben.
expectedintegeroptional
Wie viele Engines für diese Prüfung ausgewählt waren.
editedbooleanoptional
Ob sich der Wortlaut seit der Erstellung des Prompts geändert hat.
workloadobjectoptional
Ungefähr, was eine Prüfung der aktiven Prompts umfasst. Das Lesen kostet nichts, und das Speichern von Prompts verbraucht keine Credits.
activePromptsintegeroptional
Aktive Prompts, die die nächste Prüfung messen würde.
enginesarray of stringoptional
Die KI-Engines, die eine Prüfung abfragt.
answerChecksintegeroptional
Aktive Prompts × Engines: die Antworten, die eine Prüfung anfordert. Eine Anzahl, keine Credits.
estimatedCreditsnumberoptional
Ungefähre Credits für eine Prüfung der aktiven Prompts, nach den Credit-Sätzen Ihrer Agentur. null, wenn der Satz unbekannt ist oder mehr als 16 Prompts aktiv sind — unbekannt, nicht 0. Eine Schätzung, keine Abbuchung.
creditsPerPromptnumberoptional
Ungefähre Credits pro Prompt über alle Engines, oder null, wenn unbekannt.
approximateboolean (true)optional
Immer true: Die Aufwandswerte sind Schätzungen.
scheduleobjectoptional
Der aktuelle AEO-Prüfzeitplan der Website. Änderungen an Prompts ändern ihn nicht.
frequencystring (weekly | monthly | quarterly | never)optional
Wie oft Prüfungen laufen: weekly, monthly, quarterly oder never.
nextRunAtstringoptional
Wann die nächste geplante Prüfung fällig ist, als ISO-8601-Zeitstempel, oder null, wenn die Häufigkeit never ist oder die Prüfungen für diese Website noch nicht begonnen haben.
activatedbooleanoptional
Ob die Prüfungen für diese Website begonnen haben (eine erste Prüfung wurde gestartet oder es gibt einen Bericht). Das Speichern von Prompts startet sie nicht.
checkInFlightbooleanoptional
Ob gerade eine Prüfung für diese Website eingereiht ist, läuft oder angehalten ist. Diese Prüfung behält die erfassten Prompts; Änderungen gelten ab der nächsten.
listChangedSinceReportbooleanoptional
Ob sich die aktiven Prompts von denen unterscheiden, die der aktuelle Bericht gemessen hat, sodass der Bericht die aktuelle Liste noch nicht widerspiegelt.
needsReconciliationbooleanoptional
Ob die frühere Prompt-Liste der Website fehlerhafte oder doppelte Einträge hat. Bis der Support sie abgleicht, liefern Änderungen 409 legacy_prompts_need_reconciliation.
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.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
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/aeo/prompts
Ihr API-Schlüssel
locationId *
status
{}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.
- What Is an AEO API?An AEO API measures how AI answer engines like ChatGPT, Gemini and Perplexity describe and recommend a business, and tracks that visibility over time.
- 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.
- 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 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.
- How to Track AI and AEO Visibility ProgrammaticallyMeasure how ChatGPT, Gemini and Perplexity describe and recommend a business through an API, enqueue reports, poll for results and roll up a portfolio.