SEO-проекты · token

`reports` Отчёты: список, статус и файлы

Группа работает с отчётами, которые заказаны в разделе «Отчёты» проекта: отдаёт их список и статус, ссылки на готовые файлы Word и PDF и ставит файл Word на формирование. Сами отчёты через API не заказываются. Список и статус — синхронно, файл Word — асинхронно: повторяйте report/file/get, пока не появится ссылка.

Адрес: /projects/api/v1/reports/get, /projects/api/v1/report/<метод>
Режим: синхронный; файл Word — асинхронный, опросом
Лимиты: не тратит

Список отчётов

GET /projects/api/v1/reports/get

Отчёты проекта от новых к старым.

Параметры query

token string обязательный

Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
project_id int обязательный

ID проекта. Виден в адресе страницы проекта и в ответе projects/get.
limit int

Сколько последних отчётов отдать. 0 или без параметра — все.

По умолчанию 0

Ответ

result[].id string

ID отчёта — его передают в report_id.
result[].status string

done — отчёт сформирован, in progress — ещё нет.
result[].date date

Когда отчёт заказан.
result[].domain string

Домен проекта.
result[].from, result[].to date

Период отчёта.
result[].compare_from, result[].compare_to date

Период для сравнения — только у отчётов со сравнением.

GET /projects/api/v1/reports/get

curl -G 'https://tools.pixelplus.ru/projects/api/v1/reports/get' \
  --data-urlencode 'token=ВАШ_КЛЮЧ' \
  --data-urlencode 'project_id=7002' \
  --data-urlencode 'limit=10'

