REST API · JWT

`rest-project` REST API: позиции, группы и расход лимитов проекта

Данные одного SEO-проекта для пользователя, вошедшего через user/auth: позиции за период, запуск внеплановой проверки, группы запросов и URL, поисковые системы и графики сводки. Сюда же относится фактический расход лимитов по списку проектов. Методы синхронные, кроме сводки — она считается в фоне, её забирают в два шага.

Адрес: /api-rest/project/<метод>
Авторизация: JWT в заголовке token
Доступ: свои проекты и проекты с выданным доступом
Лимиты: тратит только positions/schedule

Позиции запросов за период

POST /api-rest/project/positions/get

Таблица позиций, как на вкладке «Позиции» проекта: запросы с частотой, релевантным URL и позициями в каждой поисковой системе, плюс видимость и апдейты Яндекса за период. Две формы: simple — первая и последняя проверка периода и разница, detail — позиция на каждую дату проверки.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.
table_type string

Форма ответа. По умолчанию — как выбрано в настройках проекта владельца.

simple
две даты и разница

detail
позиция на каждую дату
limit int

Запросов на странице.

По умолчанию 30
page int

Номер страницы.

По умолчанию 1
order string

Поле сортировки.

По умолчанию frequency
order_type int

Направление.

1
по возрастанию

2
по убыванию

По умолчанию 2
change string

Только изменившиеся за период.

all
все

up
выросли

down
упали

По умолчанию all
position_details string

Вход в топ или выход из него за период: in_10 — вошли в ТОП-10, out_10 — вышли; число — граница топа.

По умолчанию all
keyword string

Только запросы, содержащие эту подстроку.
group int

ID группы запросов из keyword-groups/get.
group_url int

ID группы URL из url-groups/get.
ss_id int

Одна поисковая система проекта из search-systems/get. Без него — все.

По умолчанию all
top int

Только запросы не ниже этой позиции. 101 — только вне ТОП-100.

По умолчанию 10000
from date

Начало периода, ГГГГ-ММ-ДД. Передаётся вместе с to.
to date

Конец периода включительно.

Ответ

data.total_count int

Запросов под фильтром.
data.page, data.limit, data.table_type, data.ss_id, data.from, data.to, data.order, data.order_type, data.group, data.group_url, data.top, data.change mixed

Применённые параметры; from/to — итоговый период.
data.access_type string

Права на проект: OWNER, WRITE или READ.
data.data.yandex_updates array|false

Только в detail: даты периода и был ли в этот день апдейт Яндекса — {date, update}.
data.data.visibility object

Видимость по топу: last — на конец периода, prev — на начало, diff — разница.
data.data.queries[] array

Запросы.
Вложенные поля
- query_id, query int|string
  
  ID и текст запроса.
- group_id int
  
  Группа запроса.
- frequency int
  
  Частота по типу частоты проекта.
- full_rel_url, full_need_url string
  
  Релевантный и целевой URL.
- search_engines[] array
  
  simple: position, delta_position, detail (date1, date2, position1, position2), relevance_url. detail: rel_url и positions_data — positions[] {date, position, delta} и trends. В обеих формах — search_system_id и engine_data в формате search-systems/get.

