10781

Документация API

Получить API-ключ

Дата обновления документации: 19.02.2026

Общая информация

Все запросы необходимо направлять по адресу:
https://api.livesurf.ru/{method}
где {method} — название одного из доступных методов.

API принимает все параметры в теле запроса в формате JSON и возвращает ответ в формате JSON.
У заголовка Accept должно быть установлено значение application/json
Для авторизации в API необходимо передать заголовок Authorization с вашим API-ключом.

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

GET

curl --location 'https://api.livesurf.ru/{method}/' --header 'Authorization: Your Api-key' --header 'Accept: application/json'

POST

curl --location --request POST 'https://api.livesurf.ru/{method}/' --header 'Authorization: Your Api-key' --header 'Accept: application/json' --data '{"YourJsonParam": 1}'

PATCH

curl --location --request PATCH 'https://api.livesurf.ru/{method}/' --header 'Authorization: Your Api-key' --header 'Accept: application/json' --data '{"YourJsonParam": 1}'

DELETE

curl --location --request DELETE 'https://api.livesurf.ru/{method}/' --header 'Authorization: Your Api-key' --header 'Accept: application/json'

ВНИМАНИЕ: К API разрешено делать не более 10 запросов в секунду. При превышении лимита излишние запросы не будут обработаны.

Доступные методы

Описание методов

Метод /categories/

GET запрос

Описание:
Возвращает список возможных категорий, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "id": 2147483647,
          "name": "string",
          "parent": 2147483647,
          "active": true
      }
  ]

Метод /countries/

GET запрос

Описание:
Возвращает список возможных стран для геотаргетинга, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "id": 0,
          "country": "string",
          "region": "string",
          "city": "string",
          "name": "string"
      }
  ]

Метод /languages/

GET запрос

Описание:
Возвращает список возможных языков, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "id": 0,
          "name": "string",
          "translate_name": "string"
      }
  ]

Метод /limits/

GET запрос

Описание:
Возвращает лимиты и параметры стоимости для клиентского API:

  • general.timezone — таймзона, в которой работает API.
  • limits — справочные лимиты по типам аккаунтов (Минимум (account_type_id: 0), Стандарт (account_type_id: 1), Премиум (account_type_id: 2)).
  • user.limits — фактические лимиты текущего пользователя (с учётом индивидуальных расширений).
  • pricing.showtime_price — стоимость одного посещения в зависимости от значения showtime.
  • pricing.modifiers — модификаторы стоимости

Параметры метода:
нет

Ключевые поля лимитов:

  • min_showtime, max_showtime — границы каждого значения в page.showtime ([from, to]); ограничения применяются отдельно к from и to.
  • min_daylimit, max_daylimit — границы group.day_limit (если min_daylimit = 0, допускается day_limit = 0 (Без ограничений)).
  • min_hourlimit, max_hourlimit — границы group.hour_limit (если min_hourlimit = 0, допускается hour_limit = 0 (Без ограничений)).
  • min_imp, max_imp — границы каждого значения в group.interval ([from, to]); при min_imp = 0 допускается отключение.
  • max_keywords — максимум элементов в sources.keywords.settings.list.
  • max_backlinks — максимум элементов в sources.backlinks.settings.list.
  • max_selectors — максимум селекторов в behavior.settings.clicks.list (режим clicks).
  • max_active_pages — количество слотов одновременного запуска страниц.
  • max_alternate_urls — число дополнительных URL в page.url; общее число URL = 1 + max_alternate_urls.
  • max_total_pages — максимум страниц на аккаунт.
  • max_keywords_autocomplete, max_backlinks_autocomplete — используются в платформенном API, в клиентском API сейчас не применяются.

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

