Synup
Schlüssel erstellen
v1Ressourcen/AEO/getPrompt-Prüfungen einer Website auflisten

Prompt-Prüfungen einer Website auflisten

Liefert die Prompt-Prüfungen der Website, neueste zuerst, ohne ihre Antworten: wann jede erfasst und abgeschlossen wurde, ihren Status, die gemessene Set-Revision und Engines und wie viele Antworten verwertbar waren. Ein archivierter Bericht aus der Zeit vor der Prompt-Verwaltung erscheint mit source legacy_report. Nur lesend: Das Auflisten startet nie eine Prüfung.

get/api/v1/aeo/prompts/checks
aeo:read
Query-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.
limitintegeroptional
Wie viele Prüfungen zurückgegeben werden, neueste zuerst: 1 bis 100, Standard 24. Werte außerhalb dieses Bereichs werden auf die Grenze gesetzt.
Antwort
dataarray of objectoptional
idstringoptional
Eindeutige Kennung der Prüfung.
capturedAtstringoptional
Wann die Prüfung die gemessenen Prompts erfasst hat, als ISO-8601-Zeitstempel.
settledAtstringoptional
Wann die Prüfung abgeschlossen wurde, oder null, solange sie läuft.
statusstring (captured | running | complete | partial | failed | held)optional
captured, running, complete, partial (einige Antworten fehlen), failed oder held (das Ergebnis ist unbekannt und muss abgeglichen werden; weder abgeschlossen noch fehlgeschlagen). Eine Prüfung mit failed oder held kann angehalten haben, bevor jede erwartete Antwort angefordert wurde.
promptSetRevisionintegeroptional
Die Set-Revision, die die Prüfung erfasst hat.
promptCountintegeroptional
Wie viele Prompts die Prüfung erfasst hat.
enginesarray of stringoptional
Die für diese Prüfung ausgewählten KI-Engines.
measuredintegeroptional
Wie viele Antworten verwertbar waren.
expectedintegeroptional
Wie viele Antworten aus den erfassten Prompts und Engines erwartet wurden.
publicationstring (published | superseded)optional
published, wenn die Ergebnisse der Prüfung zum Bericht der Website wurden, superseded, wenn ein neueres Ergebnis bereits deren Platz eingenommen hatte, oder null.
sourcestring (legacy_report)optional
legacy_report bei einem archivierten Bericht aus der Zeit vor der Prompt-Verwaltung; fehlt bei einer Prompt-Prüfung.
legacyEnginesarray of objectoptional
Nur archivierte Altberichte: Score jeder Engine sowie gemessene und erwartete Prompt-Anzahl, so wie der Bericht sie gespeichert hat. Ein nicht gespeicherter Wert ist null, nie 0.
enginestringoptional
scorenumberoptional
measuredPromptsintegeroptional
expectedPromptsintegeroptional
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/checks
Ihr API-Schlüssel
locationId *
limit
{}

Anleitungen, die diese Ressource verwenden