Оцінки здоров’я проєктів

API + MCP

GET/v3/site-audit/projects

Запити до цього ендпойнта безкоштовні та не витрачають жодних одиниць API.

Параметри запиту

project_urlstring

Фільтрує проєкти за цільовим URL (ігнорує протокол і кінцевий слеш).

project_namestring

Фільтрує проєкти за назвою.

datestring

Позначка часу у форматі YYYY-MM-DDThh:mm:ss, що вказує дату сканування, за якою потрібно отримати метрики. Якщо не вказано, за замовчуванням використовується найсвіжіше доступне сканування. Для запланованих сканувань ми повертаємо дані з останнього сканування, завершеного до вказаної позначки часу. Для сканувань аудиту Always-on ми повертаємо дані станом на вказані дату й час. Якщо компонент часу не вказано, за замовчуванням використовується 00:00:00. Позначка часу інтерпретується в UTC.

project_idinteger

Унікальний ідентифікатор проєкту. Його можна знайти в URL вашого проєкту Site Audit в Ahrefs: https://app.ahrefs.com/site-audit/#project_id#

outputstring

Формат виводу.

Дозволені значення:jsoncsvxmlphp

Відповіді

healthscoresarray<object>

project_idstring

Унікальний ідентифікатор проєкту.

project_namestring

Назва проєкту.

target_protocolstring

Протокол цільового ресурсу. Можливі значення: both, http, https.

target_urlstring

URL цільового ресурсу проєкту.

target_modestring

Область охоплення цільового ресурсу. Можливі значення: exact, prefix, domain, subdomains.

datestring or null

Дата й час завершення останнього завершеного сканування в часовому поясі GMT.

statusstring or null

Статус найсвіжішого завершеного сканування. Можливі значення: Completed, Stopped, Error, In_progress.

health_scoreinteger or null

Відображає частку внутрішніх URL-адрес на вашому сайті без помилок на основі останнього завершеного сканування. Не враховує сканування, що запускаються, тривають, завершуються або були пропущені.

urls_with_errorsinteger or null

Кількість внутрішніх URL-адрес із помилками

urls_with_warningsinteger or null

Кількість внутрішніх URL-адрес із попередженнями

urls_with_noticesinteger or null

Кількість внутрішніх URL-адрес із примітками

totalinteger or null

Кількість усіх проіндексованих внутрішніх URL-адрес