Доступность функций зависит от тарифа, подключения Instagram и настроек сервиса. Отключённые функции нельзя включить через API.

Справочник API

От первого запроса до рабочей интеграции: контракты методов SocBooster.

Базовый URL: https://socbooster.ru/api/v1

Открыть OpenAPI ↗

Быстрый старт

Создайте ключ в кабинете, выберите минимальные права и сохраните секрет в переменной окружения SOCBOOSTER_API_KEY. Проверьте ключ запросом ниже. Примеры используют вымышленные данные: замените идентификаторы, значения и пути к файлам своими.

curl

curl 'https://socbooster.ru/api/v1/api-keys/current' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

Авторизация

Все методы требуют Authorization: Bearer rr_live_…. Ключ связан с владельцем и рабочим пространством. Создание ключей и изменение прав доступны только в кабинете; API позволяет проверить и отозвать текущий ключ.

Безопасность

Используйте HTTPS. Храните ключ на сервере; не добавляйте его в браузерный код, URL, репозиторий или логи. Отзывайте скомпрометированные ключи. Проверяйте выбранный ресурс перед удалением и выдавайте интеграциям только нужные права.

Права доступа

Право указано у каждого метода. Новые права не добавляются существующим ключам автоматически. Право section:extended:read включает section:read; обратное неверно. Права read и write независимы. Отсутствие отдельного права не отменяет авторизацию.

account:read
affiliates:read
affiliates:write
analytics:extended:read
analytics:read
billing:read
billing:write
campaigns:extended:read
campaigns:extended:write
campaigns:read
campaigns:write
content-lab:read
content-lab:write
inbox:read
inbox:write
instagram:extended:read
instagram:extended:write
instagram:read
logs:read
messages:read
publishing:read
publishing:write
research:extended:read
research:extended:write
research:read
research:write

Ответы и ошибки

Успешный JSON-ответ содержит success и data. Ошибка содержит success:false и error с code, message и возможным details. Проверяйте HTTP-статус и error.code; текст message не является стабильным идентификатором. CSV возвращается отдельно от JSON-обёртки. Аналитика возвращает 50 записей (максимум 100), nextCursor и freshness; totals не зависит от страницы. Direct ограничен тремя попытками с интервалами 5/15 минут, UNKNOWN расходует квоту каждой попытки.

JSON

{"success":true,"data":{}}
{"success":false,"error":{"code":"invalid_input","message":"...","details":{}}}

400: Проверьте JSON, поля и ограничения.
401: Ключ неверен, истёк или отозван.
402: Проверьте тариф и доступный лимит.
403: Проверьте права ключа и доступ владельца.
404: Ресурс или раздел недоступен.
409: Проверьте тело повтора и состояние ресурса.
429: Подождите время из Retry-After.
503: Сервис временно недоступен. Повторяйте с задержкой, сохраняя UUID.

Лимиты и тариф

До 120 запросов в минуту на ключ, включая обслуживание. При 429 соблюдайте Retry-After. Успешный ответ может содержать X-RateLimit-Remaining. Рабочий запрос расходует одну единицу api_requests, включая повтор с тем же UUID; предметные лимиты действуют отдельно.

Обслуживание не расходует api_requests и не требует тарифной функции. Авторизация, права и ограничение частоты сохраняются. Условное обслуживание действует только при совпадении тела с условием в карточке; например, pause/cancel, но не resume.

Идемпотентность

Обязательность Idempotency-Key указана у метода. Для новой операции создайте UUID; для повтора сохраните UUID и тело. Другое тело с тем же UUID вызывает 409. Не используйте новый UUID для слепого повтора после тайм-аута. UUID в примере — только иллюстрация.

Пагинация

Используйте параметры конкретного метода. В списках запусков и профилей парсинга limit — 1–100, по умолчанию 20. Передайте полученный nextCursor как cursor следующего запроса; null завершает обход. Сохраняйте фильтры. Другие списки используют page/limit или after; единого формата пагинации нет.

Длительные операции и статус

При 202 и statusUrl опрашивайте GET statusUrl с тем же ключом, увеличивая интервал при ожидании. Безопасный ответ содержит только id, status, progress, updatedAt, errorCode. Результат получайте отдельным методом ресурса. UNKNOWN означает неизвестный исход: проверьте ресурс и разберите ситуацию вручную, не повторяя изменение с новым UUID.

curl

curl 'https://socbooster.ru/api/v1/operations/YOUR_OPERATION_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

Подключение через OAuth

POST /instagram/connection-attempts создаёт попытку и возвращает confirmationUrl, statusUrl и expiresAt. Владелец открывает confirmationUrl в браузере с активной сессией и подтверждает подключение. Клиент проверяет statusUrl. Ключ API не завершает OAuth сам; OAuth state и секреты не выдаются. Попытка действует 10 минут. При EXPIRED создайте новую; при UNKNOWN сначала проверьте подключение.

curl

curl -X POST 'https://socbooster.ru/api/v1/instagram/connection-attempts' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{}'

CSV и загрузка файлов

Экспорт хештегов возвращает text/csv; у методов с format=csv передайте этот параметр. Dream100 export возвращает filename, contentType и csv внутри data JSON-ответа. Учитывайте UTF-8 BOM и защиту ячеек. Для multipart/form-data используйте curl -F: curl сам задаёт boundary. Не отправляйте файл как JSON.

Методы

Показано методов: 110 / 110

Поиск по маршруту, методу, праву или описаниюКатегория

GET/api/v1#

Каталог API

Без отдельного права · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: Без отдельного права
api_requests: Рабочий запрос · 1 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Подробная схема не задана в реестре. Уточняйте контракт по OpenAPI и ответу метода; отсутствие схемы не означает отсутствие тела или полей.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1

curl -X GET 'https://socbooster.ru/api/v1' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

Замените примерные значения. UUID сохраните для повторов; для новой операции создайте новый. Поля со сложными условиями проверяйте по схеме.

GET/api/v1/api-keys/current#

Безопасные метаданные текущего API-ключа

Без отдельного права · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: Без отдельного права
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`name`	`string`	Обязательно
`prefix`	`string`	Обязательно
`scopes`	`array`	Обязательно
`scopes[]`	`string`	—
`expiresAt`	`string · date-time`	Обязательно
`lastUsedAt`	`string \| null · date-time`	Обязательно
`revokedAt`	`string \| null · date-time`	Обязательно
`createdAt`	`string · date-time`	Обязательно
`status`	`string · enum: "active", "expired", "revoked"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "prefix": {
      "type": "string"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "lastUsedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "revokedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "expired",
        "revoked"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "prefix",
    "scopes",
    "expiresAt",
    "lastUsedAt",
    "revokedAt",
    "createdAt",
    "status"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/api-keys/current

curl -X GET 'https://socbooster.ru/api/v1/api-keys/current' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

DELETE/api/v1/api-keys/current#

Отозвать текущий API-ключ

Без отдельного права · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: Без отдельного права
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`revoked`	`const: true`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "revoked": {
      "const": true
    }
  },
  "required": [
    "revoked"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

DELETE /api/v1/api-keys/current

curl -X DELETE 'https://socbooster.ru/api/v1/api-keys/current' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/operations/{id}/status#

Безопасное состояние операции

Без отдельного права · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: Без отдельного права
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/operations/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/operations/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/reels#

Исследовать Reels

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_research
Флаг функции: nicheSearch
Idempotency-Key: UUID · Необязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/reels

curl -X POST 'https://socbooster.ru/api/v1/research/reels' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/research/reels/hashtags#

Список исследований хештегов

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: hashtag_research
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/reels/hashtags

curl -X GET 'https://socbooster.ru/api/v1/research/reels/hashtags' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/reels/hashtags#

Исследовать хештеги

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: hashtag_research
Флаг функции: hashtagResearch
Idempotency-Key: UUID · Необязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`topic`	`string`	Обязательно
`locales`	`array`	Обязательно
`locales[]`	`string`	—
`targetMode`	`enum: "count", "saturation"`	Обязательно
`targetCount`	`integer · examples: [100,500,1000]`	Необязательно
`minNewGeneratedPerRound`	`integer · default: 2`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "required": [
    "topic",
    "locales",
    "targetMode"
  ],
  "properties": {
    "topic": {
      "type": "string"
    },
    "locales": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetMode": {
      "enum": [
        "count",
        "saturation"
      ]
    },
    "targetCount": {
      "type": "integer",
      "examples": [
        100,
        500,
        1000
      ]
    },
    "minNewGeneratedPerRound": {
      "type": "integer",
      "default": 2
    }
  }
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/reels/hashtags

curl -X POST 'https://socbooster.ru/api/v1/research/reels/hashtags' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"topic":"YOUR_TOPIC","locales":["ru"],"targetMode":"count"}'

GET/api/v1/research/reels/hashtags/{id}#

Исследование хештегов

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: hashtag_research
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`candidateStatus`Статус кандидатов; псевдоним: status	Строка запроса	`string · default: "generated"`	Необязательно
`status`	Строка запроса	`string`	Необязательно
`query`	Строка запроса	`string`	Необязательно
`q`	Строка запроса	`string`	Необязательно
`locale`	Строка запроса	`string`	Необязательно
`branchId`	Строка запроса	`string`	Необязательно
`cursor`	Строка запроса	`string`	Необязательно
`limit`	Строка запроса	`integer`	Необязательно
`format`	Строка запроса	`enum: "csv"`	Необязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Параметр format=csv возвращает text/csv без JSON-обёртки.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/reels/hashtags/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/reels/hashtags/YOUR_ID?candidateStatus=generated' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

curl · CSV

curl -X GET 'https://socbooster.ru/api/v1/research/reels/hashtags/YOUR_ID?candidateStatus=generated&format=csv' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Accept: text/csv" \
  --output export.csv

PATCH/api/v1/research/reels/hashtags/{id}#

Продолжить или отменить исследование хештегов

research:write · По условию · 0 или 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: По условию · 0 или 1 api_requests
Функция тарифа: hashtag_research
Флаг функции: hashtagResearch
Обслуживание при совпадении условия: {"action":"cancel"}
Idempotency-Key: UUID · Необязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`action`	`enum: "resume", "cancel"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "resume",
        "cancel"
      ]
    }
  }
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/research/reels/hashtags/{id}

curl -X PATCH 'https://socbooster.ru/api/v1/research/reels/hashtags/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"action":"resume"}'

GET/api/v1/research/reels/hashtags/{id}/export#

Экспорт хештегов

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: research_export
Idempotency-Key: Не указано в реестре
HTTP: 200 · text/csv

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`candidateStatus`Статус кандидатов; псевдоним: status	Строка запроса	`string · default: "generated"`	Необязательно
`status`	Строка запроса	`string`	Необязательно
`query`	Строка запроса	`string`	Необязательно
`q`	Строка запроса	`string`	Необязательно
`locale`	Строка запроса	`string`	Необязательно
`branchId`	Строка запроса	`string`	Необязательно
`cursor`	Строка запроса	`string`	Необязательно
`limit`	Строка запроса	`integer`	Необязательно
`format`	Строка запроса	`enum: "csv"`	Необязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Тип и ограничения: string · contentMediaType: "text/csv"

Полная JSON Schema

