Relatórios GEO técnicos

Lance o pacote de relatórios GEO técnicos para um URL e, em seguida, liste, faça polling e obtenha cada relatório. Os relatórios são executados de forma assíncrona. A prontidão para agentes, por vezes designada de prontidão para IA, usa report_type=agent_readiness.

GET/technical_geo_reports

Lista um tipo de relatório Technical GEO de um projeto, do mais recente para o mais antigo. Utilize este endpoint para encontrar ids e estados de relatórios antes de obter um resultado completo.

Parâmetros:
  • project_idobrigatório
  • report_typeobrigatório: crawlability, schema, content_readiness, discoverability, site_structure, robots_txt, agent_readiness, llms_txt, ai_visibility
  • status
  • batch_id
  • page
  • per_pagemáximo 100

GET/technical_geo_reports/:id

Devolve o estado atual de um relatório. Enquanto está em execução, poll_after_seconds é 15. Um relatório concluído inclui result_data; um relatório que falhou inclui error_message. Um relatório llms.txt concluído devolve também result_data.content_version, o valor que uma edição deve enviar de volta, e metadata.output_language_code, bem como manually_edited_at e os ficheiros originais gerados depois de os ficheiros terem sido editados na aplicação, através da API ou do MCP. Um output_language_code com o valor null significa que os ficheiros llms.txt mantêm o idioma do próprio site.

  • Parâmetros: project_id (obrigatório), report_type (obrigatório) e o id do relatório no URL.

POST/technical_geo_reports

Inicia o pacote completo de análises de GEO técnico, com nove relatórios, para um URL e um país. A opção «Executar todos os relatórios» só inicia o pacote quando ainda restam pelo menos nove unidades diárias. Cada relatório criado com sucesso consome uma unidade; os relatórios que não sejam criados não consomem unidades. A alocação diária varia consoante a conta. Cada relatório é executado numa tarefa em segundo plano. A resposta inclui report_ids, com os IDs associados aos respetivos tipos de relatório, e indica ao cliente que deve consultar periodicamente cada ID através do endpoint de detalhe do relatório. Requer uma chave de API com o âmbito read_write.

Corpo (JSON):
  • project_idobrigatório
  • urlobrigatório
  • country_codeopcional, por predefinição usa o país do projeto
  • output_language_codeopcional, idioma ISO 639-1 em que são escritos os ficheiros llms.txt; por predefinição, usa-se o idioma do projeto; auto mantém o idioma do próprio site e é devolvido como auto; os restantes relatórios do pacote não são afetados

PATCH/technical_geo_reports/:id/content

Substitui os ficheiros llms.txt e llms-full.txt de um relatório llms.txt concluído sem voltar a gerá-lo. edits contém o texto integral novo de um ou de ambos os ficheiros, e content_version tem de corresponder a result_data.content_version do relatório tal como foi lido da última vez. Se o relatório tiver sido alterado entretanto, a edição é recusada com ERR_INVALID_PARAM; volte a lê-lo e envie-a de novo. Um ficheiro igual ao texto guardado é ignorado, e a primeira edição preserva os ficheiros gerados para que possam ser repostos. changed_files indica os ficheiros alterados e fica vazio quando nada mudou.

  • Corpo (JSON): project_id (obrigatório), report_type (obrigatório, tem de ser llms_txt), content_version (obrigatório, string), edits (obrigatório, objeto com llms_txt e/ou llms_full_txt, cada um com o ficheiro completo novo, não vazio e com, no máximo, 200 000 caracteres) e o id do relatório no URL. Requer uma chave de API com âmbito de escrita e, para membros da equipa, permissão de criação em GEO Optimization.

POST/technical_geo_reports/:id/revert_content

Descarta todas as edições manuais de um relatório llms.txt e repõe os ficheiros gerados, guardados na primeira edição. manually_edited_at, original_llms_txt_content e original_llms_full_txt_content voltam a null, e content_version é alterado. Devolve ERR_INVALID_PARAM quando o relatório não tem edições manuais.

  • Corpo (JSON): project_id (obrigatório), report_type (obrigatório, tem de ser llms_txt) e o id do relatório no URL. Requer uma chave de API com âmbito de escrita e, para membros da equipa, permissão de criação em GEO Optimization.