POST /api-rest/project/positions/get

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/positions/get' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002,
      "table_type": "simple"
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/positions/get';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
        'table_type' => 'simple',
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/positions/get",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
        "table_type": "simple",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list table_type Форма ответа

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "total_count": "1",
        "page": 1,
        "limit": 30,
        "table_type": "simple",
        "ss_id": "all",
        "from": "2026-09-28",
        "to": "2026-10-05",
        "order": "frequency",
        "order_type": 2,
        "group": false,
        "group_url": false,
        "access_type": "OWNER",
        "top": 10000,
        "change": "all",
        "data": {
            "yandex_updates": false,
            "visibility": {
                "last": 42.5,
                "prev": 40.1,
                "diff": 2.4
            },
            "queries": [
                {
                    "query_id": 8049495,
                    "query": "купить велосипед",
                    "group_id": 1,
                    "frequency": 1250,
                    "full_rel_url": "https://example.ru/catalog/bikes/",
                    "full_need_url": "https://example.ru/catalog/bikes/",
                    "search_engines": [
                        {
                            "position": 4,
                            "delta_position": 2,
                            "search_system_id": 1,
                            "detail": {
                                "date1": "2026-09-28",
                                "date2": "2026-10-05",
                                "position1": 6,
                                "position2": 4
                            },
                            "relevance_url": "https://example.ru/catalog/bikes/",
                            "engine_data": {
                                "id": 1,
                                "name": "Яндекс (Москва)",
                                "is_priority": 1,
                                "region": {
                                    "id": "213",
                                    "name": "Москва"
                                },
                                "engine": {
                                    "id": "1",
                                    "name": "Яндекс",
                                    "alias": "yandex"
                                }
                            }
                        }
                    ]
                }
            ]
        }
    },
    "dt": "2026-10-06 12:00:00"
}

Внеплановая проверка позиций

POST /api-rest/project/positions/schedule

Ставит все запросы проекта в очередь на съём позиций, не дожидаясь расписания. Ход проверки виден в user/state/get — поле positions_yandex проекта. Новая проверка не запускается, пока не закончилась текущая.

Проверка расходует лимиты владельца проекта — столько же, сколько плановый съём. Если их не хватает, придёт ошибка 497 с нужным количеством.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.

Ответ

Успех — code: 200, текст в message, data пустой.

POST /api-rest/project/positions/schedule

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/positions/schedule' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/positions/schedule';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/positions/schedule",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list

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

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

{
    "status": "success",
    "message": "Все запросы проекта example.ru поставлены в очередь на проверку позиций.",
    "code": 200,
    "data": [],
    "dt": "2026-10-06 12:00:00"
}

Группы запросов

POST /api-rest/project/keyword-groups/get

Группы запросов проекта вместе с общей системной группой «Общая», постранично.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.
limit int

Групп на странице.

По умолчанию 20
page int

Номер страницы.

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

Ответ

data.total_count int

Всего групп, вместе с общими.
data.page, data.limit int

Страница и размер страницы из запроса.
data.groups[] array

Группы по порядку сортировки.
Вложенные поля
- id int
  
  ID группы.
- name string
  
  Название.
- user_id, project_id int
  
  Владелец и проект; -1 у общих системных групп вроде «Общая».
- group_order int
  
  Порядок сортировки.
- group_type int
  
  1 — группа запросов, 3 — группа URL.
- dt_create, dt_update datetime
  
  Создание и последнее изменение.

POST /api-rest/project/keyword-groups/get

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/keyword-groups/get' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/keyword-groups/get';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/keyword-groups/get",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "total_count": 2,
        "page": 1,
        "limit": 20,
        "groups": [
            {
                "id": 1,
                "name": "Общая",
                "user_id": -1,
                "project_id": -1,
                "group_order": 1,
                "group_type": 1,
                "dt_create": "0000-00-00 00:00:00",
                "dt_update": "2021-09-20 13:29:01"
            },
            {
                "id": 140601,
                "name": "Велосипеды",
                "user_id": 1001,
                "project_id": 7002,
                "group_order": 100,
                "group_type": 1,
                "dt_create": "2026-03-02 11:15:00",
                "dt_update": "2026-03-02 11:15:00"
            }
        ]
    },
    "dt": "2026-10-06 12:00:00"
}

Группы URL

POST /api-rest/project/url-groups/get

Группы целевых URL проекта, постранично. Формат ответа — как у keyword-groups/get, group_type — 3.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.
limit int

Групп на странице.

По умолчанию 20
page int

Номер страницы.

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

Ответ

data.total_count int

Всего групп, вместе с общими.
data.page, data.limit int

Страница и размер страницы из запроса.
data.groups[] array