{
  "general": {
    "timezone": "Europe/Moscow"
  },
  "limits": [
    {
      "account_type_id": 0,
      "account_type": "min",
      "min_showtime": 15,
      "max_showtime": 45,
      "min_daylimit": 0,
      "max_daylimit": 200,
      "min_hourlimit": 0,
      "max_hourlimit": 50,
      "min_imp": 0,
      "max_imp": 10800,
      "max_keywords": 50,
      "max_backlinks": 50,
      "max_selectors": 2,
      "max_active_pages": 1,
      "max_alternate_urls": 0,
      "max_total_pages": 100,
      "max_keywords_autocomplete": 20,
      "max_backlinks_autocomplete": 20
    }
  ],
  "pricing": {
    "showtime_price": {
      "15": 0.5,
      "...": "...",
      "900": 499
    },
    "modifiers": [
      {
        "key": "geotargeting",
        "type": "percentage",
        "value": "0.30",
        "description": "Геотаргетинг включён: +30%",
        "enabled": true
      },
      {
        "key": "low_pf",
        "type": "percentage",
        "value": "-0.70",
        "description": "Трафик с низкими поведенческими факторами: -70%",
        "enabled": true
      }
    ]
  },
  "user": {
    "limits": {
      "account_type_id": 2,
      "account_type": "vip",
      "min_showtime": 15,
      "max_showtime": 900,
      "min_daylimit": 0,
      "max_daylimit": 2000,
      "min_hourlimit": 0,
      "max_hourlimit": 501,
      "min_imp": 0,
      "max_imp": 10800,
      "max_keywords": 300,
      "max_backlinks": 300,
      "max_selectors": 10,
      "max_active_pages": 24,
      "max_alternate_urls": 10,
      "max_total_pages": 104,
      "max_keywords_autocomplete": 20,
      "max_backlinks_autocomplete": 20
    }
  }
}

Метод /sources/ad/

GET запрос

Описание:
Возвращает список возможных рекламных систем для настройки источников, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "name": "string",
          "default": true,
          "payload": "string",
          "enable": true
      }
  ]

Метод /sources/messengers/

GET запрос

Описание:
Возвращает список возможных мессенджеров для настройки источников, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "name": "string",
          "default": true,
          "payload": "string",
          "enable": true
      }
  ]

GET запрос

Описание:
Возвращает список возможных поисковых систем для настройки источников, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "id": 0,
          "name": "string",
          "default": "0.1",
          "payload": "string",
          "enable": true
      }
  ]

Метод /sources/social/

GET запрос

Описание:
Возвращает список возможных социальных сетей для настройки источников, которые можно указать при добавлении или редактировании группы.

Параметры метода:
нет

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

  
  [
      {
          "name": "string",
          "default": true,
          "payload": "string",
          "enable": true
      }
  ]

Метод /sources/neural/

GET запрос

Описание:
Возвращает список доступных источников нейросетей для настройки источников трафика.

Параметры метода:
нет

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

[{"name":"poe","default":false,"payload":{"iso":"US","fullName":"Poe"},"enable":true}]

Метод /sources/recommender/

GET запрос

Описание:
Возвращает список доступных источников рекомендательных систем для настройки источников трафика.

Параметры метода:
нет

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

[{"name":"opera_personal_news","default":false,"payload":{"iso":"global","fullName":"Opera Personal News"},"enable":true}]

Метод /user/

GET запрос

Описание:
Возвращает информацию о пользователе: баланс, количество опыта, тип аккаунта, режим работы.

Параметры метода:
нет

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

  
  {
      "credits": "1.00001",
      "workmode": 32767,
      "type": 32767,
      "experience": 9223372036854776000,
      "token": "string"
  }

Метод /user/automode/

POST запрос

Описание:
Устанавливает режим АРК (Автоматическая рекламная кампания) для аккаунта.

Параметры метода:
нет

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

  1

Метод /user/manualmode/

POST запрос

Описание:
Устанавливает ручной режим работы для аккаунта.

Параметры метода:
нет

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

  1

Метод /group/all/

GET запрос

Описание:
Возвращает список всех групп аккаунта и их настройки, включая страницы, входящие в группу.

Параметры метода:
нет

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

  
  [
      {
          "name": "string",
          "hour_limit": 0,
          "day_limit": 0,
          "uniq_ip": 0,
          "moby_ratio": 50,
          "geo": "string",
          "stopping_hours": [
              168
          ],
          "autocalc_visits": {
            "enabled": false,
            "lower_at_night": false,
            "lower_at_week": false
          },
          "use_profiles": true,
          "timezone": "Africa/Abidjan",
          "category": 0,
          "language": 0,
          "bookmarks": [
              99,
              99
          ]
      }
  ]

