v1Recursos/AEO/getListar as verificações de prompts de um site

Listar as verificações de prompts de um site

Retorna as verificações de prompts do site, da mais recente para a mais antiga, sem suas respostas: quando cada uma foi capturada e concluída, seu status, a revisão do conjunto e os mecanismos que mediu, e quantas respostas foram aproveitáveis. Um relatório arquivado de antes de os prompts serem gerenciados aparece com source legacy_report. Somente leitura: listar nunca inicia uma verificação.

get/api/v1/aeo/prompts/checks
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.
limitintegeropcional
Quantas verificações retornar, da mais recente para a mais antiga: de 1 a 100, padrão 24. Valores fora desse intervalo são ajustados ao limite.
Resposta
dataarray of objectopcional
idstringopcional
Identificador único da verificação.
capturedAtstringopcional
Quando a verificação capturou os prompts que mede, como carimbo de data/hora ISO 8601.
settledAtstringopcional
Quando a verificação terminou, ou null enquanto ainda está em andamento.
statusstring (captured | running | complete | partial | failed | held)opcional
captured, running, complete, partial (faltam algumas respostas), failed ou held (o resultado é desconhecido e precisa de conciliação; nem concluída nem com falha). Uma verificação failed ou held pode ter parado antes de solicitar todas as respostas esperadas.
promptSetRevisionintegeropcional
A revisão do conjunto que a verificação capturou.
promptCountintegeropcional
Quantos prompts a verificação capturou.
enginesarray of stringopcional
Os mecanismos de IA selecionados para esta verificação.
measuredintegeropcional
Quantas respostas foram aproveitáveis.
expectedintegeropcional
Quantas respostas eram esperadas dos prompts e mecanismos capturados.
publicationstring (published | superseded)opcional
published quando os resultados da verificação se tornaram o relatório do site, superseded quando um resultado mais recente já havia tomado o seu lugar, ou null.
sourcestring (legacy_report)opcional
legacy_report em um relatório arquivado de antes de os prompts serem gerenciados; ausente em uma verificação de prompts.
legacyEnginesarray of objectopcional
Somente relatórios legados arquivados: a pontuação de cada mecanismo e suas contagens de prompts medidos e esperados como o relatório os guardou. Um valor que ele não guardou é null, nunca zero.
enginestringopcional
scorenumberopcional
measuredPromptsintegeropcional
expectedPromptsintegeropcional
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/checks
Sua chave de API
locationId *
limit
{}

Guias que usam este recurso