Группы по порядку сортировки.
Вложенные поля
- id int
  
  ID группы.
- name string
  
  Название.
- user_id, project_id int
  
  Владелец и проект; -1 у общих системных групп вроде «Общая».
- group_order int
  
  Порядок сортировки.
- group_type int
  
  1 — группа запросов, 3 — группа URL.
- dt_create, dt_update datetime
  
  Создание и последнее изменение.

POST /api-rest/project/url-groups/get

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/url-groups/get' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/url-groups/get';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/url-groups/get",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "total_count": 1,
        "page": 1,
        "limit": 20,
        "groups": [
            {
                "id": 111290,
                "name": "example.ru/catalog",
                "user_id": 1001,
                "project_id": 7002,
                "group_order": 100,
                "group_type": 3,
                "dt_create": "2026-03-02 11:20:19",
                "dt_update": "2026-03-02 11:20:19"
            }
        ]
    },
    "dt": "2026-10-06 12:00:00"
}

Поисковые системы проекта

POST /api-rest/project/search-systems/get

Поисковые системы и регионы, в которых проект снимает позиции. id отсюда передаётся как ss_id в фильтры позиций и сводки.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.

Ответ

data[].id int

ID пары «система + регион» — это ss_id.
data[].name string

Подпись: «Яндекс (Москва)».
data[].is_priority int

1 — приоритетная система проекта.
data[].region object

id (lr) и name региона.
data[].engine object

id, name и alias поисковой системы.

POST /api-rest/project/search-systems/get

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/search-systems/get' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/search-systems/get';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/search-systems/get",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": [
        {
            "id": 1,
            "name": "Яндекс (Москва)",
            "is_priority": 1,
            "region": {
                "id": "213",
                "name": "Москва"
            },
            "engine": {
                "id": "1",
                "name": "Яндекс",
                "alias": "yandex"
            }
        },
        {
            "id": 3,
            "name": "Google (Москва)",
            "is_priority": 0,
            "region": {
                "id": "213",
                "name": "Москва"
            },
            "engine": {
                "id": "2",
                "name": "Google",
                "alias": "google"
            }
        }
    ],
    "dt": "2026-10-06 12:00:00"
}

Сводка: запуск расчёта

POST /api-rest/project/positions/summary/set/data

Шаг 1 сводки по позициям — графики видимости, CTR×WS, доли запросов в ТОП-10 и ТОП-3, средней позиции и потенциала. Для каждого типа отвечает, готов ли он; неготовые ставит в фоновый расчёт. Повторяйте вызов раз в секунду-две с теми же фильтрами, пока тип не станет true, затем заберите его через summary/get/content.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.
type array обязательный

Какие графики нужны. Даже один тип передаётся массивом. Неизвестные типы пропускаются.

visibility
видимость

ctrxws
CTR×WS — оценка трафика

top
доля запросов в ТОП-10

top3
доля запросов в ТОП-3

positionavg
средняя позиция

potential
потенциал
keyword string

Только запросы, содержащие эту подстроку.
group int

ID группы запросов из keyword-groups/get.
group_url int

ID группы URL из url-groups/get.
ss_id int

Одна поисковая система проекта из search-systems/get. Без него — все.

По умолчанию all
top int

Только запросы не ниже этой позиции. 101 — только вне ТОП-100.

По умолчанию 10000
from date

Начало периода, ГГГГ-ММ-ДД. Передаётся вместе с to.
to date

Конец периода включительно.

Ответ

В data — по ключу на каждый запрошенный тип: true — готов, false — считается.

POST /api-rest/project/positions/summary/set/data

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/positions/summary/set/data' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002,
      "type": [
          "visibility",
          "ctrxws"
      ]
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/positions/summary/set/data';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
        'type' => [
            'visibility',
            'ctrxws',
        ],
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/positions/summary/set/data",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
        "type": [
            "visibility",
            "ctrxws",
        ],
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list type обязательный Какие графики нужны. Значения: visibility, ctrxws, top, top3, positionavg, potential · по одному на строку

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "visibility": true,
        "ctrxws": false
    },
    "dt": "2026-10-06 12:00:00"
}