{
  "type": "string",
  "contentMediaType": "text/csv"
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/reels/hashtags/{id}/export

curl -X GET 'https://socbooster.ru/api/v1/research/reels/hashtags/YOUR_ID/export?candidateStatus=generated' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Accept: text/csv" \
  --output export.csv

GET/api/v1/research/hashtag-runs#

Список исследований хештегов

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: hashtag_research
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/hashtag-runs

curl -X GET 'https://socbooster.ru/api/v1/research/hashtag-runs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/hashtag-runs#

Запустить исследование хештегов

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: hashtag_research
Флаг функции: hashtagResearch
Idempotency-Key: UUID · Необязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`topic`	`string`	Обязательно
`locales`	`array`	Обязательно
`locales[]`	`string`	—
`targetMode`	`enum: "count", "saturation"`	Обязательно
`targetCount`	`integer · examples: [100,500,1000]`	Необязательно
`minNewGeneratedPerRound`	`integer · default: 2`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "required": [
    "topic",
    "locales",
    "targetMode"
  ],
  "properties": {
    "topic": {
      "type": "string"
    },
    "locales": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetMode": {
      "enum": [
        "count",
        "saturation"
      ]
    },
    "targetCount": {
      "type": "integer",
      "examples": [
        100,
        500,
        1000
      ]
    },
    "minNewGeneratedPerRound": {
      "type": "integer",
      "default": 2
    }
  }
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/hashtag-runs

curl -X POST 'https://socbooster.ru/api/v1/research/hashtag-runs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"topic":"YOUR_TOPIC","locales":["ru"],"targetMode":"count"}'

GET/api/v1/research/hashtag-runs/{id}#

Исследование хештегов или CSV

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: hashtag_research
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`candidateStatus`Статус кандидатов; псевдоним: status	Строка запроса	`string · default: "generated"`	Необязательно
`status`	Строка запроса	`string`	Необязательно
`query`	Строка запроса	`string`	Необязательно
`q`	Строка запроса	`string`	Необязательно
`locale`	Строка запроса	`string`	Необязательно
`branchId`	Строка запроса	`string`	Необязательно
`cursor`	Строка запроса	`string`	Необязательно
`limit`	Строка запроса	`integer`	Необязательно
`format`	Строка запроса	`enum: "csv"`	Необязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Параметр format=csv возвращает text/csv без JSON-обёртки.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/hashtag-runs/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/hashtag-runs/YOUR_ID?candidateStatus=generated' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

curl · CSV

curl -X GET 'https://socbooster.ru/api/v1/research/hashtag-runs/YOUR_ID?candidateStatus=generated&format=csv' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Accept: text/csv" \
  --output export.csv

PATCH/api/v1/research/hashtag-runs/{id}#

Продолжить или отменить исследование хештегов

