API: Проверка посещаемости сайта

API возвращает оценочные данные о посещаемости и аудитории по домену: визиты, просмотры страниц, географию и источники трафика. Состав показателей зависит от доступных данных.

1. Получение API‑ключа

Для работы с API необходимо:

1. Зарегистрироваться на сайте PR‑CY.
2. Получить API‑ключ в настройках API.

2. Создание запроса

POST →
https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/

Параметры запроса

Domain передается в params.

Пример запроса

curl 'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/' \
  -H 'accept: application/vnd.api+json' \
	-H 'Content-Type: application/vnd.api+json' \
  -H 'Api-Key: <ваш_api_ключ>' \
  --data-raw '{
    "data": {
      "type": "toolTasks",
      "attributes": {
        "toolName": "traffic",
        "params": {
          "domain": "ya.ru"
        }
      }
    }
  }'

3. Ответ при создании задачи

После отправки POST-запроса API вернёт JSON с ID задачи:

{
  "data": {
    "type": "toolTasks",
    "id": "2a67cb477beceb3a677bcf1592214e24",
    "attributes": { .. }
  }
}

4. Получение результата

GET →
https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/{id_задачи}?include=tests

Если isUpdating равно true, повторите запрос позже. Когда значение станет false, прочитайте результаты в included.

Пример запроса

curl 'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/2a67cb477beceb3a677bcf1592214e24?include=tests' \
  -H 'accept: application/vnd.api+json' \
  -H 'Api-Key: <ваш_api_ключ>'

5. Пример успешного ответа (сокращённый)

{
  "data": {
    "type": "toolTasks",
    "id": "2a67cb477beceb3a677bcf1592214e24",
    "attributes": {...}
  },
  "included": [
    {
      "type": "tests",
      "id": "traffic12345",
      "attributes": {
        "name": "traffic",
        "status": "success",
        "results": {
          "domain": "ya.ru",
          "visitsDaily": 41400,
          "visitsMonthly": 1290000,
          "pageViewsMonthly": 3240000,
          "avgVisitDuration": 180,
          "pagesPerVisit": 3,
          "bounceRate": 44,
          "globalRank": 46957,
          "countryRank": 2726,
          "categoryTopName": "computers_electronics_and_technology",
          "topCountryGeography": [
            { "countryCode": "RU", "percent": 71 },
            { "countryCode": "BY", "percent": 10 },
            { "countryCode": "UA", "percent": 5 }
          ],
          "trafficSources": {
            "organicSearch": 59,
            "direct": 38,
            "social": 1
          },
          "socialTraffic": [
            { "domain": "vk.com", "percent": 60 },
            { "domain": "youtube.com", "percent": 16 },
            { "domain": "telegram.org", "percent": 11 }
          ]
        }
      }
    }
  ]
}

6. Ключевые поля в ответе

7. Примечания

• Все значения посещаемости — оценочные, получены из откр. источников и внутренних данных.
• Значения могут отсутствовать, если трафик слишком мал.
• Метрики позволяют анализировать структуру аудитории и динамику по времени.

Смежные инструкции

• Откуда PR-CY получает данные и почему показатели различаются