Метод /group/{group_id}/

GET запрос

Описание:
Возвращает настройки конкретной группы, где {group_id} - идентификатор группы. Включает страницы, входящие в эту группу. Список идентификаторов групп можно получить GET методом /group/all/

Параметры метода:
нет

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

  
  {
      "name": "string",
      "hour_limit": 0,
      "day_limit": 0,
      "uniq_ip": 0,
      "moby_ratio": 50,
      "geo": "string",
      "stopping_hours": [
          168
      ],
      "autocalc_visits": {
        "enabled": false,
        "lower_at_night": false,
        "lower_at_week": false
      },
      "use_profiles": true,
      "timezone": "Africa/Abidjan",
      "category": 0,
      "language": 0,
      "bookmarks": [
          99,
          99
      ]
  }

Метод /group/{group_id}/

PATCH запрос

Описание:
Метод редактирует настройки конкретной группы.

Параметры метода:

  • name (string): Название группы. Максимальная длина — 255 символов.
  • hour_limit (integer): Часовой лимит.
    • Диапазон задаётся лимитами min_hourlimit и max_hourlimit из /limits/.
    • Если min_hourlimit = 0, допускается hour_limit = 0 (без ограничений).
  • day_limit (integer): Суточный лимит.
    • Диапазон задаётся лимитами min_daylimit и max_daylimit из /limits/.
    • Если min_daylimit = 0, допускается day_limit = 0 (без ограничений).
  • interval (array[integer]): Интервал между показами [от, до]. Ограничения для каждого значения задаются min_imp и max_imp из /limits/.
  • uniq_ip (integer): Уникальность IP, значение в часах.
    • Значение 0 означает, что настройка отключена.
    • Максимальное значение — 168.
  • moby_ratio (integer): Процентное соотношение типов устройств (0 - 100).
    • 0 означает только ПК, 100 означает только мобильные устройства.
  • geo (array[integer]): Список идентификаторов стран для геотаргетинга.
    • Доступные идентификаторы можно получить с помощью метода /countries/.
  • autocalc_visits (object): Автоматический расчет часового лимита и интервалов между показами на основе дневного лимита.
    • enabled (bool): Включение, или отключение настройки автоматического расчёта
    • lower_at_night (bool): Снижать количество посещений до 10% в ночное время, относительно часового пояса группы
    • lower_at_week (bool): Снижать количество посещений на 30% в субботу и воскресенье
  • use_profiles (bool): Профили посетителей с активной поисковой историей, для улучшения поведенческих факторов.
  • retention (bool): Удержание.
  • description (string): Описание группы. Максимальная длина — 100 символов.
  • timezone (string): Часовой пояс в формате TZID (например, "Europe/Moscow").
  • stopping_hours (array[integer]): Часы недели для приостановки показа (от 1 до 168).
  • category (integer): Идентификатор категории.
    • Доступные идентификаторы можно получить с помощью метода /categories/.
  • language (integer): Идентификатор языка сайта.
    • Доступные идентификаторы можно получить с помощью метода /languages/.
  • bookmarks (array[integer]): Процентный диапазон переходов из закладок [от, до].
  • autolimit (array[integer]): Диапазон суточного автоизменения лимита [от, до].
    • Возможные значения от -500 до 500.
  • low_pf (object): Использовать трафик с низкими поведенческими факторами.
    • enabled (bool): Включение, или отключение настройки трафика с низкими ПФ
    • ratio (int): Процент трафика с низкими ПФ от общего объёма
  • schedules (object): Расписание показа.
    • Включение, или отключение показа страниц группы по расписанию
  • sources (object): Источники посещений.
    • Настройка входящих источников посещения для группы