research:write · По условию · 0 или 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: По условию · 0 или 1 api_requests
Функция тарифа: hashtag_research
Флаг функции: hashtagResearch
Обслуживание при совпадении условия: {"action":"cancel"}
Idempotency-Key: UUID · Необязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`action`	`enum: "resume", "cancel"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "resume",
        "cancel"
      ]
    }
  }
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/research/hashtag-runs/{id}

curl -X PATCH 'https://socbooster.ru/api/v1/research/hashtag-runs/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"action":"resume"}'

GET/api/v1/research/competitors#

Конкуренты

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_research
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/competitors

curl -X GET 'https://socbooster.ru/api/v1/research/competitors' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/competitors#

Сохранить конкурента

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_research
Idempotency-Key: UUID · Необязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/competitors

curl -X POST 'https://socbooster.ru/api/v1/research/competitors' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/research/saved-reels#

Сохранённые Reels

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_research
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/saved-reels

curl -X GET 'https://socbooster.ru/api/v1/research/saved-reels' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/saved-reels#

Сохранить Reel

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_research
Idempotency-Key: UUID · Необязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/saved-reels

curl -X POST 'https://socbooster.ru/api/v1/research/saved-reels' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/research/dream100-lists#

Списки Dream100

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: dream100
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/dream100-lists

curl -X GET 'https://socbooster.ru/api/v1/research/dream100-lists' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/dream100-lists#

Списки Dream100

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: dream100
Idempotency-Key: UUID · Необязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/dream100-lists

curl -X POST 'https://socbooster.ru/api/v1/research/dream100-lists' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

PATCH/api/v1/research/dream100-lists#

Списки Dream100

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: dream100
Idempotency-Key: UUID · Необязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/research/dream100-lists

curl -X PATCH 'https://socbooster.ru/api/v1/research/dream100-lists' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

DELETE/api/v1/research/dream100-lists#

Списки Dream100

research:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: dream100
Idempotency-Key: UUID · Необязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

DELETE /api/v1/research/dream100-lists

curl -X DELETE 'https://socbooster.ru/api/v1/research/dream100-lists' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/research/analyses#

Анализы Reels

research:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_analysis
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/analyses

curl -X GET 'https://socbooster.ru/api/v1/research/analyses' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/campaigns#

Список автоответов; дополнительные ссылки и аналитика доступны с campaigns:extended:read

campaigns:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automations
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: array

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`$[]`	`object`	—
`$[].id`	`string`	Обязательно
`$[].name`	`string`	Обязательно
`$[].isActive`	`boolean`	Обязательно
`$[].trackedLink`	`object \| null`	Необязательно
`$[].trackedLinks`	`array`	Необязательно
`$[].trackedLinks[]`	`object`	—
`$[].trackedLinks[].id`	`string`	Необязательно
`$[].trackedLinks[].label`	`string`	Необязательно
`$[].trackedLinks[].destinationUrl`	`string`	Необязательно
`$[].trackedLinks[].trackedUrl`	`string`	Необязательно
`$[].reportShareEnabled`	`boolean`	Необязательно
`$[].reportUrl`	`string \| null`	Необязательно

Полная JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "isActive": {
        "type": "boolean"
      },
      "trackedLink": {
        "type": [
          "object",
          "null"
        ]
      },
      "trackedLinks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "label": {
              "type": "string"
            },
            "destinationUrl": {
              "type": "string"
            },
            "trackedUrl": {
              "type": "string"
            }
          }
        }
      },
      "reportShareEnabled": {
        "type": "boolean"
      },
      "reportUrl": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "required": [
      "id",
      "name",
      "isActive"
    ]
  }
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/campaigns

curl -X GET 'https://socbooster.ru/api/v1/campaigns' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/campaigns#

Создать автоответ; дополнительные поля требуют campaigns:extended:write

campaigns:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automations
Idempotency-Key: UUID · Необязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`name`	`string · minLength: 1 · maxLength: 100`	Обязательно
`goal`	`anyOf`	Необязательно
`goal.anyOf[1]`	`string · minLength: 1 · maxLength: 120`	—
`goal.anyOf[2]`	`null`	—
`instagramAccountId`	`anyOf`	Необязательно
`instagramAccountId.anyOf[1]`	`string · minLength: 1`	—
`instagramAccountId.anyOf[2]`	`null`	—
`postId`	`anyOf`	Необязательно
`postId.anyOf[1]`	`string · minLength: 1`	—
`postId.anyOf[2]`	`null`	—
`postUrl`	`anyOf`	Необязательно
`postUrl.anyOf[1]`	`string · uri`	—
`postUrl.anyOf[2]`	`null`	—
`pendingNextReel`	`boolean · default: false`	Необязательно
`matchAnyPost`	`boolean · default: false`	Необязательно
`keywords`	`array · maxItems: 10 · default: []`	Необязательно
`keywords[]`	`string · minLength: 1 · maxLength: 50`	—
`matchAnyWord`	`boolean · default: false`	Необязательно
`dmTriggerEnabled`	`boolean · default: false`	Необязательно
`dmMessage`	`string · minLength: 1 · maxLength: 1000`	Обязательно
`openingDmEnabled`	`boolean · default: false`	Необязательно
`openingDmMessage`	`anyOf`	Необязательно
`openingDmMessage.anyOf[1]`	`string · maxLength: 1000`	—
`openingDmMessage.anyOf[2]`	`null`	—
`openingDmButtonLabel`	`anyOf`	Необязательно
`openingDmButtonLabel.anyOf[1]`	`string · maxLength: 64`	—
`openingDmButtonLabel.anyOf[2]`	`null`	—
`linkButtonLabel`	`anyOf`	Необязательно
`linkButtonLabel.anyOf[1]`	`string · maxLength: 20`	—
`linkButtonLabel.anyOf[2]`	`null`	—
`requireFollow`	`boolean · default: false`	Необязательно
`followPromptMessage`	`anyOf`	Необязательно
`followPromptMessage.anyOf[1]`	`string · maxLength: 1000`	—
`followPromptMessage.anyOf[2]`	`null`	—
`followPromptButtonLabel`	`anyOf`	Необязательно
`followPromptButtonLabel.anyOf[1]`	`string · maxLength: 20`	—
`followPromptButtonLabel.anyOf[2]`	`null`	—
`followUpEnabled`	`boolean · default: false`	Необязательно
`followUpMessage`	`anyOf`	Необязательно
`followUpMessage.anyOf[1]`	`string · maxLength: 1000`	—
`followUpMessage.anyOf[2]`	`null`	—
`followUpDelayMinutes`	`integer · minimum: 0 · maximum: 1440 · default: 0`	Необязательно
`publicReplyEnabled`	`boolean · default: false`	Необязательно
`publicReplyMessages`	`array · maxItems: 10 · default: []`	Необязательно
`publicReplyMessages[]`	`string · maxLength: 1000`	—
`trackedDestinationUrl`	`anyOf`	Необязательно
`trackedDestinationUrl.anyOf[1]`	`anyOf`	—
`trackedDestinationUrl.anyOf[1].anyOf[1]`	`string · uri`	—
`trackedDestinationUrl.anyOf[1].anyOf[2]`	`string · const: ""`	—
`trackedDestinationUrl.anyOf[2]`	`null`	—
`isActive`	`boolean · default: true`	Необязательно
`wholeWordMatch`	`boolean · default: true`	Необязательно
`secondaryDestinationUrl`	`anyOf`	Необязательно
`secondaryDestinationUrl.anyOf[1]`	`anyOf`	—
`secondaryDestinationUrl.anyOf[1].anyOf[1]`	`string · uri`	—
`secondaryDestinationUrl.anyOf[1].anyOf[2]`	`string · const: ""`	—
`secondaryDestinationUrl.anyOf[2]`	`null`	—
`secondaryButtonLabel`	`anyOf`	Необязательно
`secondaryButtonLabel.anyOf[1]`	`string · maxLength: 20`	—
`secondaryButtonLabel.anyOf[2]`	`null`	—
`reportShareEnabled`	`boolean · default: false`	Необязательно

Полная JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "goal": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "instagramAccountId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "postId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "postUrl": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "null"
        }
      ]
    },
    "pendingNextReel": {
      "default": false,
      "type": "boolean"
    },
    "matchAnyPost": {
      "default": false,
      "type": "boolean"
    },
    "keywords": {
      "default": [],
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 50
      }
    },
    "matchAnyWord": {
      "default": false,
      "type": "boolean"
    },
    "dmTriggerEnabled": {
      "default": false,
      "type": "boolean"
    },
    "dmMessage": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "openingDmEnabled": {
      "default": false,
      "type": "boolean"
    },
    "openingDmMessage": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "openingDmButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ]
    },
    "linkButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "requireFollow": {
      "default": false,
      "type": "boolean"
    },
    "followPromptMessage": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "followPromptButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "followUpEnabled": {
      "default": false,
      "type": "boolean"
    },
    "followUpMessage": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "followUpDelayMinutes": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 1440
    },
    "publicReplyEnabled": {
      "default": false,
      "type": "boolean"
    },
    "publicReplyMessages": {
      "default": [],
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1000
      }
    },
    "trackedDestinationUrl": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "string",
              "const": ""
            }
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "isActive": {
      "default": true,
      "type": "boolean"
    },
    "wholeWordMatch": {
      "default": true,
      "type": "boolean"
    },
    "secondaryDestinationUrl": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "string",
              "const": ""
            }
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "secondaryButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "reportShareEnabled": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "dmMessage"
  ]
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`name`	`string`	Обязательно
`isActive`	`boolean`	Обязательно
`trackedLink`	`object \| null`	Необязательно
`trackedLinks`	`array`	Необязательно
`trackedLinks[]`	`object`	—
`trackedLinks[].id`	`string`	Необязательно
`trackedLinks[].label`	`string`	Необязательно
`trackedLinks[].destinationUrl`	`string`	Необязательно
`trackedLinks[].trackedUrl`	`string`	Необязательно
`reportShareEnabled`	`boolean`	Необязательно
`reportUrl`	`string \| null`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "isActive": {
      "type": "boolean"
    },
    "trackedLink": {
      "type": [
        "object",
        "null"
      ]
    },
    "trackedLinks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "destinationUrl": {
            "type": "string"
          },
          "trackedUrl": {
            "type": "string"
          }
        }
      }
    },
    "reportShareEnabled": {
      "type": "boolean"
    },
    "reportUrl": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "isActive"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/campaigns

curl -X POST 'https://socbooster.ru/api/v1/campaigns' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"name":"YOUR_NAME","dmMessage":"YOUR_DMMESSAGE"}'

GET/api/v1/campaigns/{id}#

Получить автоответ

campaigns:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automations
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`name`	`string`	Обязательно
`isActive`	`boolean`	Обязательно
`trackedLink`	`object \| null`	Необязательно
`trackedLinks`	`array`	Необязательно
`trackedLinks[]`	`object`	—
`trackedLinks[].id`	`string`	Необязательно
`trackedLinks[].label`	`string`	Необязательно
`trackedLinks[].destinationUrl`	`string`	Необязательно
`trackedLinks[].trackedUrl`	`string`	Необязательно
`reportShareEnabled`	`boolean`	Необязательно
`reportUrl`	`string \| null`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "isActive": {
      "type": "boolean"
    },
    "trackedLink": {
      "type": [
        "object",
        "null"
      ]
    },
    "trackedLinks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "destinationUrl": {
            "type": "string"
          },
          "trackedUrl": {
            "type": "string"
          }
        }
      }
    },
    "reportShareEnabled": {
      "type": "boolean"
    },
    "reportUrl": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "isActive"
  ]
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/campaigns/{id}

curl -X GET 'https://socbooster.ru/api/v1/campaigns/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

PATCH/api/v1/campaigns/{id}#

Изменить автоответ; узкое отключение работает в режиме обслуживания

campaigns:write · По условию · 0 или 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:write
api_requests: По условию · 0 или 1 api_requests
Функция тарифа: automations
Обслуживание при совпадении условия: {"type":"object","properties":{"isActive":{"const":false},"reportShareEnabled":{"const":false}},"additionalProperties":false,"minProperties":1}
Idempotency-Key: UUID · Необязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`name`	`string · minLength: 1 · maxLength: 100`	Необязательно
`goal`	`anyOf`	Необязательно
`goal.anyOf[1]`	`string · minLength: 1 · maxLength: 120`	—
`goal.anyOf[2]`	`null`	—
`postId`	`anyOf`	Необязательно
`postId.anyOf[1]`	`string · minLength: 1`	—
`postId.anyOf[2]`	`null`	—
`postUrl`	`anyOf`	Необязательно
`postUrl.anyOf[1]`	`string · uri`	—
`postUrl.anyOf[2]`	`null`	—
`pendingNextReel`	`boolean`	Необязательно
`matchAnyPost`	`boolean`	Необязательно
`keywords`	`array · maxItems: 10`	Необязательно
`keywords[]`	`string · minLength: 1 · maxLength: 50`	—
`matchAnyWord`	`boolean`	Необязательно
`dmTriggerEnabled`	`boolean`	Необязательно
`dmMessage`	`string · minLength: 1 · maxLength: 1000`	Необязательно
`openingDmEnabled`	`boolean`	Необязательно
`openingDmMessage`	`anyOf`	Необязательно
`openingDmMessage.anyOf[1]`	`string · maxLength: 1000`	—
`openingDmMessage.anyOf[2]`	`null`	—
`openingDmButtonLabel`	`anyOf`	Необязательно
`openingDmButtonLabel.anyOf[1]`	`string · maxLength: 64`	—
`openingDmButtonLabel.anyOf[2]`	`null`	—
`linkButtonLabel`	`anyOf`	Необязательно
`linkButtonLabel.anyOf[1]`	`string · maxLength: 20`	—
`linkButtonLabel.anyOf[2]`	`null`	—
`requireFollow`	`boolean`	Необязательно
`followPromptMessage`	`anyOf`	Необязательно
`followPromptMessage.anyOf[1]`	`string · maxLength: 1000`	—
`followPromptMessage.anyOf[2]`	`null`	—
`followPromptButtonLabel`	`anyOf`	Необязательно
`followPromptButtonLabel.anyOf[1]`	`string · maxLength: 20`	—
`followPromptButtonLabel.anyOf[2]`	`null`	—
`followUpEnabled`	`boolean`	Необязательно
`followUpMessage`	`anyOf`	Необязательно
`followUpMessage.anyOf[1]`	`string · maxLength: 1000`	—
`followUpMessage.anyOf[2]`	`null`	—
`followUpDelayMinutes`	`integer · minimum: 0 · maximum: 1440`	Необязательно
`publicReplyEnabled`	`boolean`	Необязательно
`publicReplyMessages`	`array · maxItems: 10`	Необязательно
`publicReplyMessages[]`	`string · maxLength: 1000`	—
`trackedDestinationUrl`	`anyOf`	Необязательно
`trackedDestinationUrl.anyOf[1]`	`anyOf`	—
`trackedDestinationUrl.anyOf[1].anyOf[1]`	`string · uri`	—
`trackedDestinationUrl.anyOf[1].anyOf[2]`	`string · const: ""`	—
`trackedDestinationUrl.anyOf[2]`	`null`	—
`isActive`	`boolean`	Необязательно
`wholeWordMatch`	`boolean`	Необязательно
`secondaryDestinationUrl`	`anyOf`	Необязательно
`secondaryDestinationUrl.anyOf[1]`	`anyOf`	—
`secondaryDestinationUrl.anyOf[1].anyOf[1]`	`string · uri`	—
`secondaryDestinationUrl.anyOf[1].anyOf[2]`	`string · const: ""`	—
`secondaryDestinationUrl.anyOf[2]`	`null`	—
`secondaryButtonLabel`	`anyOf`	Необязательно
`secondaryButtonLabel.anyOf[1]`	`string · maxLength: 20`	—
`secondaryButtonLabel.anyOf[2]`	`null`	—
`reportShareEnabled`	`boolean`	Необязательно

Полная JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "goal": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "postId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "postUrl": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "null"
        }
      ]
    },
    "pendingNextReel": {
      "type": "boolean"
    },
    "matchAnyPost": {
      "type": "boolean"
    },
    "keywords": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 50
      }
    },
    "matchAnyWord": {
      "type": "boolean"
    },
    "dmTriggerEnabled": {
      "type": "boolean"
    },
    "dmMessage": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "openingDmEnabled": {
      "type": "boolean"
    },
    "openingDmMessage": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "openingDmButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ]
    },
    "linkButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "requireFollow": {
      "type": "boolean"
    },
    "followPromptMessage": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "followPromptButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "followUpEnabled": {
      "type": "boolean"
    },
    "followUpMessage": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "followUpDelayMinutes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1440
    },
    "publicReplyEnabled": {
      "type": "boolean"
    },
    "publicReplyMessages": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1000
      }
    },
    "trackedDestinationUrl": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "string",
              "const": ""
            }
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "isActive": {
      "type": "boolean"
    },
    "wholeWordMatch": {
      "type": "boolean"
    },
    "secondaryDestinationUrl": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "string",
              "const": ""
            }
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "secondaryButtonLabel": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "reportShareEnabled": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: oneOf

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`$.oneOf[1]`	`object`	—
`$.oneOf[1].id`	`string`	Обязательно
`$.oneOf[1].name`	`string`	Обязательно
`$.oneOf[1].isActive`	`boolean`	Обязательно
`$.oneOf[1].trackedLink`	`object \| null`	Необязательно
`$.oneOf[1].trackedLinks`	`array`	Необязательно
`$.oneOf[1].trackedLinks[]`	`object`	—
`$.oneOf[1].trackedLinks[].id`	`string`	Необязательно
`$.oneOf[1].trackedLinks[].label`	`string`	Необязательно
`$.oneOf[1].trackedLinks[].destinationUrl`	`string`	Необязательно
`$.oneOf[1].trackedLinks[].trackedUrl`	`string`	Необязательно
`$.oneOf[1].reportShareEnabled`	`boolean`	Необязательно
`$.oneOf[1].reportUrl`	`string \| null`	Необязательно
`$.oneOf[2]`	`object`	—
`$.oneOf[2].id`	`string`	Обязательно
`$.oneOf[2].status`	`string`	Обязательно
`$.oneOf[2].progress`	`null`	Обязательно
`$.oneOf[2].updatedAt`	`string`	Обязательно
`$.oneOf[2].errorCode`	`null`	Обязательно

Полная JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "isActive": {
          "type": "boolean"
        },
        "trackedLink": {
          "type": [
            "object",
            "null"
          ]
        },
        "trackedLinks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "destinationUrl": {
                "type": "string"
              },
              "trackedUrl": {
                "type": "string"
              }
            }
          }
        },
        "reportShareEnabled": {
          "type": "boolean"
        },
        "reportUrl": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "isActive"
      ]
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "progress": {
          "type": "null"
        },
        "updatedAt": {
          "type": "string"
        },
        "errorCode": {
          "type": "null"
        }
      },
      "required": [
        "id",
        "status",
        "progress",
        "updatedAt",
        "errorCode"
      ]
    }
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/campaigns/{id}

curl -X PATCH 'https://socbooster.ru/api/v1/campaigns/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"name":"YOUR_NAME"}'

DELETE/api/v1/campaigns/{id}#

Удалить автоответ

campaigns:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:write
api_requests: Рабочий запрос · 1 api_requests
Idempotency-Key: UUID · Необязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Необязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`deleted`	`boolean`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "deleted": {
      "type": "boolean"
    }
  }
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

DELETE /api/v1/campaigns/{id}

curl -X DELETE 'https://socbooster.ru/api/v1/campaigns/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

POST/api/v1/campaigns/import#

Импорт до 200 автоответов; UUID Idempotency-Key обязателен

campaigns:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automation_import
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`instagramAccountId`	`string`	Обязательно
`campaigns`	`array · minItems: 1 · maxItems: 200`	Обязательно
`campaigns[]`	`object`	—
`campaigns[].postId`	`string · minLength: 1`	Обязательно
`campaigns[].postUrl`	`string \| null`	Необязательно
`campaigns[].keywords`	`array · minItems: 1 · maxItems: 10`	Обязательно
`campaigns[].keywords[]`	`string · minLength: 1 · maxLength: 50`	—
`campaigns[].dmMessage`	`string · minLength: 1 · maxLength: 1000`	Обязательно
`campaigns[].name`	`string \| null · maxLength: 100`	Необязательно
`campaigns[].goal`	`string \| null · maxLength: 120`	Необязательно
`campaigns[].publicReplyMessage`	`string \| null · maxLength: 1000`	Необязательно
`campaigns[].trackedUrl`	`string \| null`	Необязательно
`campaigns[].wholeWordMatch`	`boolean`	Необязательно
`campaigns[].isActive`	`boolean`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "instagramAccountId": {
      "type": "string"
    },
    "campaigns": {
      "type": "array",
      "minItems": 1,
      "maxItems": 200,
      "items": {
        "type": "object",
        "properties": {
          "postId": {
            "type": "string",
            "minLength": 1
          },
          "postUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "keywords": {
            "type": "array",
            "minItems": 1,
            "maxItems": 10,
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 50
            }
          },
          "dmMessage": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 100
          },
          "goal": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 120
          },
          "publicReplyMessage": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 1000
          },
          "trackedUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "wholeWordMatch": {
            "type": "boolean"
          },
          "isActive": {
            "type": "boolean"
          }
        },
        "required": [
          "postId",
          "keywords",
          "dmMessage"
        ]
      }
    }
  },
  "required": [
    "instagramAccountId",
    "campaigns"
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`created`	`array`	Необязательно
`created[]`	`object`	—
`created[].name`	`string`	Необязательно
`created[].postId`	`string`	Необязательно
`skipped`	`array`	Необязательно
`skipped[]`	`object`	—
`skipped[].row`	`integer`	Необязательно
`skipped[].reason`	`string`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "created": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "postId": {
            "type": "string"
          }
        }
      }
    },
    "skipped": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "row": {
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        }
      }
    }
  }
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/campaigns/import

curl -X POST 'https://socbooster.ru/api/v1/campaigns/import' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"instagramAccountId":"YOUR_INSTAGRAMACCOUNTID","campaigns":[{"postId":"YOUR_POSTID","keywords":["YOUR_KEYWORDS"],"dmMessage":"YOUR_DMMESSAGE"}]}'

GET/api/v1/campaigns/{id}/status#

Минимальный статус автоответа

campaigns:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string`	Обязательно
`errorCode`	`null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string"
    },
    "errorCode": {
      "type": "null"
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ]
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/campaigns/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/campaigns/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

PATCH/api/v1/campaigns/{id}/disable#

Только isActive:false и/или reportShareEnabled:false; UUID Idempotency-Key обязателен

campaigns:extended:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: campaigns:extended:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · minProperties: 1 · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`isActive`	`const: false`	Необязательно
`reportShareEnabled`	`const: false`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "isActive": {
      "const": false
    },
    "reportShareEnabled": {
      "const": false
    }
  },
  "additionalProperties": false,
  "minProperties": 1
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string`	Обязательно
`errorCode`	`null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string"
    },
    "errorCode": {
      "type": "null"
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/campaigns/{id}/disable

curl -X PATCH 'https://socbooster.ru/api/v1/campaigns/YOUR_ID/disable' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"isActive":false}'

GET/api/v1/instagram/accounts#

Подключённые аккаунты Instagram

instagram:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:read
api_requests: Рабочий запрос · 1 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/accounts

curl -X GET 'https://socbooster.ru/api/v1/instagram/accounts' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/instagram/posts#

Публикации Instagram

instagram:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:read
api_requests: Рабочий запрос · 1 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/posts

curl -X GET 'https://socbooster.ru/api/v1/instagram/posts' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/analytics/summary#

Аналитика автоответов

analytics:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: analytics:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automation_analytics
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/analytics/summary

curl -X GET 'https://socbooster.ru/api/v1/analytics/summary' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/messages/logs#

Журнал автоответов

messages:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: messages:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: message_logs
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/messages/logs

curl -X GET 'https://socbooster.ru/api/v1/messages/logs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/search-plan#

Составить AI-план поиска

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: ai_planning
Флаг функции: nicheSearch
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`topic`	`string · minLength: 2 · maxLength: 200`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "minLength": 2,
      "maxLength": 200
    }
  },
  "required": [
    "topic"
  ],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/search-plan

curl -X POST 'https://socbooster.ru/api/v1/research/search-plan' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"topic":"YOUR_TOPIC"}'

GET/api/v1/research/discovery-runs#

Список запусков; cursor и limit 1–100

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_discovery
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/discovery-runs

curl -X GET 'https://socbooster.ru/api/v1/research/discovery-runs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/discovery-runs#

Создать запуск исследования

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_discovery
Флаг функции: nicheSearch
Idempotency-Key: UUID · Обязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`hashtags`	`array · minItems: 1 · maxItems: 10`	Обязательно
`hashtags[]`	`string · minLength: 1 · maxLength: 100`	—
`excludeKeywords`	`array`	Необязательно
`excludeKeywords[]`	`string · minLength: 1 · maxLength: 100`	—
`parserProfileId`	`string · minLength: 1 · maxLength: 128`	Необязательно
`parserProfileIds`	`array`	Необязательно
`parserProfileIds[]`	`string · minLength: 1 · maxLength: 128`	—
`datePreset`	`string · enum: "all", "today", "yesterday", "last7", "last30", "thisMonth", "previousMonth", "custom"`	Необязательно
`from`	`string`	Необязательно
`to`	`string`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "hashtags": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "minItems": 1,
      "maxItems": 10
    },
    "excludeKeywords": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "parserProfileId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "parserProfileIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "datePreset": {
      "type": "string",
      "enum": [
        "all",
        "today",
        "yesterday",
        "last7",
        "last30",
        "thisMonth",
        "previousMonth",
        "custom"
      ]
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    }
  },
  "required": [
    "hashtags"
  ],
  "additionalProperties": false
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/discovery-runs

curl -X POST 'https://socbooster.ru/api/v1/research/discovery-runs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"hashtags":["YOUR_HASHTAGS"]}'

GET/api/v1/research/discovery-runs/{id}#

Результат запуска исследования

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_discovery
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/discovery-runs/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/discovery-runs/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/research/discovery-runs/{id}/status#

Безопасное состояние запуска

research:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`progress`	`anyOf`	Обязательно
`progress.anyOf[1]`	`null`	—
`progress.anyOf[2]`	`object · additionalProperties: false`	—
`progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "required": [
            "completed",
            "total"
          ],
          "additionalProperties": false
        }
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/research/discovery-runs/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/research/discovery-runs/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/discovery-runs/{id}/actions#

