Поиск

Документация на метод "geopanel"

API для анализ брендов и сайтов в нейросетях:
URL: https://tools.pixelplus.ru/api/geopanel

Принимает параметры:
GET:

  1. key — ключ доступа к API;
  2. report_id — номер задачи;

POST:

  1. site — обязательный параметр, домен или URL сайта;
  2. include_subdomains — необязательный, учитывать ли поддомены сайта (true / false, по умолчанию false);
  3. models — необязательный, массив нейросетей для проверки (по умолчанию используются все доступные нейросети). Моделей те же, что используются в инструменте (https://tools.pixelplus.ru/geopanel): yandex-alisa, google-ai-overview, openai, perplexity, alice-ai, deepseek, claude, grok, qwen, gemini 

Возвращает JSON:
В случае запроса на обработку:  {"report_id":"номер задачи"}
В случае запроса отчёта по report_id, если задача ещё не завершена — возвращается текущий статус задачи.
В случае, если отчёт готов (time - время ответа инструмента, cost - расчетная стоимость в лимитах, может незначительно отличаться от фактической):
В случае успеха:

{
    "response": {
        "prompts": [
            { "...": "данные по промпту 1" },
            { "...": "данные по промпту 2" }
        ],
        "mentions_chart": [
            { "date": "YYYY-MM-DD", "mentions": 12 }
        ],
        "sources": [
            { "...": "данные по источнику 1" }
        ],
        "competitors": [
            { "...": "данные по конкуренту 1" }
        ],
        "urls_found": 128,
        "tables_count": {
            "prompts": 20,
            "sources": 45,
            "competitors": 12
        },
        "tables_total_count": {
            "prompts": 20,
            "sources": 45,
            "competitors": 12
        },
        "csv_files": [
            "https://.../prompts.csv"
        ]
    },
    "time": "1565343172",
    "cost": 100
}

Где:

  • prompts — список промптов, по которым проверялся сайт, с найденными упоминаниями сайта и его страниц (то же, что таблица «Промпты&ra интерфейсе инструмента).

  • mentions_chart — данные графика упоминаний сайта по датам.

  • sources — список найденных источников (то же, что таблица «Источники» в интерфейсе инструмента).

  • competitors — список найденных сайтов-конкурентов (то же, что таблица «Конкуренты» в интерфейсе инструмента).

  • urls_found — количество найденных URL сайта.

  • tables_count / tables_total_count — количество строк в таблицах prompts / sources / competitors (в текущей выборке и всего).

  • csv_files — ссылки на CSV-выгрузки по отчёту (если есть).

  • time — время ответа инструмента.

  • cost — ориентировочная стоимость инструмента, может незначительно отличаться от фактической в меньшую сторону.

В случае неудачи:

  1. {"error":"site","details":"Not set","code":"-50"} — не задан обязательный пар site;
  2. {"error":"tools errors","details":["Неправильно задан параметр с нейросетями!"],"code":"-100"} — не задан или неверно задан параметр models;
  3. {"error":"tools errors","details":["Недопустимая нейросеть: xxx. Разрешенные значения: ..."],"code":"-100"} — в models передана нейросеть, которой нет в списке доступных;
  4. {"error":"tools errors","details":["To many tasks from one user. Try again later."],"code":"-100"} — превышен лимит одновременно поставленных задач для пользователя (не более 5);
  5. {"error":"No requests data","code":"-51"} — запрос отправлен не методом POST;
  6. {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
  7. {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
  8. {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
  9. {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
  10. {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
  11. {"error":"tools errors","details":"Произошла ошибка во время установки задачи. Пожалуйста, попробуйте еще раз.","errorType":"TASK_START_FAIL","code":"-100"} — не удалось поставить задачу в очередь;
  12. {"error":"In progress","code":50,"progress":N,"time":"..."} — отчёт по report ещё не готов, задача выполняется;
  13. {"error":"По сайту «...» ничего не найдено...","error_type":"not_found","code":-1 — сайт не встречался в базе источников;
  14. {"error":"Access denied","code":-4} — report_id принадлежит другому пользователю или другому инструменту;{"error":"Processing error","code":-104} — инструмент завершился с фатальной ошибкой;
  15. {"error":"Limits run out","code":-105} — во время выполнения инструмента закончились лимиты;
  16. {"error":"The process was canceled by a user","code":-106} — задача отменена пользователем;
  17. {"error":"The process took more than 6 hours and was canceled","code":-107} — инструмент очень долго р в фоне и мы автоматически завершили процесс;
  18. {"error":"Processing error","code":-125} — непредвиденная ошибка;
  19. {"error":"Access denied","code":-1} — не задан ключ доступа;
  20. {"error":"Access denied","code":-2} — неверно задан ключ доступа;
  21. {"error":"Unknown method","code":-3} — неверно задано название метода;