Параметр schedules (только для VIP аккаунтов):

  • schedules (array): Планировщик заданий. Каждый элемент представляет собой массив, содержащий:
    • Статус (integer):
      • 0 — пауза
      • 1 — возобновить показ.
    • Время срабатывания (string): Время в формате "дд.мм.гггг чч:мм".
    Пример структуры: 
    
  "schedules": [
      [
          1,
          "07.02.2026 14:17"
      ],
      [
          0,
          "08.02.2026 10:00"
      ]
  ]

Параметр sources (object): Источники посещений

  • Настройки источников посещений. Может содержать следующие элементы:

  1. keywords (object): Переходы из поисковых систем.

    • value (integer): Процент переходов из поисковых систем.
    • enabled (boolean): Использовать источник поисковых систем.
    • settings (object): Дополнительные настройки.
      • list (array[string]): Список ключевых фраз. Максимум элементов задаётся max_keywords из /limits/.
      • search_engines (object): Настройки поисковых систем, где:
        • ключ (string): Идентификатор поисковой системы. Список идентификаторов можно получить методом /sources/search/.
        • значение (float): Соотношение использования от 0 до 1.
      Пример структуры: 
                    
  "keywords": {
      "value": 50,
      "enabled": true,
      "settings": {
          "list": [
              "example keyword"
          ],
          "search_engines": {
              "1": 0.7,
              "2": 0.3
          }
      }
  }

  2. adsystems (object): Переходы из рекламных систем.

    • value (integer): Процент переходов из рекламных систем.
    • enabled (boolean): Использовать рекламные системы.
    • settings (array[string]): Список рекламных систем. Полный список рекламных систем можно получить методом /sources/ad/.

    Пример структуры:

            
  "adsystems": {
      "value": 20,
      "enabled": true,
      "settings": [
          "B2BContext"
      ]
  }

  3. backlinks (object): Переходы по прямым ссылкам с сайтов.

    • value (integer): Процент переходов по прямым ссылкам.
    • enabled (boolean): Использовать прямые ссылки.
    • settings (object): Дополнительные настройки.
      • list (array[string]): Список обратных ссылок. Максимум элементов задаётся max_backlinks из /limits/.

    Пример структуры:

            
        "backlinks": {
            "value": 20,
            "enabled": true,
            "settings": {
                "list": [
                    "https://example.com"
                ]
            }
        }

  4. messengers (object): Переходы из мессенджеров.

    • value (integer): Процент переходов из мессенджеров.
    • enabled (boolean): Использовать переходы из мессенджеров.
    • settings (array[string]): Список мессенджеров. Полный список мессенджеров можно получить методом /sources/messengers/.

    Пример структуры:

            
        "messengers": {
            "value": 20,
            "enabled": true,
            "settings": [
                "telegram"
            ]
        }

  5. clickunders (object): Переходы с кликандеров и попандеров.

    • value (integer): Процент переходов с кликандеров.
    • enabled (boolean): Использовать кликандеры.

    Пример структуры:

            
        "clickunders": {
            "value": 20,
            "enabled": true
        }

  6. emailanalytics (object): Переходы с почтовых рассылок.

    • value (integer): Процент переходов из почтовых рассылок.
    • enabled (boolean): Использовать почтовые рассылки.

    Пример структуры:

            
        "emailanalytics": {
            "value": 20,
            "enabled": true
        }

  7. socialanalytics (object): Переходы из социальных сетей.

    • value (integer): Процент переходов из социальных сетей.
    • enabled (boolean): Использовать социальные сети.
    • settings (array[string]): Список социальных сетей. Полный список можно получить методом /sources/social/.

    Пример структуры:

            
        "socialanalytics": {
            "value": 20,
            "enabled": true,
            "settings": [
                "pinterest"
            ]
        }

