Top.Mail.Ru

Сайты

Получить все

GET https://serpmax.ru/api/websites/
curl --request GET \
--url 'https://serpmax.ru/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробнее Описание
search Необязательно Строка Строка поискового запроса.
search_by Необязательно Строка По какому полю выполняется поиск. Допустимые значения: host.
datetime_field Необязательно Строка Допустимые значения: datetime, last_datetime, last_audit_datetime
datetime_start Необязательно Строка Фильтровать результаты начиная с этой даты и времени. Формат: Y-m-d H:i:s.
datetime_end Необязательно Строка Фильтровать результаты до этой даты и времени. Формат: Y-m-d H:i:s.
order_by Необязательно Строка По какому полю сортировать результаты. Допустимые значения: website_id, datetime, last_datetime, last_audit_datetime, host, score, total_audits, total_archived_audits, total_issues.
order_type Необязательно Строка Направление сортировки результатов. Допустимые значения: ASC — по возрастанию, DESC — по убыванию.
page Необязательно Целое число Номер страницы, с которой нужно получить результаты. По умолчанию: 1.
results_per_page Необязательно Целое число Сколько результатов выводить на страницу. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию: 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "domain_id": 0,
            "scheme": "https",
            "host": "example.com",
            "score": 100,
            "total_audits": 10,
            "total_archived_audits": 5,
            "total_issues": 0,
            "major_issues": 0,
            "moderate_issues": 0,
            "minor_issues": 0,
            "last_audit_datetime": "2024-11-10 02:26:19",
            "datetime": "2026-06-08 19:44:44",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://serpmax.ru/api/websites?page=1",
        "last": "https://serpmax.ru/api/websites?page=1",
        "next": null,
        "prev": null,
        "self": "https://serpmax.ru/api/websites?page=1"
    }
}

Получить один

GET https://serpmax.ru/api/websites/{website_id}
curl --request GET \
--url 'https://serpmax.ru/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "domain_id": 0,
        "scheme": "https",
        "host": "example.com",
        "score": 100,
        "total_audits": 10,
        "total_archived_audits": 5,
        "total_issues": 0,
        "major_issues": 0,
        "moderate_issues": 0,
        "minor_issues": 0,
        "last_audit_datetime": "2024-11-10 02:26:19",
        "datetime": "2026-06-08 19:44:44",
    }
}

Обновить

POST https://serpmax.ru/api/websites/{website_id}
Параметры Подробнее Описание
domain_id Необязательно Целое число -
password Необязательно Строка -
is_public Необязательно Логический (Boolean) -
audit_check_interval Необязательно Целое число Допустимые значения: {empty_string},21600, 43200, 86400, 259200, 432000, 864000, 1296000, 2592000 (секунд(ы))
notifications Необязательно Массив ID обработчиков уведомлений
notifications_mode Необязательно Строка Допустимые значения: always, changes (секунд(ы))
directory_is_enabled_and_verified Необязательно Логический (Boolean) -
sitemap_url Необязательно Строка -
website_sitemap_check_interval Необязательно Целое число Допустимые значения: {empty_string},21600, 43200, 86400, 259200, 432000, 864000, 1296000, 2592000 (секунд(ы))
curl --request POST \
--url 'https://serpmax.ru/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_public=1' \
--form 'password=example' \
{
    "data": {
        "id": 1
    }
}

Удалить

DELETE https://serpmax.ru/api/websites/{website_id}
curl --request DELETE \
--url 'https://serpmax.ru/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \