Synup
Criar chave
v1Recursos/AEO/getListar os prompts de AEO monitorados de um site

Listar os prompts de AEO monitorados de um site

Retorna os prompts monitorados de uma entidade de site e o que a próxima verificação vai medir: quantidade de prompts ativos e pausados, os limites, a revisão do conjunto a enviar com uma alteração, uma carga aproximada por verificação e o agendamento das verificações. Somente leitura: nunca inicia uma verificação nem consome créditos. O monitoramento de prompts é apenas para entidades de site — um local físico que você pode ver retorna 422 entity_type_not_supported — e exige o recurso de entidades de site na sua agência (caso contrário, 403 feature_disabled). O token age como a pessoa que o emitiu, nesta agência: valem o acesso dela à página de AEO e a visibilidade de clientes, um token restrito a clientes fica limitado a esses clientes, e um site fora desse alcance retorna 404. A leitura continua funcionando quando o gerenciamento de prompts está desativado para a agência; canEdit fica então false. Até a primeira alteração salva, um site mostra sua lista de prompts existente em cache como prompts importados (managed false, origin existing): a procedência deles é desconhecida, e eles podem não corresponder ao que algum relatório mediu.

get/api/v1/aeo/prompts
aeo:read
Parâmetros de consulta
locationIdstringobrigatório
O id de local da entidade de site. Um site que você não pode ver, ou que não existe, retorna 404; um local físico retorna 422 entity_type_not_supported.
statusstring (all | active | paused)opcional
Como filtro da lista: all (padrão), active ou paused; qualquer outro valor lista todos. Em uma atualização: active para retomar o prompt, paused para pausá-lo. Um prompt pausado continua no conjunto, mas fica fora das verificações.
Resposta
dataobjectopcional
locationIdstringopcional
O id de local da entidade de site.
namestringopcional
O nome do site.
eligibleboolean (true)opcional
Sempre true: só uma entidade de site tem uma lista de prompts monitorados.
canEditbooleanopcional
Se a pessoa que emitiu o token pode alterar este conjunto agora: ela tem a permissão Manage AEO prompts, o gerenciamento de prompts está ativado para a agência e a lista de prompts anterior não precisa de conciliação.
managedbooleanopcional
false enquanto o site ainda usa sua lista de prompts existente em cache (mostrados como prompts importados de procedência desconhecida); true a partir da primeira alteração salva.
revisionintegeropcional
A revisão do conjunto, que aumenta a cada alteração salva. Envie-a como expectedRevision, ou em If-Match no DELETE.
maxActiveintegeropcional
O máximo de prompts ativos ao mesmo tempo (16).
maxLengthintegeropcional
O comprimento máximo de um prompt, em caracteres (500).
countsobjectopcional
Quantidade de prompts ativos e pausados.
activeintegeropcional
pausedintegeropcional
itemsarray of objectopcional
Os prompts na ordem do conjunto, filtrados pelo parâmetro status.
idstringopcional
Identificador único do prompt.
textstringopcional
O texto do prompt. Em uma verificação ou entrada de histórico, o texto que essa verificação mediu.
normalizedTextstringopcional
O texto aparado, com espaços condensados e em minúsculas: a chave usada para detectar duplicados.
wordingVersionintegeropcional
A versão do texto: 1 ao ser criado, uma a mais após cada alteração de texto. Envie-a de volta como expectedWordingVersion.
statusstring (active | paused)opcional
active (medido pela próxima verificação) ou paused (mantido, mas fora das verificações).
originstring (existing | custom | generated | integration)opcional
De onde veio o prompt: existing (importado da lista de prompts anterior do site, procedência desconhecida), custom (adicionado no app), generated ou integration (adicionado pela API ou MCP).
createdViastring (ui | api | mcp | import)opcional
Como o prompt foi criado: ui, api, mcp ou import.
createdByUserIdstringopcional
A pessoa que criou o prompt, ou null quando desconhecida (prompts importados).
updatedByUserIdstringopcional
A pessoa que alterou o prompt por último, ou null quando desconhecida.
positionintegeropcional
A posição do prompt na ordem do conjunto.
createdAtstringopcional
Quando o prompt foi criado, como carimbo de data/hora ISO 8601.
updatedAtstringopcional
Quando o prompt foi alterado por último, como carimbo de data/hora ISO 8601.
deletedAtstringopcional
Quando o prompt foi removido, ou null. Prompts removidos não são listados, mas continuam nas verificações que os capturaram.
latestobjectopcional
O resultado aproveitável mais recente do texto atual, de uma verificação concluída complete, partial ou failed, ou de um texto legado importado com correspondência comprovada: state checked com at, measured e expected. Uma verificação held fica no histórico e não o atualiza. Caso contrário, state not_checked, inclusive logo após uma edição.
statestring (not_checked | checked)opcional
atstringopcional
Quando essa verificação foi concluída, como carimbo de data/hora ISO 8601.
measuredintegeropcional
Quantos mecanismos deram uma resposta aproveitável para este texto.
expectedintegeropcional
Quantos mecanismos foram selecionados para essa verificação.
editedbooleanopcional
Se o texto mudou desde que o prompt foi criado.
workloadobjectopcional
Aproximadamente o que uma verificação dos prompts ativos envolve. Ler isso não custa nada, e salvar prompts não consome créditos.
activePromptsintegeropcional
Prompts ativos que a próxima verificação mediria.
enginesarray of stringopcional
Os mecanismos de IA que uma verificação consulta.
answerChecksintegeropcional
Prompts ativos × mecanismos: as respostas que uma verificação solicita. Uma contagem, não créditos.
estimatedCreditsnumberopcional
Créditos aproximados de uma verificação dos prompts ativos, pelas tarifas de créditos da sua agência. null quando a tarifa é desconhecida ou há mais de 16 prompts ativos — desconhecido, não zero. Uma estimativa, não uma cobrança.
creditsPerPromptnumberopcional
Créditos aproximados por prompt em todos os mecanismos, ou null quando desconhecidos.
approximateboolean (true)opcional
Sempre true: os números de carga são estimativas.
scheduleobjectopcional
O agendamento atual de verificações de AEO do site. Alterar prompts não o muda.
frequencystring (weekly | monthly | quarterly | never)opcional
Com que frequência as verificações são executadas: weekly, monthly, quarterly ou never.
nextRunAtstringopcional
Quando vence a próxima verificação agendada, como carimbo de data/hora ISO 8601, ou null quando a frequência é never ou as verificações ainda não começaram para este site.
activatedbooleanopcional
Se as verificações já começaram para este site (uma primeira verificação foi iniciada ou existe um relatório). Salvar prompts não as inicia.
checkInFlightbooleanopcional
Se há agora uma verificação na fila, em execução ou retida para este site. Essa verificação mantém os prompts que capturou; as alterações valem a partir da próxima.
listChangedSinceReportbooleanopcional
Se os prompts ativos diferem dos que o relatório atual mediu, de modo que o relatório ainda não reflete a lista atual.
needsReconciliationbooleanopcional
Se a lista de prompts anterior do site tem entradas malformadas ou duplicadas. Até o suporte conciliá-la, as alterações retornam 409 legacy_prompts_need_reconciliation.
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Siga as orientações de nova tentativa para esta operação.
get/api/v1/aeo/prompts
Sua chave de API
locationId *
status
{}

Guias que usam este recurso