Сводка: готовый график

POST /api-rest/project/positions/summary/get/content

Шаг 2: данные одного графика, для которого summary/set/data вернул true. Фильтры должны совпадать с теми, что были на шаге 1, — иначе расчёт для них не найдётся.

Параметры query и JSON-тело

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

Access token из user/auth.
project_id int обязательный

ID проекта из projects/list.
content string обязательный

Один тип графика.

visibility
видимость

ctrxws
CTR×WS — оценка трафика

top
доля запросов в ТОП-10

top3
доля запросов в ТОП-3

positionavg
средняя позиция

potential
потенциал
keyword string

Только запросы, содержащие эту подстроку.
group int

ID группы запросов из keyword-groups/get.
group_url int

ID группы URL из url-groups/get.
ss_id int

Одна поисковая система проекта из search-systems/get. Без него — все.

По умолчанию all
top int

Только запросы не ниже этой позиции. 101 — только вне ТОП-100.

По умолчанию 10000
from date

Начало периода, ГГГГ-ММ-ДД. Передаётся вместе с to.
to date

Конец периода включительно.

Ответ

Для графиков по датам — точки {x: дата ДД.ММ.ГГГГ, y: значение}.

POST /api-rest/project/positions/summary/get/content

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/positions/summary/get/content' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project_id": 7002,
      "content": "visibility"
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/positions/summary/get/content';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project_id' => 7002,
        'content' => 'visibility',
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/positions/summary/get/content",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project_id": 7002,
        "content": "visibility",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project_id обязательный ID проекта из projects/list content обязательный Один тип графика

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": [
        {
            "x": "28.09.2026",
            "y": 40.1
        },
        {
            "x": "05.10.2026",
            "y": 42.5
        }
    ],
    "dt": "2026-10-06 12:00:00"
}

Расход лимитов по проектам

POST /api-rest/project/limits/history

Сколько лимитов фактически ушло на каждый из переданных SEO-проектов за период: проверки позиций, частот, технические проверки — всё, что списывалось по проекту. Прогноз на 30 дней вперёд отдаёт project/limits-forecast.

Параметры query и JSON-тело

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

Access token из user/auth.
project array обязательный

ID проектов, не больше 100 за запрос.
dateFrom date

Начало периода, ДД.ММ.ГГГГ. По умолчанию — за 7 дней до dateTo.
dateTo date

Конец периода включительно, ДД.ММ.ГГГГ. По умолчанию — сегодня.

Ответ

В data ключ — ID проекта из запроса.

data.{id}.name string

Домен проекта.
data.{id}.pid string

ID проекта.
data.{id}.limits string|int

Потрачено лимитов за период; 0, если расхода не было.

POST /api-rest/project/limits/history

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/limits/history' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project": [
          7002,
          7105
      ],
      "dateFrom": "01.09.2026",
      "dateTo": "30.09.2026"
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/limits/history';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project' => [
            7002,
            7105,
        ],
        'dateFrom' => '01.09.2026',
        'dateTo' => '30.09.2026',
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/limits/history",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project": [
            7002,
            7105,
        ],
        "dateFrom": "01.09.2026",
        "dateTo": "30.09.2026",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project обязательный ID проектов, не больше 100 за запрос · по одному на строку dateFrom Начало периода, ДД.ММ.ГГГГ dateTo Конец периода включительно, ДД.ММ.ГГГГ

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "7002": {
            "name": "example.ru",
            "pid": "7002",
            "limits": "15210"
        },
        "7105": {
            "name": "shop.example.ru",
            "pid": "7105",
            "limits": 0
        }
    },
    "dt": "2026-10-06 12:00:00"
}

Расход лимитов по GEO-проектам