pause/cancel — maintenance без тарифа (200); resume — фоновая работа (202)

research:extended:write · По условию · 0 или 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: По условию · 0 или 1 api_requests
Функция тарифа: reels_discovery
Флаг функции: nicheSearch
Обслуживание при совпадении условия: {"action":["pause","cancel"]}
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`action`	`string · enum: "pause", "cancel", "resume"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "pause",
        "cancel",
        "resume"
      ]
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: oneOf

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`$.oneOf[1]`	`object · additionalProperties: false`	—
`$.oneOf[1].id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`$.oneOf[1].status`	`string`	Обязательно
`$.oneOf[1].progress`	`anyOf`	Обязательно
`$.oneOf[1].progress.anyOf[1]`	`null`	—
`$.oneOf[1].progress.anyOf[2]`	`object · additionalProperties: false`	—
`$.oneOf[1].progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`$.oneOf[1].progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`$.oneOf[1].updatedAt`	`string · date-time`	Обязательно
`$.oneOf[1].errorCode`	`string \| null`	Обязательно
`$.oneOf[2]`	`object`	—
`$.oneOf[2].id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`$.oneOf[2].statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "status": {
          "type": "string"
        },
        "progress": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "object",
              "properties": {
                "completed": {
                  "type": "integer",
                  "minimum": 0
                },
                "total": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 0
                }
              },
              "required": [
                "completed",
                "total"
              ],
              "additionalProperties": false
            }
          ]
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "errorCode": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "status",
        "progress",
        "updatedAt",
        "errorCode"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "statusUrl": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "statusUrl"
      ]
    }
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/discovery-runs/{id}/actions

curl -X POST 'https://socbooster.ru/api/v1/research/discovery-runs/YOUR_ID/actions' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"action":"pause"}'

GET/api/v1/research/discovery-runs/readiness#

Готовность запуска; необязательный parserProfileId

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_discovery
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/discovery-runs/readiness

curl -X GET 'https://socbooster.ru/api/v1/research/discovery-runs/readiness' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/research/collection-runs#

Список запусков; cursor и limit 1–100

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_collection
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/collection-runs

curl -X GET 'https://socbooster.ru/api/v1/research/collection-runs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/collection-runs#

Создать запуск исследования

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_collection
Idempotency-Key: UUID · Обязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`competitorIds`	`array · minItems: 1 · maxItems: 100`	Обязательно
`competitorIds[]`	`string · minLength: 1 · maxLength: 128`	—
`parserProfileId`	`string · minLength: 1 · maxLength: 128`	Необязательно
`datePreset`	`string · enum: "all", "today", "yesterday", "last7", "last30", "thisMonth", "previousMonth", "custom"`	Необязательно
`from`	`string`	Необязательно
`to`	`string`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "competitorIds": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      },
      "minItems": 1,
      "maxItems": 100
    },
    "parserProfileId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "datePreset": {
      "type": "string",
      "enum": [
        "all",
        "today",
        "yesterday",
        "last7",
        "last30",
        "thisMonth",
        "previousMonth",
        "custom"
      ]
    },
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    }
  },
  "required": [
    "competitorIds"
  ],
  "additionalProperties": false
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/collection-runs

curl -X POST 'https://socbooster.ru/api/v1/research/collection-runs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"competitorIds":["YOUR_COMPETITORIDS"]}'

GET/api/v1/research/collection-runs/{id}#

Результат запуска исследования

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_collection
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/collection-runs/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/collection-runs/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/research/collection-runs/{id}/status#

Безопасное состояние запуска

research:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`progress`	`anyOf`	Обязательно
`progress.anyOf[1]`	`null`	—
`progress.anyOf[2]`	`object · additionalProperties: false`	—
`progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "required": [
            "completed",
            "total"
          ],
          "additionalProperties": false
        }
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/research/collection-runs/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/research/collection-runs/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/collection-runs/{id}/actions#

pause/cancel — maintenance без тарифа (200); resume — фоновая работа (202)

research:extended:write · По условию · 0 или 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: По условию · 0 или 1 api_requests
Функция тарифа: reels_collection
Обслуживание при совпадении условия: {"action":["pause","cancel"]}
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`action`	`string · enum: "pause", "cancel", "resume"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "pause",
        "cancel",
        "resume"
      ]
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: oneOf

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`$.oneOf[1]`	`object · additionalProperties: false`	—
`$.oneOf[1].id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`$.oneOf[1].status`	`string`	Обязательно
`$.oneOf[1].progress`	`anyOf`	Обязательно
`$.oneOf[1].progress.anyOf[1]`	`null`	—
`$.oneOf[1].progress.anyOf[2]`	`object · additionalProperties: false`	—
`$.oneOf[1].progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`$.oneOf[1].progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`$.oneOf[1].updatedAt`	`string · date-time`	Обязательно
`$.oneOf[1].errorCode`	`string \| null`	Обязательно
`$.oneOf[2]`	`object`	—
`$.oneOf[2].id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`$.oneOf[2].statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "status": {
          "type": "string"
        },
        "progress": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "object",
              "properties": {
                "completed": {
                  "type": "integer",
                  "minimum": 0
                },
                "total": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 0
                }
              },
              "required": [
                "completed",
                "total"
              ],
              "additionalProperties": false
            }
          ]
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "errorCode": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "status",
        "progress",
        "updatedAt",
        "errorCode"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "statusUrl": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "statusUrl"
      ]
    }
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/collection-runs/{id}/actions

curl -X POST 'https://socbooster.ru/api/v1/research/collection-runs/YOUR_ID/actions' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"action":"pause"}'

GET/api/v1/research/collection-runs/readiness#

Готовность запуска; необязательный parserProfileId

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_collection
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/collection-runs/readiness

curl -X GET 'https://socbooster.ru/api/v1/research/collection-runs/readiness' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/research/readiness#

Готовность поиска по нише; alias discovery-runs/readiness

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_discovery
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/readiness

curl -X GET 'https://socbooster.ru/api/v1/research/readiness' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/competitors/search#

Поиск, рейтинг или сохранение выбранных конкурентов

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: competitor_search
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`query`	`string`	Необязательно
`niche`	`string`	Необязательно
`keywords`	`anyOf`	Необязательно
`keywords.anyOf[1]`	`string · maxLength: 2000`	—
`keywords.anyOf[2]`	`array`	—
`keywords.anyOf[2][]`	`string · minLength: 1 · maxLength: 100`	—
`hashtags`	`anyOf`	Необязательно
`hashtags.anyOf[1]`	`string · maxLength: 2000`	—
`hashtags.anyOf[2]`	`array`	—
`hashtags.anyOf[2][]`	`string · minLength: 1 · maxLength: 100`	—
`excludeKeywords`	`anyOf`	Необязательно
`excludeKeywords.anyOf[1]`	`string · maxLength: 2000`	—
`excludeKeywords.anyOf[2]`	`array`	—
`excludeKeywords.anyOf[2][]`	`string · minLength: 1 · maxLength: 100`	—
`seedAccounts`	`anyOf`	Необязательно
`seedAccounts.anyOf[1]`	`string · maxLength: 2000`	—
`seedAccounts.anyOf[2]`	`array`	—
`seedAccounts.anyOf[2][]`	`string · minLength: 1 · maxLength: 100`	—
`limit`	`integer · minimum: 1 · maximum: 100`	Необязательно
`continuation`	`object \| null`	Необязательно
`persistSelected`	`boolean · default: false`	Необязательно
`selectedHandles`	`array`	Необязательно
`selectedHandles[]`	`string · minLength: 1 · maxLength: 100`	—
`selectedCandidates`	`array · maxItems: 100`	Необязательно
`selectedCandidates[]`	`object · additionalProperties: false`	—
`selectedCandidates[].handle`	`string · minLength: 1 · maxLength: 120`	Обязательно
`selectedCandidates[].followerCount`	`integer \| null · minimum: 0`	Необязательно
`selectedCandidates[].source`	`string · maxLength: 500`	Обязательно
`selectedCandidates[].reasons`	`array · maxItems: 10`	Обязательно
`selectedCandidates[].reasons[]`	`string · maxLength: 1000`	—
`listName`	`string · maxLength: 120`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "niche": {
      "type": "string"
    },
    "keywords": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          }
        }
      ]
    },
    "hashtags": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          }
        }
      ]
    },
    "excludeKeywords": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          }
        }
      ]
    },
    "seedAccounts": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          }
        }
      ]
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "continuation": {
      "type": [
        "object",
        "null"
      ]
    },
    "persistSelected": {
      "type": "boolean",
      "default": false
    },
    "selectedHandles": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "selectedCandidates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "handle": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "followerCount": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0
          },
          "source": {
            "type": "string",
            "maxLength": 500
          },
          "reasons": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 1000
            },
            "maxItems": 10
          }
        },
        "required": [
          "handle",
          "source",
          "reasons"
        ],
        "additionalProperties": false
      },
      "maxItems": 100
    },
    "listName": {
      "type": "string",
      "maxLength": 120
    }
  },
  "required": [],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/competitors/search

curl -X POST 'https://socbooster.ru/api/v1/research/competitors/search' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"query":"YOUR_QUERY"}'

GET/api/v1/research/competitors/{id}#

Карточка конкурента

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: competitor_search
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/competitors/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/competitors/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

PATCH/api/v1/research/competitors/{id}#

Изменить конкурента

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: competitor_search
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`platform`	`string`	Необязательно
`handle`	`string · minLength: 1 · maxLength: 120`	Необязательно
`profileUrl`	`string \| null · uri`	Необязательно
`notes`	`string \| null · maxLength: 2000`	Необязательно
`enabled`	`boolean`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "platform": {
      "type": "string"
    },
    "handle": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "profileUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "notes": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2000
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/research/competitors/{id}

curl -X PATCH 'https://socbooster.ru/api/v1/research/competitors/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"platform":"YOUR_PLATFORM"}'

DELETE/api/v1/research/competitors/{id}#

Удалить конкурента

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: competitor_search
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

DELETE /api/v1/research/competitors/{id}

curl -X DELETE 'https://socbooster.ru/api/v1/research/competitors/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/research/videos#

Архив: competitorId/runId, даты, minViews/minMultiplier, viralStatus, keyword, sort, cursor, limit; language=all

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_collection
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/videos

curl -X GET 'https://socbooster.ru/api/v1/research/videos' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/videos/import-manual#

Импортировать видео вручную

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_import_manual
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`competitorId`	`string · minLength: 1 · maxLength: 128`	Обязательно
`platform`	`string`	Необязательно
`url`	`string · uri`	Обязательно
`shortcode`	`string \| null`	Необязательно
`videoId`	`string \| null`	Необязательно
`caption`	`string \| null · maxLength: 5000`	Необязательно
`postedAt`	`string \| null · date-time`	Необязательно
`views`	`integer \| null · minimum: 0`	Необязательно
`likes`	`integer \| null · minimum: 0`	Необязательно
`comments`	`integer \| null · minimum: 0`	Необязательно
`shares`	`integer \| null · minimum: 0`	Необязательно
`saves`	`integer \| null · minimum: 0`	Необязательно
`rawJson`	`{}`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "competitorId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "platform": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "shortcode": {
      "type": [
        "string",
        "null"
      ]
    },
    "videoId": {
      "type": [
        "string",
        "null"
      ]
    },
    "caption": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5000
    },
    "postedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "views": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "likes": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "comments": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "shares": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "saves": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "rawJson": {}
  },
  "required": [
    "competitorId",
    "url"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/videos/import-manual

curl -X POST 'https://socbooster.ru/api/v1/research/videos/import-manual' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"competitorId":"YOUR_COMPETITORID","url":"https://example.com/resource"}'

POST/api/v1/research/videos/import-url#

Импортировать URL видео с переданными метаданными

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_import_url
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`competitorId`	`string · minLength: 1 · maxLength: 128`	Обязательно
`platform`	`string`	Необязательно
`url`	`string · uri`	Обязательно
`shortcode`	`string \| null`	Необязательно
`videoId`	`string \| null`	Необязательно
`caption`	`string \| null · maxLength: 5000`	Необязательно
`postedAt`	`string \| null · date-time`	Необязательно
`views`	`integer \| null · minimum: 0`	Необязательно
`likes`	`integer \| null · minimum: 0`	Необязательно
`comments`	`integer \| null · minimum: 0`	Необязательно
`shares`	`integer \| null · minimum: 0`	Необязательно
`saves`	`integer \| null · minimum: 0`	Необязательно
`rawJson`	`{}`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "competitorId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "platform": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "shortcode": {
      "type": [
        "string",
        "null"
      ]
    },
    "videoId": {
      "type": [
        "string",
        "null"
      ]
    },
    "caption": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5000
    },
    "postedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "views": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "likes": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "comments": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "shares": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "saves": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "rawJson": {}
  },
  "required": [
    "competitorId",
    "url"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/videos/import-url

curl -X POST 'https://socbooster.ru/api/v1/research/videos/import-url' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"competitorId":"YOUR_COMPETITORID","url":"https://example.com/resource"}'

POST/api/v1/research/analyses#

Создать анализ видео; ответ после завершения анализа

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: reels_analysis
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`videoId`	`string · minLength: 1 · maxLength: 128`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "videoId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "videoId"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/analyses

curl -X POST 'https://socbooster.ru/api/v1/research/analyses' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"videoId":"YOUR_VIDEOID"}'

POST/api/v1/research/dream100-lists/export#

Экспортировать строки Dream100 в CSV внутри JSON

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: research_export
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`rows`	`array · minItems: 1 · maxItems: 100`	Обязательно
`rows[]`	`object · additionalProperties: false`	—
`rows[].handle`	`string`	Обязательно
`rows[].profileUrl`	`string · uri`	Обязательно
`rows[].score`	`number · minimum: 0 · maximum: 100`	Обязательно
`rows[].confidence`	`number · minimum: 0 · maximum: 100`	Обязательно
`rows[].followerCount`	`integer \| null · minimum: 0`	Обязательно
`rows[].reasons`	`array`	Обязательно
`rows[].reasons[]`	`string · minLength: 1 · maxLength: 100`	—
`rows[].recentViralEvidence`	`object · additionalProperties: false`	Необязательно
`rows[].recentViralEvidence.bestUrl`	`string \| null · uri`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "rows": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "object",
        "properties": {
          "handle": {
            "type": "string"
          },
          "profileUrl": {
            "type": "string",
            "format": "uri"
          },
          "score": {
            "type": "number",
            "minimum": 0,
            "maximum": 100
          },
          "confidence": {
            "type": "number",
            "minimum": 0,
            "maximum": 100
          },
          "followerCount": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0
          },
          "reasons": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "recentViralEvidence": {
            "type": "object",
            "properties": {
              "bestUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              }
            },
            "required": [],
            "additionalProperties": false
          }
        },
        "required": [
          "handle",
          "profileUrl",
          "score",
          "confidence",
          "followerCount",
          "reasons"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "rows"
  ],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`filename`	`string`	Обязательно
`contentType`	`string`	Обязательно
`csv`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string"
    },
    "contentType": {
      "type": "string"
    },
    "csv": {
      "type": "string"
    }
  },
  "required": [
    "filename",
    "contentType",
    "csv"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/dream100-lists/export

curl -X POST 'https://socbooster.ru/api/v1/research/dream100-lists/export' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"rows":[{"handle":"YOUR_HANDLE","profileUrl":"https://example.com/resource","score":0,"confidence":0,"followerCount":0,"reasons":["YOUR_REASONS"]}]}'

GET/api/v1/research/parser-profiles#

Список профилей парсинга; cursor и limit 1–100 (по умолчанию 20)

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/parser-profiles

curl -X GET 'https://socbooster.ru/api/v1/research/parser-profiles' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/parser-profiles#

Создать профиль парсинга

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`cookies`	`string · minLength: 1 · maxLength: 262144 · writeOnly: true`	Обязательно
`name`	`string · maxLength: 100`	Необязательно
`proxy`	`string · maxLength: 2048 · writeOnly: true`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "cookies": {
      "type": "string",
      "minLength": 1,
      "maxLength": 262144,
      "writeOnly": true
    },
    "name": {
      "type": "string",
      "maxLength": 100
    },
    "proxy": {
      "type": "string",
      "maxLength": 2048,
      "writeOnly": true
    }
  },
  "required": [
    "cookies"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/parser-profiles

curl -X POST 'https://socbooster.ru/api/v1/research/parser-profiles' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"cookies":"YOUR_COOKIES"}'

GET/api/v1/research/parser-profiles/{id}#

Карточка профиля без cookies и реквизитов прокси

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/parser-profiles/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/parser-profiles/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

PATCH/api/v1/research/parser-profiles/{id}#

Изменить профиль: cookies, proxy, name, enabled или validate

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: oneOf

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`$.oneOf[1]`	`object · additionalProperties: false`	—
`$.oneOf[1].cookies`	`string · minLength: 1 · maxLength: 262144 · writeOnly: true`	Обязательно
`$.oneOf[1].name`	`string · maxLength: 100`	Необязательно
`$.oneOf[1].proxy`	`string · maxLength: 2048 · writeOnly: true`	Необязательно
`$.oneOf[2]`	`object · additionalProperties: false`	—
`$.oneOf[2].action`	`const: "validate"`	Обязательно
`$.oneOf[3]`	`object · additionalProperties: false`	—
`$.oneOf[3].enabled`	`boolean`	Обязательно
`$.oneOf[4]`	`object · additionalProperties: false`	—
`$.oneOf[4].name`	`string · maxLength: 100`	Обязательно
`$.oneOf[5]`	`object · additionalProperties: false`	—
`$.oneOf[5].proxy`	`string · maxLength: 2048 · writeOnly: true`	Обязательно

Полная JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "cookies": {
          "type": "string",
          "minLength": 1,
          "maxLength": 262144,
          "writeOnly": true
        },
        "name": {
          "type": "string",
          "maxLength": 100
        },
        "proxy": {
          "type": "string",
          "maxLength": 2048,
          "writeOnly": true
        }
      },
      "required": [
        "cookies"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "action": {
          "const": "validate"
        }
      },
      "required": [
        "action"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 100
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "proxy": {
          "type": "string",
          "maxLength": 2048,
          "writeOnly": true
        }
      },
      "required": [
        "proxy"
      ],
      "additionalProperties": false
    }
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/research/parser-profiles/{id}

curl -X PATCH 'https://socbooster.ru/api/v1/research/parser-profiles/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"cookies":"YOUR_COOKIES"}'

DELETE/api/v1/research/parser-profiles/{id}#

Удалить профиль парсинга

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

DELETE /api/v1/research/parser-profiles/{id}

curl -X DELETE 'https://socbooster.ru/api/v1/research/parser-profiles/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/research/parser-profiles/{id}/status#

Безопасное состояние профиля

research:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`progress`	`anyOf`	Обязательно
`progress.anyOf[1]`	`null`	—
`progress.anyOf[2]`	`object · additionalProperties: false`	—
`progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "required": [
            "completed",
            "total"
          ],
          "additionalProperties": false
        }
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/research/parser-profiles/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/research/parser-profiles/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/parser-profiles/login#

