Synup
Crear clave
v1Recursos/AEO/getListar los prompts de AEO seguidos de un sitio web

Listar los prompts de AEO seguidos de un sitio web

Devuelve los prompts seguidos de una entidad de sitio web y lo que medirá la próxima comprobación: cantidad de prompts activos y en pausa, los límites, la revisión del conjunto que debes enviar con un cambio, una carga aproximada por comprobación y la programación de comprobaciones. Solo lectura: nunca inicia una comprobación ni consume créditos. El seguimiento de prompts es solo para entidades de sitio web — una ubicación física que puedes ver devuelve 422 entity_type_not_supported — y requiere la función de entidades de sitio web en tu agencia (si no, 403 feature_disabled). El token actúa como la persona que lo emitió, en esta agencia: se aplican su acceso a la página de AEO y su visibilidad de clientes, un token restringido a clientes se limita a esos clientes, y un sitio web fuera de ese alcance devuelve 404. La lectura sigue funcionando cuando la gestión de prompts está desactivada para la agencia; canEdit es entonces false. Hasta el primer cambio guardado, un sitio web muestra su lista de prompts existente en caché como prompts importados (managed false, origin existing): su procedencia es desconocida y puede que no coincidan con lo que midió algún informe.

get/api/v1/aeo/prompts
aeo:read
Parámetros de consulta
locationIdstringobligatorio
El id de ubicación de la entidad de sitio web. Un sitio web que no puedes ver, o que no existe, devuelve 404; una ubicación física devuelve 422 entity_type_not_supported.
statusstring (all | active | paused)opcional
Como filtro de la lista: all (por defecto), active o paused; cualquier otro valor lista todos. En una actualización: active para reanudar el prompt, paused para pausarlo. Un prompt en pausa sigue en el conjunto, pero queda fuera de las comprobaciones.
Respuesta
dataobjectopcional
locationIdstringopcional
El id de ubicación de la entidad de sitio web.
namestringopcional
El nombre del sitio web.
eligibleboolean (true)opcional
Siempre true: solo una entidad de sitio web tiene una lista de prompts seguidos.
canEditbooleanopcional
Si la persona que emitió el token puede cambiar este conjunto ahora: tiene el permiso Manage AEO prompts, la gestión de prompts está activada para la agencia y la lista de prompts anterior no necesita conciliación.
managedbooleanopcional
false mientras el sitio web siga usando su lista de prompts existente en caché (mostrados como prompts importados de procedencia desconocida); true desde el primer cambio guardado.
revisionintegeropcional
La revisión del conjunto, que aumenta con cada cambio guardado. Envíala como expectedRevision, o en If-Match en DELETE.
maxActiveintegeropcional
El máximo de prompts activos a la vez (16).
maxLengthintegeropcional
La longitud máxima de un prompt, en caracteres (500).
countsobjectopcional
Cantidad de prompts activos y en pausa.
activeintegeropcional
pausedintegeropcional
itemsarray of objectopcional
Los prompts en el orden del conjunto, filtrados por el parámetro status.
idstringopcional
Identificador único del prompt.
textstringopcional
La redacción del prompt. En una comprobación o una entrada del historial, la redacción que midió esa comprobación.
normalizedTextstringopcional
La redacción recortada, con los espacios condensados y en minúsculas: la clave para detectar duplicados.
wordingVersionintegeropcional
La versión de la redacción: 1 al crearse, una más tras cada cambio de redacción. Devuélvela como expectedWordingVersion.
statusstring (active | paused)opcional
active (lo mide la próxima comprobación) o paused (se conserva, pero queda fuera de las comprobaciones).
originstring (existing | custom | generated | integration)opcional
De dónde viene el prompt: existing (importado de la lista de prompts anterior del sitio web, procedencia desconocida), custom (añadido en la app), generated o integration (añadido mediante la API o MCP).
createdViastring (ui | api | mcp | import)opcional
Cómo se creó el prompt: ui, api, mcp o import.
createdByUserIdstringopcional
La persona que creó el prompt, o null si se desconoce (prompts importados).
updatedByUserIdstringopcional
La persona que cambió el prompt por última vez, o null si se desconoce.
positionintegeropcional
El lugar del prompt en el orden del conjunto.
createdAtstringopcional
Cuándo se creó el prompt, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se cambió el prompt por última vez, como marca de tiempo ISO 8601.
deletedAtstringopcional
Cuándo se eliminó el prompt, o null. Los prompts eliminados no se listan, pero siguen en las comprobaciones que los capturaron.
latestobjectopcional
El resultado utilizable más reciente de la redacción actual, de una comprobación cerrada complete, partial o failed, o de una redacción heredada importada que coincide de forma demostrable: state checked con at, measured y expected. Una comprobación held queda en el historial y no lo actualiza. Si no, state not_checked, también justo después de una edición.
statestring (not_checked | checked)opcional
atstringopcional
Cuándo se cerró esa comprobación, como marca de tiempo ISO 8601.
measuredintegeropcional
Cuántos motores dieron una respuesta utilizable para esta redacción.
expectedintegeropcional
Cuántos motores se seleccionaron para esa comprobación.
editedbooleanopcional
Si la redacción cambió desde que se creó el prompt.
workloadobjectopcional
Aproximadamente lo que implica una comprobación de los prompts activos. Leerlo no cuesta nada, y guardar prompts no consume créditos.
activePromptsintegeropcional
Prompts activos que mediría la próxima comprobación.
enginesarray of stringopcional
Los motores de IA que consulta una comprobación.
answerChecksintegeropcional
Prompts activos × motores: las respuestas que solicita una comprobación. Un recuento, no créditos.
estimatedCreditsnumberopcional
Créditos aproximados de una comprobación de los prompts activos, según las tarifas de créditos de tu agencia. null cuando la tarifa se desconoce o hay más de 16 prompts activos — desconocido, no cero. Una estimación, no un cargo.
creditsPerPromptnumberopcional
Créditos aproximados por prompt en todos los motores, o null si se desconocen.
approximateboolean (true)opcional
Siempre true: las cifras de carga son estimaciones.
scheduleobjectopcional
La programación actual de comprobaciones de AEO del sitio web. Cambiar prompts no la modifica.
frequencystring (weekly | monthly | quarterly | never)opcional
Con qué frecuencia se ejecutan las comprobaciones: weekly, monthly, quarterly o never.
nextRunAtstringopcional
Cuándo toca la próxima comprobación programada, como marca de tiempo ISO 8601, o null cuando la frecuencia es never o las comprobaciones aún no han empezado para este sitio web.
activatedbooleanopcional
Si las comprobaciones ya empezaron para este sitio web (se inició una primera comprobación o existe un informe). Guardar prompts no las inicia.
checkInFlightbooleanopcional
Si hay ahora una comprobación en cola, en ejecución o retenida para este sitio web. Esa comprobación conserva los prompts que capturó; los cambios se aplican desde la siguiente.
listChangedSinceReportbooleanopcional
Si los prompts activos difieren de los que midió el informe actual, de modo que el informe aún no refleja la lista actual.
needsReconciliationbooleanopcional
Si la lista de prompts anterior del sitio web tiene entradas mal formadas o duplicadas. Hasta que soporte la concilie, los cambios devuelven 409 legacy_prompts_need_reconciliation.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
503El servicio no está disponible temporalmente. Siga las indicaciones de reintento para esta operación.
get/api/v1/aeo/prompts
Su clave de API
locationId *
status
{}

Guías que usan este recurso