Docs
Pesquisar na documentação...⌘K

Pontuações de Saúde do Projeto

API + MCP
GET/v3/site-audit/projects

As solicitações para este endpoint são gratuitas e não consomem unidades de API.

Parâmetros de consulta

project_urlstring

Filtra projetos pela URL de destino (ignora o protocolo e a barra final).

project_namestring

Filtra projetos por nome.

datestring

Um carimbo de data/hora no formato YYYY-MM-DDThh:mm:ss que especifica a data do Rastreamento para obter as métricas. Se omitido, o padrão é o Rastreamento mais recente disponível. Para rastreamentos agendados, retornamos dados do último Rastreamento concluído antes do carimbo de data/hora especificado. Para rastreamentos de auditoria Always-on, retornamos os dados conforme a data e hora fornecidas. Se o componente de hora for omitido, o padrão é 00:00:00. O carimbo de data/hora é interpretado em UTC.

project_idinteger

O identificador exclusivo do projeto. Você pode encontrá-lo na URL do seu projeto do Site Audit no Ahrefs: https://app.ahrefs.com/site-audit/#project_id#

outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

healthscoresarray<object>
project_idstring

O identificador exclusivo do Projeto.

project_namestring

O nome do projeto.

target_protocolstring

O protocolo do destino. Valores possíveis: both, http, https.

target_urlstring

A URL do destino do projeto.

target_modestring

O escopo do alvo. Valores possíveis: exact, prefix, domain, subdomains.

datestring or null

A data e hora de término do último Rastreamento concluído, no fuso horário GMT.

statusstring or null

O status do Rastreamento concluído mais recente. Valores possíveis: Completed, Stopped, Error, In_progress.

health_scoreinteger or null

Reflete a proporção de URLs internas do seu site que não têm erros, com base no último Rastreamento concluído. Exclui Rastreamentos que estão iniciando, em andamento, sendo finalizados ou que foram ignorados.

urls_with_errorsinteger or null

Número de URLs internas com erros

urls_with_warningsinteger or null

Número de URLs internas com avisos

urls_with_noticesinteger or null

Número de URLs internas com observações

totalinteger or null

Número total de URLs internas rastreadas