<?php
$url = 'https://tools.pixelplus.ru/projects/api/v1/reports/get?' . http_build_query([
    'token' => 'ВАШ_КЛЮЧ',
    'project_id' => 7002,
    'limit' => 10,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/projects/api/v1/reports/get",
    params={
        "token": "ВАШ_КЛЮЧ",
        "project_id": 7002,
        "limit": 10,
    },
    timeout=60,
)
print(response.json())

project_id обязательный ID проекта. Виден в адресе страницы проекта и в ответе projects/get limit Сколько последних отчётов отдать

Запрос настоящий — выполнится с вашим ключом

Пример ответа

{
    "status": "ok",
    "code": 1,
    "msg": "success",
    "result": [
        {
            "id": "3f9a2c7e51b04d8e9a6c1f20b7d4e815",
            "status": "done",
            "date": "2026-10-01",
            "domain": "example.ru",
            "from": "2026-09-01",
            "to": "2026-09-30",
            "compare_from": "2026-08-01",
            "compare_to": "2026-08-31"
        },
        {
            "id": "b81e04c96d2f4a7f8c35e9d1a0f6b273",
            "status": "in progress",
            "date": "2026-10-06",
            "domain": "example.ru",
            "from": "2026-09-06",
            "to": "2026-10-06"
        }
    ]
}

Отчёт и ссылки на файлы

GET /projects/api/v1/report/get

Статус одного отчёта и ссылки на его файлы, если они уже сформированы. Файл PDF формируется из интерфейса; файл Word можно заказать через report/file/get.

Параметры query

token string обязательный

Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
project_id int обязательный

ID проекта. Виден в адресе страницы проекта и в ответе projects/get.
report_id string обязательный

ID отчёта — поле id из reports/get.

Ответ

result.status string

done — отчёт сформирован, in progress — ещё нет.
result.date date

Когда отчёт заказан.
result.domain string

Домен проекта.
result.from, result.to date

Период отчёта.
result.compare_from, result.compare_to date

Период для сравнения — только у отчётов со сравнением.
result.files.docx, result.files.pdf object

status — true, если файл есть; link — ссылка на скачивание или пустая строка.

GET /projects/api/v1/report/get

curl -G 'https://tools.pixelplus.ru/projects/api/v1/report/get' \
  --data-urlencode 'token=ВАШ_КЛЮЧ' \
  --data-urlencode 'project_id=7002' \
  --data-urlencode 'report_id=3f9a2c7e51b04d8e9a6c1f20b7d4e815'

<?php
$url = 'https://tools.pixelplus.ru/projects/api/v1/report/get?' . http_build_query([
    'token' => 'ВАШ_КЛЮЧ',
    'project_id' => 7002,
    'report_id' => '3f9a2c7e51b04d8e9a6c1f20b7d4e815',
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/projects/api/v1/report/get",
    params={
        "token": "ВАШ_КЛЮЧ",
        "project_id": 7002,
        "report_id": "3f9a2c7e51b04d8e9a6c1f20b7d4e815",
    },
    timeout=60,
)
print(response.json())

project_id обязательный ID проекта. Виден в адресе страницы проекта и в ответе projects/get report_id обязательный ID отчёта — поле id из reports/get

Запрос настоящий — выполнится с вашим ключом

Пример ответа

{
    "status": "ok",
    "code": 1,
    "msg": "success",
    "result": {
        "status": "done",
        "date": "2026-10-01",
        "domain": "example.ru",
        "from": "2026-09-01",
        "to": "2026-09-30",
        "files": {
            "docx": {
                "status": true,
                "link": "https://tools.pixelplus.ru/projects/shared/download_reports_docx/3f9a2c7e51b04d8e9a6c1f20b7d4e815"
            },
            "pdf": {
                "status": false,
                "link": ""
            }
        }
    }
}

Файл отчёта в Word

GET /projects/api/v1/report/file/get

Если файл Word уже есть — отдаёт ссылку. Если нет — ставит его на формирование и отвечает in progress; повторный вызов, пока файл готовится, второй задачи не создаёт. Опрашивайте метод раз в несколько секунд, пока status не станет done. Метод отдаёт ссылку, а не сам файл.

Параметры query

token string обязательный

Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
project_id int обязательный

ID проекта. Виден в адресе страницы проекта и в ответе projects/get.
report_id string обязательный

ID отчёта — поле id из reports/get.

Ответ

result.files.docx.status string

done или in progress. Обратите внимание: здесь строка, а в report/get — true/false.
result.files.docx.link string

Ссылка на скачивание; пустая, пока файл не готов.

GET /projects/api/v1/report/file/get

curl -G 'https://tools.pixelplus.ru/projects/api/v1/report/file/get' \
  --data-urlencode 'token=ВАШ_КЛЮЧ' \
  --data-urlencode 'project_id=7002' \
  --data-urlencode 'report_id=3f9a2c7e51b04d8e9a6c1f20b7d4e815'

<?php
$url = 'https://tools.pixelplus.ru/projects/api/v1/report/file/get?' . http_build_query([
    'token' => 'ВАШ_КЛЮЧ',
    'project_id' => 7002,
    'report_id' => '3f9a2c7e51b04d8e9a6c1f20b7d4e815',
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/projects/api/v1/report/file/get",
    params={
        "token": "ВАШ_КЛЮЧ",
        "project_id": 7002,
        "report_id": "3f9a2c7e51b04d8e9a6c1f20b7d4e815",
    },
    timeout=60,
)
print(response.json())

project_id обязательный ID проекта. Виден в адресе страницы проекта и в ответе projects/get report_id обязательный ID отчёта — поле id из reports/get

Запрос настоящий — выполнится с вашим ключом

Пример ответа

{
    "status": "ok",
    "code": 1,
    "msg": "success",
    "result": {
        "files": {
            "docx": {
                "status": "in progress",
                "link": ""
            }
        }
    }
}

Ошибки

Код	Сообщение	Когда
`50`	`access error`	Токен не передан, не найден, или у его владельца нет доступа к проекту.
`51`	`wrong project id`	Проекта с таким `project_id` нет.
`52`	`wrong request data`	`report/get`, `report/file/get`: не передан `report_id` или у проекта нет такого отчёта. Причина — в `result.error`.

Ответ с ошибкой

{
    "status": "error",
    "code": 52,
    "msg": "wrong request data",
    "result": {
        "error": "Report 3f9a2c7e51b04d8e9a6c1f20b7d4e815 for project 7002 was not found"
    }
}

Ссылки на файлы ведут на общую ссылку отчёта (/projects/shared/…) и открываются без авторизации — не публикуйте их там, где их могут увидеть посторонние.

Статус in progress в списке означает любое состояние, кроме «готов», — в том числе отчёт, сформировать который не удалось. Если статус не меняется долго, проверьте отчёт в интерфейсе.

Методы принимают GET и POST, но параметры читаются из query-строки. HTTP-код всегда 200: успех и ошибка различаются полями status и code.

reports Отчёты: список, статус и файлы

Список отчётов

Параметры query

Ответ

Отчёт и ссылки на файлы

Параметры query

Ответ

Файл отчёта в Word

Параметры query

Ответ

Ошибки

`reports` Отчёты: список, статус и файлы