Создать пакет входа в профили парсинга

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: UUID · Обязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`accounts`	`string · minLength: 1 · maxLength: 65536 · writeOnly: true`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "accounts": {
      "type": "string",
      "minLength": 1,
      "maxLength": 65536,
      "writeOnly": true
    }
  },
  "required": [
    "accounts"
  ],
  "additionalProperties": false
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "statusUrl"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/parser-profiles/login

curl -X POST 'https://socbooster.ru/api/v1/research/parser-profiles/login' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"accounts":"YOUR_ACCOUNTS"}'

GET/api/v1/research/parser-profiles/login/{id}#

Результат пакета входа

research:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: parser_profiles
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/research/parser-profiles/login/{id}

curl -X GET 'https://socbooster.ru/api/v1/research/parser-profiles/login/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/research/parser-profiles/login/{id}/status#

Безопасное состояние пакета входа

research:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`progress`	`anyOf`	Обязательно
`progress.anyOf[1]`	`null`	—
`progress.anyOf[2]`	`object · additionalProperties: false`	—
`progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "required": [
            "completed",
            "total"
          ],
          "additionalProperties": false
        }
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/research/parser-profiles/login/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/research/parser-profiles/login/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/research/campaigns/preview#

Проверить автоответ Research без запуска

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automations
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`videoId`	`string · minLength: 1 · maxLength: 128`	Необязательно
`reelUrl`	`string · uri`	Необязательно
`instagramAccountId`	`string · minLength: 1 · maxLength: 128`	Необязательно
`name`	`string`	Необязательно
`goal`	`string`	Необязательно
`keywords`	`array`	Необязательно
`keywords[]`	`string · minLength: 1 · maxLength: 100`	—
`matchAnyWord`	`boolean`	Необязательно
`dmMessage`	`string · minLength: 1 · maxLength: 1000`	Обязательно
`linkButtonLabel`	`string`	Необязательно
`leadMagnetUrl`	`string`	Необязательно
`publicReplyEnabled`	`boolean`	Необязательно
`publicReplyMessage`	`string`	Необязательно
`followUpEnabled`	`boolean`	Необязательно
`followUpMessage`	`string`	Необязательно
`followUpDelayMinutes`	`integer · minimum: 0 · maximum: 1440`	Необязательно
`isActive`	`boolean`	Необязательно
`dryRun`	`const: true · default: true`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "videoId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "reelUrl": {
      "type": "string",
      "format": "uri"
    },
    "instagramAccountId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "name": {
      "type": "string"
    },
    "goal": {
      "type": "string"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "matchAnyWord": {
      "type": "boolean"
    },
    "dmMessage": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "linkButtonLabel": {
      "type": "string"
    },
    "leadMagnetUrl": {
      "type": "string"
    },
    "publicReplyEnabled": {
      "type": "boolean"
    },
    "publicReplyMessage": {
      "type": "string"
    },
    "followUpEnabled": {
      "type": "boolean"
    },
    "followUpMessage": {
      "type": "string"
    },
    "followUpDelayMinutes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1440
    },
    "isActive": {
      "type": "boolean"
    },
    "dryRun": {
      "const": true,
      "default": true
    }
  },
  "required": [
    "dmMessage"
  ],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/campaigns/preview

curl -X POST 'https://socbooster.ru/api/v1/research/campaigns/preview' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"dmMessage":"YOUR_DMMESSAGE"}'

POST/api/v1/research/campaigns#

Создать автоответ из Reel; dryRun возвращает preview (200)

research:extended:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automations
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`videoId`	`string · minLength: 1 · maxLength: 128`	Необязательно
`reelUrl`	`string · uri`	Необязательно
`instagramAccountId`	`string · minLength: 1 · maxLength: 128`	Необязательно
`name`	`string`	Необязательно
`goal`	`string`	Необязательно
`keywords`	`array`	Необязательно
`keywords[]`	`string · minLength: 1 · maxLength: 100`	—
`matchAnyWord`	`boolean`	Необязательно
`dmMessage`	`string · minLength: 1 · maxLength: 1000`	Обязательно
`linkButtonLabel`	`string`	Необязательно
`leadMagnetUrl`	`string`	Необязательно
`publicReplyEnabled`	`boolean`	Необязательно
`publicReplyMessage`	`string`	Необязательно
`followUpEnabled`	`boolean`	Необязательно
`followUpMessage`	`string`	Необязательно
`followUpDelayMinutes`	`integer · minimum: 0 · maximum: 1440`	Необязательно
`isActive`	`boolean`	Необязательно
`dryRun`	`boolean · default: false`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "videoId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "reelUrl": {
      "type": "string",
      "format": "uri"
    },
    "instagramAccountId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "name": {
      "type": "string"
    },
    "goal": {
      "type": "string"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "matchAnyWord": {
      "type": "boolean"
    },
    "dmMessage": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "linkButtonLabel": {
      "type": "string"
    },
    "leadMagnetUrl": {
      "type": "string"
    },
    "publicReplyEnabled": {
      "type": "boolean"
    },
    "publicReplyMessage": {
      "type": "string"
    },
    "followUpEnabled": {
      "type": "boolean"
    },
    "followUpMessage": {
      "type": "string"
    },
    "followUpDelayMinutes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1440
    },
    "isActive": {
      "type": "boolean"
    },
    "dryRun": {
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "dmMessage"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/research/campaigns

curl -X POST 'https://socbooster.ru/api/v1/research/campaigns' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"dmMessage":"YOUR_DMMESSAGE"}'

GET/api/v1/research/hashtag-runs/{id}/status#

Безопасное состояние исследования хештегов

research:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`progress`	`anyOf`	Обязательно
`progress.anyOf[1]`	`null`	—
`progress.anyOf[2]`	`object · additionalProperties: false`	—
`progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "required": [
            "completed",
            "total"
          ],
          "additionalProperties": false
        }
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/research/hashtag-runs/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/research/hashtag-runs/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/research/reels/hashtags/{id}/status#

Безопасное состояние исследования хештегов

research:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: research:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string · minLength: 1 · maxLength: 128`	Обязательно
`status`	`string`	Обязательно
`progress`	`anyOf`	Обязательно
`progress.anyOf[1]`	`null`	—
`progress.anyOf[2]`	`object · additionalProperties: false`	—
`progress.anyOf[2].completed`	`integer · minimum: 0`	Обязательно
`progress.anyOf[2].total`	`integer \| null · minimum: 0`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "properties": {
            "completed": {
              "type": "integer",
              "minimum": 0
            },
            "total": {
              "type": [
                "integer",
                "null"
              ],
              "minimum": 0
            }
          },
          "required": [
            "completed",
            "total"
          ],
          "additionalProperties": false
        }
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/research/reels/hashtags/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/research/reels/hashtags/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/account#

Рабочее пространство и владелец

account:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: account:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`name`	`string`	Обязательно
`createdAt`	`string · date-time`	Обязательно
`owner`	`object · additionalProperties: false`	Обязательно
`owner.id`	`string`	Обязательно
`owner.name`	`string \| null`	Обязательно
`owner.email`	`string \| null`	Обязательно
`owner.image`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "owner": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "image": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "email",
        "image"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "name",
    "createdAt",
    "owner"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/account

curl -X GET 'https://socbooster.ru/api/v1/account' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/billing#

Тариф, подписка и использование

billing:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: billing:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object"
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/billing

curl -X GET 'https://socbooster.ru/api/v1/billing' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/billing/checkout#

Тарифы, способы оплаты и счета

billing:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: billing:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`plans`	`array`	Обязательно
`plans[]`	`object`	—
`providers`	`array`	Обязательно
`providers[]`	`object`	—
`checkouts`	`array`	Обязательно
`checkouts[]`	`object · additionalProperties: false`	—
`checkouts[].id`	`string`	Обязательно
`checkouts[].provider`	`string`	Обязательно
`checkouts[].testMode`	`boolean`	Обязательно
`checkouts[].status`	`string`	Обязательно
`checkouts[].checkoutUrl`	`string \| null`	Обязательно
`checkouts[].planName`	`string`	Обязательно
`checkouts[].amountMinor`	`integer`	Обязательно
`checkouts[].currency`	`string`	Обязательно
`checkouts[].createdAt`	`string · date-time`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "plans": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "providers": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "checkouts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "testMode": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "checkoutUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "planName": {
            "type": "string"
          },
          "amountMinor": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "provider",
          "testMode",
          "status",
          "checkoutUrl",
          "planName",
          "amountMinor",
          "currency",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "plans",
    "providers",
    "checkouts"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/billing/checkout

curl -X GET 'https://socbooster.ru/api/v1/billing/checkout' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/billing/checkout#

Создать счёт на оплату

billing:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: billing:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`planId`	`string · minLength: 1 · maxLength: 100`	Обязательно
`provider`	`string · enum: "YOOKASSA", "ROBOKASSA", "NOWPAYMENTS"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "provider": {
      "type": "string",
      "enum": [
        "YOOKASSA",
        "ROBOKASSA",
        "NOWPAYMENTS"
      ]
    }
  },
  "required": [
    "planId",
    "provider"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`provider`	`string`	Обязательно
`testMode`	`boolean`	Обязательно
`status`	`string`	Обязательно
`checkoutUrl`	`string \| null`	Обязательно
`planName`	`string`	Обязательно
`amountMinor`	`integer`	Обязательно
`currency`	`string`	Обязательно
`createdAt`	`string · date-time`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "provider": {
      "type": "string"
    },
    "testMode": {
      "type": "boolean"
    },
    "status": {
      "type": "string"
    },
    "checkoutUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "planName": {
      "type": "string"
    },
    "amountMinor": {
      "type": "integer"
    },
    "currency": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "provider",
    "testMode",
    "status",
    "checkoutUrl",
    "planName",
    "amountMinor",
    "currency",
    "createdAt"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/billing/checkout

curl -X POST 'https://socbooster.ru/api/v1/billing/checkout' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"planId":"YOUR_PLANID","provider":"YOOKASSA"}'

GET/api/v1/billing/checkout/{id}#

Счёт без платёжных секретов

billing:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: billing:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`provider`	`string`	Обязательно
`testMode`	`boolean`	Обязательно
`status`	`string`	Обязательно
`checkoutUrl`	`string \| null`	Обязательно
`planName`	`string`	Обязательно
`amountMinor`	`integer`	Обязательно
`currency`	`string`	Обязательно
`createdAt`	`string · date-time`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "provider": {
      "type": "string"
    },
    "testMode": {
      "type": "boolean"
    },
    "status": {
      "type": "string"
    },
    "checkoutUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "planName": {
      "type": "string"
    },
    "amountMinor": {
      "type": "integer"
    },
    "currency": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "provider",
    "testMode",
    "status",
    "checkoutUrl",
    "planName",
    "amountMinor",
    "currency",
    "createdAt"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/billing/checkout/{id}

curl -X GET 'https://socbooster.ru/api/v1/billing/checkout/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/billing/checkout/{id}/status#

Состояние счёта

billing:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: billing:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/billing/checkout/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/billing/checkout/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/affiliates#

Партнёрский кабинет