POST /api-rest/project/ai/limits/history

То же для GEO-проектов ai.pixeltools.ru — мониторинга видимости в ИИ-ответах. ID здесь — ID GEO-проекта, а не SEO-проекта Пиксель Тулс.

Параметры query и JSON-тело

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

Access token из user/auth.
project array обязательный

ID GEO-проектов, не больше 100 за запрос.
dateFrom date

Начало периода, ДД.ММ.ГГГГ. По умолчанию — за 7 дней до dateTo.
dateTo date

Конец периода, ДД.ММ.ГГГГ. По умолчанию — сегодня.

Ответ

data.{id}.name string

Название GEO-проекта; GEO-проект, если расхода за период не было.
data.{id}.pid string

ID GEO-проекта.
data.{id}.limits string|int

Потрачено лимитов за период.

POST /api-rest/project/ai/limits/history

curl -X POST 'https://tools.pixelplus.ru/api-rest/project/ai/limits/history' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "project": [
          512,
          513
      ],
      "dateFrom": "01.09.2026",
      "dateTo": "30.09.2026"
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/project/ai/limits/history';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'project' => [
            512,
            513,
        ],
        'dateFrom' => '01.09.2026',
        'dateTo' => '30.09.2026',
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/project/ai/limits/history",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "project": [
            512,
            513,
        ],
        "dateFrom": "01.09.2026",
        "dateTo": "30.09.2026",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth project обязательный ID GEO-проектов, не больше 100 за запрос · по одному на строку dateFrom Начало периода, ДД.ММ.ГГГГ dateTo Конец периода, ДД.ММ.ГГГГ

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "512": {
            "name": "Мой бренд",
            "pid": "512",
            "limits": "840"
        },
        "513": {
            "name": "GEO-проект",
            "pid": "513",
            "limits": 0
        }
    },
    "dt": "2026-10-06 12:00:00"
}

Ошибки

Код	Сообщение	Когда
`404`	`Invalid project`	Не передан `project_id` или проекта нет.
`403`	`Access denied`	Проект чужой и доступ к нему не выдан.
`497`	`Не достаточно лимитов для проведения проверки. Для запуска необходимо N лимитов.`	`positions/schedule`: у владельца проекта не хватает лимитов.
`498`	`Дождитесь окончания проверки проекта … от …`	`positions/schedule`: проверка уже идёт.
`499`	`Невозможно поставить проект на проверку. Необходимо добавить ключевые запросы.`	`positions/schedule`: в проекте нет запросов. В тексте — HTML-ссылка на страницу запросов.
`500`	`Невозможно поставить проект на проверку`	`positions/schedule`: тариф владельца не даёт проверять позиции или проект заблокирован за нарушение правил (тогда текст об этом).
`500`	`Не удалось получить контент`	`summary/get/content`: `content` не из списка.
`400`	`Maximum allowed 100 projects per request!`	`limits/history`, `ai/limits/history`: в `project` больше 100 ID.
`401`	`Token is not authorized`	Нет заголовка `token` или токен недействителен — см. rest-auth.

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

{
    "status": "error",
    "message": "Не достаточно лимитов для проведения проверки. Для запуска необходимо 4620 лимитов.",
    "code": 497,
    "data": [],
    "dt": "2026-10-06 12:00:00"
}

Чем отличается от API проектов по ключу

Те же данные проекта отдаёт API SEO-проектов с постоянным ключом в параметре token — для своих скриптов он удобнее. REST-методы возвращают данные в формате экранов приложения: позиции сразу с данными поисковых систем, сводку — готовыми точками графиков.

Периоды

positions/get без from/to берёт период по умолчанию из настроек проектов владельца, заканчивающийся сегодня. from и to передавайте парой.

rest-project REST API: позиции, группы и расход лимитов проекта

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Параметры query и JSON-тело

Ответ

Чем отличается от API проектов по ключу

Периоды

`rest-project` REST API: позиции, группы и расход лимитов проекта