Пример конфигурации:

  
  {
      "hour_limit": 100,
      "day_limit": 10000,
      "uniq_ip": 11,
      "moby_ratio": 50,
      "autocalc_visits": {
        "enabled": true,
        "lower_at_night": true,
        "lower_at_week": false
      },
      "use_profiles": true,
      "geo": [
          1,
          2,
          3
      ],
      "timezone": "Europe/Moscow",
      "stopping_hours": [
          1,
          2,
          4,
          5,
          7,
          9
      ],
      "category": 1,
      "language": 1,
      "bookmarks": [
          10,
          40
      ],
      "autolimit": [
          -10,
          10
      ],
      "schedules": [
          [
              1,
              "07.02.2026 14:17"
          ],
          [
              0,
              "07.02.2026 15:17"
          ]
      ],
      "sources": {
          "keywords": {
              "value": 50,
              "enabled": true,
              "settings": {
                  "list": [
                      "Поисковая фраза"
                  ],
                  "search_engines": {
                      "1": 1
                  }
              }
          },
          "adsystems": {
              "value": 50,
              "enabled": true,
              "settings": [
                  "B2BContext"
              ]
          }
      }
  }

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

  {
    "name": "string",
    "hour_limit": 0,
    "day_limit": 0,
    "uniq_ip": 0,
    "moby_ratio": 50,
    "geo": "string",
    "stopping_hours": [
      168
    ],
    "autocalc_visits": {
      "enabled": true,
      "lower_at_night": true,
      "lower_at_week": false
    },
    "use_profiles": true,
    "timezone": "Africa/Abidjan",
    "category": 0,
    "language": 0,
    "bookmarks": [
      99,
      99
    ],
    "autolimit": [
      500,
      500
    ],
    "schedules": [
      [
        0,
        "string"
      ]
    ],
    "low_pf": {
      enabled: false,
      ratio: 30
    },
    "sources": {
      "keywords": {
        "value": 0,
        "enabled": true,
        "settings": {
          "list": [
            "string"
          ],
          "search_engines": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      },
      "adsystems": {
        "value": 0,
        "enabled": true,
        "settings": [
          "string"
        ]
      },
      "backlinks": {
        "value": 0,
        "enabled": true,
        "settings": {
          "list": [
            "string"
          ]
        }
      },
      "messengers": {
        "value": 0,
        "enabled": true,
        "settings": [
          "string"
        ]
      },
      "clickunders": {
        "value": 0,
        "enabled": true
      },
      "emailanalytics": {
        "value": 0,
        "enabled": true
      },
      "socialanalytics": {
        "value": 0,
        "enabled": true,
        "settings": [
          "string"
        ]
      }
    },
    "interval": [
      10800,
      10800
    ],
    "retention": true,
    "description": "string",
    "pages": [
      {
        "id": 0,
        "state": 0,
        "position": 0,
        "url": [
          "string"
        ],
        "showtime": [
          0
        ],
        "break_chain": 0,
        "adult": true,
        "group_id": 0,
        "behavior": {}
      }
    ],
    "credits": 0,
    "id": 0
  }

Метод /group/{group_id}/

DELETE запрос

Описание:
Удаляет группу и все вложенные страницы.

Параметры метода:
нет

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

  1

Метод /group/{group_id}/clone/

POST запрос

Описание:
Клонирует группу и все вложенные страницы.

Параметры метода:

  • name (string): Название группы. Максимальная длина — 255 символов.

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

  {
    "name": "string",
    "hour_limit": 0,
    "day_limit": 0,
    "uniq_ip": 0,
    "moby_ratio": 50,
    "geo": "string",
    "stopping_hours": [
      168
    ],
    "autocalc_visits": {
      "enabled": false,
      "lower_at_night": false,
      "lower_at_week": false
    },
    "use_profiles": true,
    "timezone": "Africa/Abidjan",
    "category": 0,
    "language": 0,
    "bookmarks": [
      99,
      99
    ],
    "autolimit": [
      500,
      500
    ],
    "schedules": [
      [
        0,
        "string"
      ]
    ],
    "low_pf": {
      enabled: false,
      ratio: 30
    },
    "sources": {
      "keywords": {
        "value": 0,
        "enabled": true,
        "settings": {
          "list": [
            "string"
          ],
          "search_engines": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      },
      "adsystems": {
        "value": 0,
        "enabled": true,
        "settings": [
          "string"
        ]
      },
      "backlinks": {
        "value": 0,
        "enabled": true,
        "settings": {
          "list": [
            "string"
          ]
        }
      },
      "messengers": {
        "value": 0,
        "enabled": true,
        "settings": [
          "string"
        ]
      },
      "clickunders": {
        "value": 0,
        "enabled": true
      },
      "emailanalytics": {
        "value": 0,
        "enabled": true
      },
      "socialanalytics": {
        "value": 0,
        "enabled": true,
        "settings": [
          "string"
        ]
      }
    },
    "interval": [
      10800,
      10800
    ],
    "retention": true,
    "description": "string",
    "pages": [
      {
        "id": 0,
        "state": 0,
        "position": 0,
        "url": [
          "string"
        ],
        "showtime": [
          0
        ],
        "behavior": {},
        "elements": [
          "string"
        ],
        "clicks": false,
        "break_chain": 0,
        "adult": true,
        "group_id": 0
      }
    ],
    "credits": 0,
    "id": 0
  }

Метод /group/{group_id}/add_credits/

POST запрос

Описание:
Зачисляет, или списывает кредиты посещений с баланса оссновного аккаунта на баланс группы. Только в ручном режиме работы.

Параметры метода:

  • credits (integer): Количество зачисляемых кредитов посещений. Возможны отрицательные и положительные значения.

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

  1

Метод /group/{group_id}/refund_credits/

POST запрос

Описание:
Возвращает все кредиты проекта на основной баланс аккаунта. Метод доступен в ручном режиме работы.

Параметры метода:
нет

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

1

Метод /group/create/

POST запрос

Описание:
Создаёт новую группу с вложенными страницами

Параметры метода:

  • name (string): Название группы. Максимальная длина — 255 символов.
  • hour_limit (integer): Часовой лимит.
    • Диапазон задаётся лимитами min_hourlimit и max_hourlimit из /limits/.
    • Если min_hourlimit = 0, допускается hour_limit = 0 (без ограничений).
  • day_limit (integer): Суточный лимит.
    • Диапазон задаётся лимитами min_daylimit и max_daylimit из /limits/.
    • Если min_daylimit = 0, допускается day_limit = 0 (без ограничений).
  • interval (array[integer]): Интервал между показами [от, до]. Ограничения для каждого значения задаются min_imp и max_imp из /limits/.
  • uniq_ip (integer): Уникальность IP, значение в часах.
    • Значение 0 означает, что настройка отключена.
    • Максимальное значение — 168.
  • moby_ratio (integer): Процентное соотношение типов устройств (0 - 100).
    • 0 означает только ПК, 100 означает только мобильные устройства.
  • geo (array[integer]): Список идентификаторов стран для геотаргетинга.
    • Доступные идентификаторы можно получить с помощью метода /countries/.
  • autocalc_visits (object): Автоматический расчет часового лимита и интервалов между показами на основе дневного лимита.
    • enabled (bool): Включение, или отключение настройки автоматического расчёта
    • lower_at_night (bool): Снижать количество посещений до 10% в ночное время, относительно часового пояса группы
    • lower_at_week (bool): Снижать количество посещений на 30% в субботу и воскресенье
  • use_profiles (bool): Профили посетителей с активной поисковой историей, для улучшения поведенческих факторов.
  • retention (bool): Удержание.
  • description (string): Описание группы. Максимальная длина — 100 символов.
  • timezone (string): Часовой пояс в формате TZID (например, "Europe/Moscow").
  • stopping_hours (array[integer]): Часы недели для приостановки показа (от 1 до 168).
  • category (integer): Идентификатор категории.
    • Доступные идентификаторы можно получить с помощью метода /categories/.
  • language (integer): Идентификатор языка сайта.
    • Доступные идентификаторы можно получить с помощью метода /languages/.
  • bookmarks (array[integer]): Процентный диапазон переходов из закладок [от, до].
  • autolimit (array[integer]): Диапазон суточного автоизменения лимита [от, до].
    • Возможные значения от -500 до 500.
  • use_profiles (bool): Использовать профили с активной поисковой историей
  • schedules (object): Расписание показа.
    • Включение, или отключение показа страниц группы по расписанию
  • low_pf (object): Использовать трафик с низкими поведенческими факторами.
    • enabled (bool): Включение, или отключение настройки трафика с низкими ПФ
    • ratio (int): Процент трафика с низкими ПФ от общего объёма
  • sources (object): Источники посещений.
  • pages (array): Список вложенных в группу страниц.
    • Описания параметров страницы см. в методе /page/create/.
    • Общий лимит количества страниц на аккаунт задаётся max_total_pages из /limits/.

Пример конфигурации:

  {
    "name": "Группа 27",
    "hour_limit": 50,
    "day_limit": 10000,
    "uniq_ip": 11,
    "moby_ratio": 50,
    "geo": [
      1,
      2
    ],
    "stopping_hours": [
      1,
      2,
      4,
      5,
      7,
      9
    ],
    "autocalc_visits": {
      "enabled": false,
      "lower_at_night": false,
      "lower_at_week": false
    },
    "use_profiles": true,
    "timezone": "Europe/Moscow",
    "category": 1,
    "language": 1,
    "schedules": [
      [
        1,
        "07.02.2026 14:17"
      ],
      [
        0,
        "07.02.2026 15:17"
      ]
    ],
    "bookmarks": [
      10,
      40
    ],
    "autolimit": [
      -10,
      10
    ],
    "pages": [
      {
        "url": [
          "https://example.com/",
          "https://example.com/page2"
        ],
        "showtime": [
          15,
          30
        ]
      },
      {
        "url": [
          "https://example.com/page3",
          "https://example.com/page4"
        ],
        "showtime": [
          15,
          30
        ]
      }
    ],
    "sources": {
      "keywords": {
        "value": 1,
        "enabled": true,
        "settings": {
          "list": [
            "ключевая фраза 1",
            "ключевая фраза 2"
          ],
          "search_engines": {
            "1": 1,
            "2": 0.5,
            "3": 0.5
          }
        }
      },
      "adsystems": {
        "value": 1,
        "enabled": true,
        "settings": [
          "B2BContext"
        ]
      },
      "backlinks": {
        "value": 1,
        "enabled": true,
        "settings": {
          "list": [
            "https://test.com"
          ]
        }
      },
      "messengers": {
        "value": 1,
        "enabled": true,
        "settings": [
          "telegram",
          "whatsapp"
        ]
      },
      "clickunders": {
        "value": 1,
        "enabled": true
      },
      "emailanalytics": {
        "value": 1,
        "enabled": true
      },
      "socialanalytics": {
        "value": 1,
        "enabled": true,
        "settings": [
          "instagram",
          "tiktok",
          "pinterest"
        ]
      }
    }
  }

Пример ошибки валидации (400):

{"errors":{"pages":["Ensure this field has at least 1 elements."]}}

Метод /page/{page_id}/

GET запрос

Описание:
Возвращает настройки конкретной страницы в группе, где {page_id} - идентификатор страницы. Список идентификаторов страниц в группе можно получить GET методом /group/{group_id}/

Параметры метода:
нет

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

  {
    "id": 0,
    "state": 0,
    "position": 0,
    "url": [
      "string"
    ],
    "showtime": [
      0
    ],
    "break_chain": 0,
    "adult": true,
    "group_id": 0,
    "behavior": {
      "mode": "string",
      "settings": {
        "reading_up": true,
        "clicks": { "list": ["string"] },
        "manual": { "actions": object }
      }
    }
  }

Метод /page/{page_id}/

PATCH запрос

Описание:
Редактирует настройки конкретной страницы.

Параметры метода:

  • state (integer): Состояние страницы: 0 - на паузе; 1 - в работе.
  • break_chain (integer): Процент вероятности прервать показ на этой странице.
  • url (array string): Список url. Один из них будет выбран случайным образом при показе страницы. Все url должны быть на одном домене. Максимум URL: 1 + max_alternate_urls из /limits/.
  • showtime (array integer): Время показа страницы [от, до] в секундах. Ограничения задаются лимитами min_showtime и max_showtime из /limits/. Ограничения применяются отдельно к значениям from и to.
  • behavior (object): Настройка поведения на странице
Может содержать следующие элементы:
  1. mode (string): Один из возможных режимов поведения
    • disabled: Поведение отключено
    • clicks: Клик по конкретному элементу страницы. Для работы требует настройку в settings
    • fixation: Фиксация посетителя кликом в конце посещения по странице сайта
    • neural: Поведение на странице генерируется нейросетью. Происходит просмотр страниц и перемещение по ссылкам сайта
  2. settings (object): Настройки поведения
    • reading_up (boolean): Дочитывание. Даная настройка добавляет поведение доскролла до нижней части страницы в любом режиме, кроме режима ручной настройки поведения
    • clicks (object): Настройка режима кликов по конкретным элементам
      • list (array[string]): Список CSS-селекторов элементов для клика. Максимум элементов задаётся max_selectors из /limits/. Клик будет произведён по одному из селекторов, выбранным из списка случайным образом в начале посещения. Максимальное количество элементов зависит от вашего типа аккаунта.

    Пример структуры behavior:

      {
    ...
    "behavior": {
      "mode": "neural",
      "settings": {
        "reading_up": true,
        "clicks": {
          "list": [
            "a",
            ".css-class",
            "#css-id"
          ]
        }
      }
    },
    ...
  }

Пример конфигурации:

  {
    "url": [
      "https://example.com/page_1.html",
      "https://example.com/page_2.html"
    ],
    "break_chain": 10,
    "showtime": [
      30,
      45
    ],
    "behavior": {
      "mode": "neural",
      "settings": {
        "reading_up": true,
        "clicks": {
          "list": [
            "a",
            "span",
            "#awesome_button",
            ".link"
          ]
        }
      }
    },
    "state": 1,
    "group_id": 1
  }

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

  {
    "id": 1
  }

Метод /page/{page_id}/

DELETE запрос

Описание:
Удаляет страницу.

Параметры метода:
нет

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

  1

Метод /page/create/

POST запрос

Описание:
Создаёт новую страницу.

Параметры метода:

  • group_id (integer): Идентификатор группы, в конец которой будет добавлена страница
  • state (integer): Состояние страницы: 0 - на паузе; 1 - в работе.
  • break_chain (integer): Процент вероятности прервать показ на этой странице.
  • url (array string): Список url. Один из них будет выбран случайным образом при показе страницы. Все url должны быть на одном домене. Максимум URL: 1 + max_alternate_urls из /limits/.
  • showtime (array integer): Время показа страницы [от, до] в секундах. Ограничения задаются лимитами min_showtime и max_showtime из /limits/. Ограничения применяются отдельно к значениям from и to.
  • behavior (object): Настройка поведения на странице

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

  
    {
      "id": 1
    }

Пример ошибки валидации (400):

{"errors":{"group_id":"Group with group_id=0 does not exist"}}

Метод /page/{page_id}/clone/

POST запрос

Описание:
Копирует страницу внутри группы и помещает новую страницу в конец списка страниц.

Параметры метода:
нет

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

    1

Метод /page/{page_id}/up/

POST запрос

Описание:
Поднимает страницу на одну позицию вверх в списке страниц группы

Параметры метода:
нет

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

    1

Метод /page/{page_id}/down/

POST запрос

Описание:
Опускает страницу на одну позицию вниз в списке страниц группы

Параметры метода:
нет

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

      1

Метод /page/{page_id}/start/

POST запрос

Описание:
Запускает страницу в работу.

Параметры метода:
нет

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

      1

Метод /page/{page_id}/stop/

POST запрос

Описание:
Останавливает работу страницы.

Параметры метода:
нет

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

    1

Метод /pages-compiled-stats/

GET запрос

Описание:
Возвращает статистику показа страницы, или страниц в группе за определённую дату, или за диапазон дат.

Параметры метода:

  • page_id (integer) — ID страницы или
  • group_id (integer) — ID группы.
  • date (string) — Дата в формате ГГГГ-ММ-ДД или
  • date_from (string) — Дата в формате ГГГГ-ММ-ДД и
  • date_to (string) — Дата в формате ГГГГ-ММ-ДД.

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

  
  [
      {
          "page_id": 0,
          "count": 1
      }
  ]

 

Сохраните в Закладки:
Нашли ошибку в тексте?

Выделите фрагмент с ошибкой.
Нажмите