affiliates:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: affiliates:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`page`	Строка запроса	`integer · minimum: 1 · maximum: 100000 · default: 1`	Необязательно
`withdrawalPage`	Строка запроса	`integer · minimum: 1 · maximum: 100000 · default: 1`	Необязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object"
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/affiliates

curl -X GET 'https://socbooster.ru/api/v1/affiliates?page=1&withdrawalPage=1' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

PATCH/api/v1/affiliates/wallet#

Сохранить или удалить кошелёк владельца

affiliates:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: affiliates:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`walletAddress`	`string \| null · pattern: "^0x[0-9a-fA-F]{40}$"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "walletAddress": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "walletAddress"
  ],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object"
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/affiliates/wallet

curl -X PATCH 'https://socbooster.ru/api/v1/affiliates/wallet' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"walletAddress":"0x0000000000000000000000000000000000000000"}'

POST/api/v1/affiliates/withdrawals#

Создать заявку на вывод

affiliates:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: affiliates:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`currency`	`string · pattern: "^[A-Z]{3}$"`	Обязательно
`amountMinor`	`string · pattern: "^[1-9][0-9]{0,15}$"`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$"
    },
    "amountMinor": {
      "type": "string",
      "pattern": "^[1-9][0-9]{0,15}$"
    }
  },
  "required": [
    "currency",
    "amountMinor"
  ],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`currency`	`string`	Обязательно
`amountMinor`	`string`	Обязательно
`usdtCents`	`string`	Обязательно
`walletAddress`	`string`	Обязательно
`exchangeRate`	`string`	Обязательно
`status`	`string`	Обязательно
`txHash`	`string \| null`	Обязательно
`adminNote`	`string \| null`	Обязательно
`createdAt`	`string · date-time`	Обязательно
`dueAt`	`string · date-time`	Обязательно
`paidAt`	`string \| null · date-time`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "amountMinor": {
      "type": "string"
    },
    "usdtCents": {
      "type": "string"
    },
    "walletAddress": {
      "type": "string"
    },
    "exchangeRate": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "txHash": {
      "type": [
        "string",
        "null"
      ]
    },
    "adminNote": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "dueAt": {
      "type": "string",
      "format": "date-time"
    },
    "paidAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "currency",
    "amountMinor",
    "usdtCents",
    "walletAddress",
    "exchangeRate",
    "status",
    "txHash",
    "adminNote",
    "createdAt",
    "dueAt",
    "paidAt"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/affiliates/withdrawals

curl -X POST 'https://socbooster.ru/api/v1/affiliates/withdrawals' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"currency":"USD","amountMinor":"1000"}'

GET/api/v1/affiliates/withdrawals/{id}/status#

Состояние заявки на вывод

affiliates:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: affiliates:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/affiliates/withdrawals/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/affiliates/withdrawals/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/instagram/connection-attempts#

Начать подключение с подтверждением владельца в браузере

instagram:extended:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:extended:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 201 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Полная JSON Schema

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Ответ · 201

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string · enum: "PENDING", "PROCESSING", "SUCCEEDED", "FAILED", "EXPIRED", "UNKNOWN"`	Обязательно
`expiresAt`	`string · date-time`	Обязательно
`instagramAccountId`	`string \| null`	Обязательно
`errorCode`	`string \| null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`confirmationUrl`	`string · uri`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PROCESSING",
        "SUCCEEDED",
        "FAILED",
        "EXPIRED",
        "UNKNOWN"
      ]
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "instagramAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "confirmationUrl": {
      "type": "string",
      "format": "uri"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "expiresAt",
    "instagramAccountId",
    "errorCode",
    "updatedAt",
    "confirmationUrl",
    "statusUrl"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/instagram/connection-attempts

curl -X POST 'https://socbooster.ru/api/v1/instagram/connection-attempts' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{}'

GET/api/v1/instagram/connection-attempts/{id}#

Попытка подключения Instagram

instagram:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string · enum: "PENDING", "PROCESSING", "SUCCEEDED", "FAILED", "EXPIRED", "UNKNOWN"`	Обязательно
`expiresAt`	`string · date-time`	Обязательно
`instagramAccountId`	`string \| null`	Обязательно
`errorCode`	`string \| null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`confirmationUrl`	`string · uri`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PROCESSING",
        "SUCCEEDED",
        "FAILED",
        "EXPIRED",
        "UNKNOWN"
      ]
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "instagramAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "confirmationUrl": {
      "type": "string",
      "format": "uri"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "expiresAt",
    "instagramAccountId",
    "errorCode",
    "updatedAt",
    "confirmationUrl",
    "statusUrl"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/connection-attempts/{id}

curl -X GET 'https://socbooster.ru/api/v1/instagram/connection-attempts/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/instagram/connection-attempts/{id}/status#

Состояние подключения Instagram

instagram:extended:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:extended:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/connection-attempts/{id}/status

curl -X GET 'https://socbooster.ru/api/v1/instagram/connection-attempts/YOUR_ID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/instagram/disconnect#

Отключить указанный или все аккаунты Instagram

instagram:extended:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:extended:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`instagramAccountId`	`string · minLength: 1 · maxLength: 200`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "instagramAccountId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [],
  "additionalProperties": false
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`disconnected`	`const: true`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "disconnected": {
      "const": true
    }
  },
  "required": [
    "disconnected"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/instagram/disconnect

curl -X POST 'https://socbooster.ru/api/v1/instagram/disconnect' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"instagramAccountId":"YOUR_INSTAGRAMACCOUNTID"}'

GET/api/v1/instagram/profile#

Профиль Instagram

instagram:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: instagram_profile_view
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`username`	`string`	Необязательно
`name`	`string \| null`	Необязательно
`profilePictureUrl`	`string \| null`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "profilePictureUrl": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/profile

curl -X GET 'https://socbooster.ru/api/v1/instagram/profile' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/instagram/overview#

Обзор публикаций Instagram

instagram:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: instagram:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: publication_analytics
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object",
  "properties": {}
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/overview

curl -X GET 'https://socbooster.ru/api/v1/instagram/overview' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/instagram/conversations#

Список переписок

inbox:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: inbox:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: inbox
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`conversations`	`array`	Необязательно
`conversations[]`	`object`	—
`conversations[].id`	`string`	Необязательно
`account`	`object`	Необязательно
`account.id`	`string`	Необязательно
`account.username`	`string`	Необязательно
`account.instagramId`	`string`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "conversations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      }
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "instagramId": {
          "type": "string"
        }
      }
    }
  }
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/conversations

curl -X GET 'https://socbooster.ru/api/v1/instagram/conversations' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/instagram/conversations#

Отправить DM; UUID Idempotency-Key обязателен

inbox:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: inbox:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: inbox
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`instagramAccountId`	`string`	Обязательно
`recipientId`	`string`	Обязательно
`text`	`string · minLength: 1 · maxLength: 1000`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "instagramAccountId": {
      "type": "string"
    },
    "recipientId": {
      "type": "string"
    },
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    }
  },
  "required": [
    "instagramAccountId",
    "recipientId",
    "text"
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object",
  "properties": {}
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/instagram/conversations

curl -X POST 'https://socbooster.ru/api/v1/instagram/conversations' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"instagramAccountId":"YOUR_INSTAGRAMACCOUNTID","recipientId":"YOUR_RECIPIENTID","text":"YOUR_TEXT"}'

GET/api/v1/instagram/conversations/{id}#

Сообщения переписки

inbox:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: inbox:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: inbox
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`id`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`messages`	`array`	Необязательно
`messages[]`	`object`	—
`messages[].id`	`string`	Необязательно
`messages[].text`	`string`	Необязательно
`messages[].fromMe`	`boolean`	Необязательно
`messages[].createdTime`	`string \| null`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "fromMe": {
            "type": "boolean"
          },
          "createdTime": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/instagram/conversations/{id}

curl -X GET 'https://socbooster.ru/api/v1/instagram/conversations/YOUR_ID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/dashboard/stats#

Расширенная статистика; recentLogs требует logs:read

analytics:extended:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: analytics:extended:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: automation_analytics
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object",
  "properties": {}
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/dashboard/stats

curl -X GET 'https://socbooster.ru/api/v1/dashboard/stats' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/logs#

Пользовательский журнал сообщений

logs:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: logs:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: message_logs
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`logs`	`array`	Необязательно
`logs[]`	`object`	—
`logs[].id`	`string`	Необязательно
`pagination`	`object`	Необязательно
`pagination.page`	`integer`	Необязательно
`pagination.limit`	`integer`	Необязательно
`pagination.total`	`integer`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "page": {
          "type": "integer"
        },
        "limit": {
          "type": "integer"
        },
        "total": {
          "type": "integer"
        }
      }
    }
  }
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/logs

curl -X GET 'https://socbooster.ru/api/v1/logs' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/content-lab/eligibility#

Доступность создания серии

content-lab:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: content_lab
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`instagramAccountId`	Строка запроса	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object"
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/content-lab/eligibility

curl -X GET 'https://socbooster.ru/api/v1/content-lab/eligibility?instagramAccountId=YOUR_INSTAGRAMACCOUNTID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/content-lab/account-analysis#

Последние или лучшие Reels аккаунта

content-lab:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: profile_analysis
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`instagramAccountId`	Строка запроса	`string`	Необязательно
`mode`	Строка запроса	`enum: "recent", "top" · default: "top"`	Необязательно
`after`	Строка запроса	`string · maxLength: 4096`	Необязательно
`remaining`	Строка запроса	`integer · minimum: 1 · maximum: 24`	Необязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Полная JSON Schema

{
  "type": "object"
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/content-lab/account-analysis

curl -X GET 'https://socbooster.ru/api/v1/content-lab/account-analysis?mode=recent' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/content-lab/account-analysis#

Создать серию из Reel

content-lab:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: profile_analysis
Idempotency-Key: UUID · Обязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`instagramAccountId`	`string`	Обязательно
`mediaId`	`string`	Обязательно
`sourceCursor`	`string · maxLength: 4096`	Необязательно
`requestedVariantCount`	`integer · minimum: 1 · maximum: 20`	Обязательно
`caption`	`string · maxLength: 2200`	Необязательно
`captionMode`	`string · enum: "ORIGINAL", "AI" · default: "ORIGINAL"`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "instagramAccountId": {
      "type": "string"
    },
    "mediaId": {
      "type": "string"
    },
    "sourceCursor": {
      "type": "string",
      "maxLength": 4096
    },
    "requestedVariantCount": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "caption": {
      "type": "string",
      "maxLength": 2200
    },
    "captionMode": {
      "type": "string",
      "enum": [
        "ORIGINAL",
        "AI"
      ],
      "default": "ORIGINAL"
    }
  },
  "required": [
    "instagramAccountId",
    "mediaId",
    "requestedVariantCount"
  ]
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`experiment`	`object`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "experiment": {
      "type": "object"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "experiment",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/content-lab/account-analysis

curl -X POST 'https://socbooster.ru/api/v1/content-lab/account-analysis' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"instagramAccountId":"YOUR_INSTAGRAMACCOUNTID","mediaId":"YOUR_MEDIAID","requestedVariantCount":1}'

GET/api/v1/content-lab/analytics#

Аналитика публикаций серии

content-lab:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: publication_analytics
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`cursor`	Строка запроса	`string · maxLength: 128`	Необязательно
`limit`	Строка запроса	`integer · minimum: 1 · maximum: 100 · default: 50`	Необязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`pagination`	`object`	Необязательно
`freshness`	`object`	Необязательно
`incompletePage`	`boolean`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "pagination": {
      "type": "object"
    },
    "freshness": {
      "type": "object"
    },
    "incompletePage": {
      "type": "boolean"
    }
  }
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/content-lab/analytics

curl -X GET 'https://socbooster.ru/api/v1/content-lab/analytics?limit=50' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/content-lab/experiments#

Список серий

content-lab:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: content_lab
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`experiments`	`array`	Обязательно
`experiments[]`	`object`	—

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "experiments": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "experiments"
  ]
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/content-lab/experiments

curl -X GET 'https://socbooster.ru/api/v1/content-lab/experiments' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/content-lab/experiments#

Создать серию из видео

content-lab:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: series_create
Idempotency-Key: UUID · Обязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

multipart/form-data

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`instagramAccountId`	`string`	Обязательно
`requestedVariantCount`	`integer · minimum: 1 · maximum: 20`	Обязательно
`caption`	`string · maxLength: 2200`	Необязательно
`captionMode`	`string · enum: "ORIGINAL", "AI" · default: "ORIGINAL"`	Необязательно
`file`	`string · binary`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "instagramAccountId": {
      "type": "string"
    },
    "requestedVariantCount": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "caption": {
      "type": "string",
      "maxLength": 2200
    },
    "captionMode": {
      "type": "string",
      "enum": [
        "ORIGINAL",
        "AI"
      ],
      "default": "ORIGINAL"
    },
    "file": {
      "type": "string",
      "format": "binary"
    }
  },
  "required": [
    "instagramAccountId",
    "requestedVariantCount",
    "file"
  ]
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`experiment`	`object`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "experiment": {
      "type": "object"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "experiment",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/content-lab/experiments

curl -X POST 'https://socbooster.ru/api/v1/content-lab/experiments' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  --form-string 'instagramAccountId=YOUR_INSTAGRAMACCOUNTID' \
  --form-string 'requestedVariantCount=1' \
  -F 'file=@./video.mp4'

GET/api/v1/content-lab/experiments/{experimentId}#

Серия и варианты

content-lab:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: content_lab
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`experimentId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`experiment`	`object`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "experiment": {
      "type": "object"
    }
  },
  "required": [
    "experiment"
  ]
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/content-lab/experiments/{experimentId}

curl -X GET 'https://socbooster.ru/api/v1/content-lab/experiments/YOUR_EXPERIMENTID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/content-lab/experiments/{experimentId}/status#

Безопасное состояние серии

content-lab:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`experimentId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/content-lab/experiments/{experimentId}/status

curl -X GET 'https://socbooster.ru/api/v1/content-lab/experiments/YOUR_EXPERIMENTID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/content-lab/experiments/{experimentId}/plan#

Запланировать варианты серии

content-lab:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: publication_scheduling
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`experimentId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`startAtUtc`	`string · date-time`	Обязательно
`intervalMinutes`	`integer · minimum: 1 · maximum: 10080`	Обязательно
`jitterMinutes`	`integer · minimum: 0 · maximum: 30 · default: 0`	Необязательно
`scheduleTimezone`	`string · default: "UTC"`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "startAtUtc": {
      "type": "string",
      "format": "date-time"
    },
    "intervalMinutes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10080
    },
    "jitterMinutes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 30,
      "default": 0
    },
    "scheduleTimezone": {
      "type": "string",
      "default": "UTC"
    }
  },
  "required": [
    "startAtUtc",
    "intervalMinutes"
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`publications`	`array`	Обязательно
`publications[]`	`object`	—
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "publications": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "publications",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/content-lab/experiments/{experimentId}/plan

curl -X POST 'https://socbooster.ru/api/v1/content-lab/experiments/YOUR_EXPERIMENTID/plan' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"startAtUtc":"2030-01-01T12:00:00Z","intervalMinutes":1}'

PATCH/api/v1/content-lab/experiments/{experimentId}/variants/{variantId}/caption#

Изменить описание варианта

content-lab:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: caption_editing
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`experimentId`	Путь	`string`	Обязательно
`variantId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`caption`	`string · maxLength: 2200`	Обязательно
`captionVersion`	`integer · minimum: 0`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "caption": {
      "type": "string",
      "maxLength": 2200
    },
    "captionVersion": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "caption",
    "captionVersion"
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`variant`	`object`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "variant": {
      "type": "object"
    }
  },
  "required": [
    "variant"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/content-lab/experiments/{experimentId}/variants/{variantId}/caption

curl -X PATCH 'https://socbooster.ru/api/v1/content-lab/experiments/YOUR_EXPERIMENTID/variants/YOUR_VARIANTID/caption' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"caption":"YOUR_CAPTION","captionVersion":0}'

POST/api/v1/content-lab/experiments/{experimentId}/variants/{variantId}/schedule#

Запланировать вариант

content-lab:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: publication_scheduling
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`experimentId`	Путь	`string`	Обязательно
`variantId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`scheduledAtUtc`	`string · date-time`	Обязательно
`scheduleTimezone`	`string`	Обязательно
`caption`	`string · maxLength: 2200`	Необязательно
`captionVersion`	`integer · minimum: 0`	Необязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "scheduledAtUtc": {
      "type": "string",
      "format": "date-time"
    },
    "scheduleTimezone": {
      "type": "string"
    },
    "caption": {
      "type": "string",
      "maxLength": 2200
    },
    "captionVersion": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "scheduledAtUtc",
    "scheduleTimezone"
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`publication`	`object`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "publication": {
      "type": "object"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "publication",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/content-lab/experiments/{experimentId}/variants/{variantId}/schedule

curl -X POST 'https://socbooster.ru/api/v1/content-lab/experiments/YOUR_EXPERIMENTID/variants/YOUR_VARIANTID/schedule' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"scheduledAtUtc":"2030-01-01T12:00:00Z","scheduleTimezone":"UTC"}'

POST/api/v1/content-lab/experiments/{experimentId}/variants/{variantId}/cancel#

Отменить публикацию варианта

content-lab:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: content-lab:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`experimentId`	Путь	`string`	Обязательно
`variantId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/content-lab/experiments/{experimentId}/variants/{variantId}/cancel

curl -X POST 'https://socbooster.ru/api/v1/content-lab/experiments/YOUR_EXPERIMENTID/variants/YOUR_VARIANTID/cancel' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"

GET/api/v1/publishing/posts#

Список публикаций

publishing:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: publishing:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: instagram_publishing
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`posts`	`array`	Обязательно
`posts[]`	`object`	—

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "posts": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "posts"
  ]
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/publishing/posts

curl -X GET 'https://socbooster.ru/api/v1/publishing/posts' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

POST/api/v1/publishing/posts#

Загрузить и запланировать публикацию

publishing:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: publishing:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: publication_scheduling
Idempotency-Key: UUID · Обязательно
HTTP: 202 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

multipart/form-data

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`instagramAccountId`	`string`	Обязательно
`caption`	`string · maxLength: 2200`	Необязательно
`file`	`string · binary`	Обязательно
`publicationTarget`	`string · enum: "TRIAL", "PROFILE"`	Обязательно
`scheduledAtUtc`	`string · date-time`	Обязательно
`scheduleTimezone`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "instagramAccountId": {
      "type": "string"
    },
    "caption": {
      "type": "string",
      "maxLength": 2200
    },
    "file": {
      "type": "string",
      "format": "binary"
    },
    "publicationTarget": {
      "type": "string",
      "enum": [
        "TRIAL",
        "PROFILE"
      ]
    },
    "scheduledAtUtc": {
      "type": "string",
      "format": "date-time"
    },
    "scheduleTimezone": {
      "type": "string"
    }
  },
  "required": [
    "instagramAccountId",
    "file",
    "publicationTarget",
    "scheduledAtUtc",
    "scheduleTimezone"
  ]
}

Ответ · 202

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`post`	`object`	Обязательно
`schedulingError`	`string \| null`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "post": {
      "type": "object"
    },
    "schedulingError": {
      "type": [
        "string",
        "null"
      ]
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "post",
    "schedulingError",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/publishing/posts

curl -X POST 'https://socbooster.ru/api/v1/publishing/posts' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  --form-string 'instagramAccountId=YOUR_INSTAGRAMACCOUNTID' \
  -F 'file=@./video.mp4' \
  --form-string 'publicationTarget=TRIAL' \
  --form-string 'scheduledAtUtc=2030-01-01T12:00:00Z' \
  --form-string 'scheduleTimezone=UTC'

GET/api/v1/publishing/posts/{postId}#

Публикация

publishing:read · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: publishing:read
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: instagram_publishing
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`postId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`post`	`object`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "post": {
      "type": "object"
    }
  },
  "required": [
    "post"
  ]
}

Ответы и ошибки: 400, 401, 402, 403, 404, 429, 503

Пример curl

GET /api/v1/publishing/posts/{postId}

curl -X GET 'https://socbooster.ru/api/v1/publishing/posts/YOUR_POSTID' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

GET/api/v1/publishing/posts/{postId}/status#

Безопасное состояние публикации

publishing:read · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: publishing:read
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: Не указано в реестре
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`postId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Ответы и ошибки: 400, 401, 403, 404, 429, 503

Пример curl

GET /api/v1/publishing/posts/{postId}/status

curl -X GET 'https://socbooster.ru/api/v1/publishing/posts/YOUR_POSTID/status' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY"

PATCH/api/v1/publishing/posts/{postId}/reschedule#

Перенести публикацию

publishing:write · Рабочий запрос · 1 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: publishing:write
api_requests: Рабочий запрос · 1 api_requests
Функция тарифа: publication_scheduling
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`postId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`scheduledAtUtc`	`string · date-time`	Обязательно
`scheduleTimezone`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "scheduledAtUtc": {
      "type": "string",
      "format": "date-time"
    },
    "scheduleTimezone": {
      "type": "string"
    }
  },
  "required": [
    "scheduledAtUtc",
    "scheduleTimezone"
  ]
}

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`post`	`object`	Обязательно
`statusUrl`	`string`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "post": {
      "type": "object"
    },
    "statusUrl": {
      "type": "string"
    }
  },
  "required": [
    "post",
    "statusUrl"
  ]
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 402, 403, 404, 409, 429, 503

Пример curl

PATCH /api/v1/publishing/posts/{postId}/reschedule

curl -X PATCH 'https://socbooster.ru/api/v1/publishing/posts/YOUR_POSTID/reschedule' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc" \
  -H "Content-Type: application/json" \
  --data '{"scheduledAtUtc":"2030-01-01T12:00:00Z","scheduleTimezone":"UTC"}'

POST/api/v1/publishing/posts/{postId}/cancel#

Отменить публикацию

publishing:write · Обслуживание · 0 api_requests

Условия доступа · Параметры · Поля схемы

Условия доступа

Право: publishing:write
api_requests: Обслуживание · 0 api_requests
Idempotency-Key: UUID · Обязательно
HTTP: 200 · application/json

Параметры

Поле	Расположение	Тип и ограничения	Обязательно
`postId`	Путь	`string`	Обязательно
`Authorization`	Заголовок	`string · examples: ["Bearer rr_live_..."]`	Обязательно
`Idempotency-Key`	Заголовок	`string · uuid`	Обязательно

Тело запроса

application/json

Ответ · 200

Схема ниже описывает data внутри JSON-ответа.

Тип и ограничения: object · additionalProperties: false

Обязательность вложенного поля действует, когда передан его родительский объект.

Поля схемы	Тип и ограничения	Обязательно
`id`	`string`	Обязательно
`status`	`string`	Обязательно
`progress`	`null`	Обязательно
`updatedAt`	`string · date-time`	Обязательно
`errorCode`	`string \| null`	Обязательно

Полная JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "progress": {
      "type": "null"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "progress",
    "updatedAt",
    "errorCode"
  ],
  "additionalProperties": false
}

Повтор может вернуть сохранённый ответ с Idempotency-Replayed: true либо HTTP 202 со statusUrl, если результат ещё не известен.

Ответы и ошибки: 400, 401, 403, 404, 409, 429, 503

Пример curl

POST /api/v1/publishing/posts/{postId}/cancel

curl -X POST 'https://socbooster.ru/api/v1/publishing/posts/YOUR_POSTID/cancel' \
  -H "Authorization: Bearer $SOCBOOSTER_API_KEY" \
  -H "Idempotency-Key: 7b8272e6-6546-4bfa-9b78-a341751630fc"