Схемы и разрешения получены из реестра MCP. Доступный клиенту набор зависит от его scopes и настроек сервиса.
Список автоответов. Расширенные ссылки, отчёты и аналитика требуют campaigns:extended:read.
Аккаунт и взаимодействия Чтение
Разрешения: campaigns:read
operationId: campaigns.list
GET /campaigns
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramAccountId": {
"type": "string"
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingNextReel": {
"type": "boolean"
},
"matchAnyPost": {
"type": "boolean"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmTriggerEnabled": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"openingDmEnabled": {
"type": "boolean"
},
"openingDmMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openingDmButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requireFollow": {
"type": "boolean"
},
"followPromptMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followPromptButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "number"
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessages": {
"type": "array",
"items": {
"type": "string"
}
},
"isActive": {
"type": "boolean"
},
"wholeWordMatch": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"instagramAccount": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"instagramId": {
"type": "string"
}
},
"required": [
"id",
"username",
"instagramId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"_count": {
"type": "object",
"properties": {
"dmLogs": {
"type": "number"
}
},
"required": [
"dmLogs"
],
"additionalProperties": false
},
"trackedLink": {
"anyOf": [
{
"type": "object",
"properties": {
"destinationUrl": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"destinationUrl",
"label"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"trackedLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"destinationUrl": {
"type": "string"
},
"slug": {
"type": "string"
},
"trackedUrl": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"automationId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"_count": {
"type": "object",
"properties": {
"clicks": {
"type": "number"
}
},
"required": [
"clicks"
],
"additionalProperties": false
}
},
"required": [
"id",
"label",
"destinationUrl",
"slug",
"trackedUrl"
],
"additionalProperties": false
}
},
"reportShareEnabled": {
"type": "boolean"
},
"reportShareSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "number"
},
"skipped": {
"type": "number"
},
"failed": {
"type": "number"
},
"clicks": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ctr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"topKeywords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"keyword",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"sent",
"skipped",
"failed",
"clicks",
"ctr",
"topKeywords"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"goal",
"instagramAccountId",
"postId",
"postUrl",
"pendingNextReel",
"matchAnyPost",
"keywords",
"matchAnyWord",
"dmTriggerEnabled",
"dmMessage",
"openingDmEnabled",
"openingDmMessage",
"openingDmButtonLabel",
"linkButtonLabel",
"requireFollow",
"followPromptMessage",
"followPromptButtonLabel",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"publicReplyEnabled",
"publicReplyMessages",
"isActive",
"wholeWordMatch",
"createdAt",
"updatedAt",
"trackedLink"
],
"additionalProperties": false
}
}Получить автоответ рабочего пространства.
Аккаунт и взаимодействия Чтение
Разрешения: campaigns:read
operationId: campaigns.get
GET /campaigns/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramAccountId": {
"type": "string"
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingNextReel": {
"type": "boolean"
},
"matchAnyPost": {
"type": "boolean"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmTriggerEnabled": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"openingDmEnabled": {
"type": "boolean"
},
"openingDmMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openingDmButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requireFollow": {
"type": "boolean"
},
"followPromptMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followPromptButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "number"
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessages": {
"type": "array",
"items": {
"type": "string"
}
},
"isActive": {
"type": "boolean"
},
"wholeWordMatch": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"instagramAccount": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"instagramId": {
"type": "string"
}
},
"required": [
"id",
"username",
"instagramId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"_count": {
"type": "object",
"properties": {
"dmLogs": {
"type": "number"
}
},
"required": [
"dmLogs"
],
"additionalProperties": false
},
"trackedLink": {
"anyOf": [
{
"type": "object",
"properties": {
"destinationUrl": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"destinationUrl",
"label"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"trackedLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"destinationUrl": {
"type": "string"
},
"slug": {
"type": "string"
},
"trackedUrl": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"automationId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"_count": {
"type": "object",
"properties": {
"clicks": {
"type": "number"
}
},
"required": [
"clicks"
],
"additionalProperties": false
}
},
"required": [
"id",
"label",
"destinationUrl",
"slug",
"trackedUrl"
],
"additionalProperties": false
}
},
"reportShareEnabled": {
"type": "boolean"
},
"reportShareSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "number"
},
"skipped": {
"type": "number"
},
"failed": {
"type": "number"
},
"clicks": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ctr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"topKeywords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"keyword",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"sent",
"skipped",
"failed",
"clicks",
"ctr",
"topKeywords"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"goal",
"instagramAccountId",
"postId",
"postUrl",
"pendingNextReel",
"matchAnyPost",
"keywords",
"matchAnyWord",
"dmTriggerEnabled",
"dmMessage",
"openingDmEnabled",
"openingDmMessage",
"openingDmButtonLabel",
"linkButtonLabel",
"requireFollow",
"followPromptMessage",
"followPromptButtonLabel",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"publicReplyEnabled",
"publicReplyMessages",
"isActive",
"wholeWordMatch",
"createdAt",
"updatedAt",
"trackedLink"
],
"additionalProperties": false
}Создать автоответ. Дополнительная ссылка и публичный отчёт требуют campaigns:extended:write.
Аккаунт и взаимодействия Изменяет данные
Разрешения: campaigns:write
operationId: campaigns.create
POST /campaigns
Входные параметры · Результат Входные параметры Скопировать
{
"$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": {
"type": "boolean"
}
},
"required": [
"name",
"dmMessage"
],
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramAccountId": {
"type": "string"
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingNextReel": {
"type": "boolean"
},
"matchAnyPost": {
"type": "boolean"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmTriggerEnabled": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"openingDmEnabled": {
"type": "boolean"
},
"openingDmMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openingDmButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requireFollow": {
"type": "boolean"
},
"followPromptMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followPromptButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "number"
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessages": {
"type": "array",
"items": {
"type": "string"
}
},
"isActive": {
"type": "boolean"
},
"wholeWordMatch": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"instagramAccount": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"instagramId": {
"type": "string"
}
},
"required": [
"id",
"username",
"instagramId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"_count": {
"type": "object",
"properties": {
"dmLogs": {
"type": "number"
}
},
"required": [
"dmLogs"
],
"additionalProperties": false
},
"trackedLink": {
"anyOf": [
{
"type": "object",
"properties": {
"destinationUrl": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"destinationUrl",
"label"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"trackedLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"destinationUrl": {
"type": "string"
},
"slug": {
"type": "string"
},
"trackedUrl": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"automationId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"_count": {
"type": "object",
"properties": {
"clicks": {
"type": "number"
}
},
"required": [
"clicks"
],
"additionalProperties": false
}
},
"required": [
"id",
"label",
"destinationUrl",
"slug",
"trackedUrl"
],
"additionalProperties": false
}
},
"reportShareEnabled": {
"type": "boolean"
},
"reportShareSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "number"
},
"skipped": {
"type": "number"
},
"failed": {
"type": "number"
},
"clicks": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ctr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"topKeywords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"keyword",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"sent",
"skipped",
"failed",
"clicks",
"ctr",
"topKeywords"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"goal",
"instagramAccountId",
"postId",
"postUrl",
"pendingNextReel",
"matchAnyPost",
"keywords",
"matchAnyWord",
"dmTriggerEnabled",
"dmMessage",
"openingDmEnabled",
"openingDmMessage",
"openingDmButtonLabel",
"linkButtonLabel",
"requireFollow",
"followPromptMessage",
"followPromptButtonLabel",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"publicReplyEnabled",
"publicReplyMessages",
"isActive",
"wholeWordMatch",
"createdAt",
"updatedAt",
"trackedLink"
],
"additionalProperties": false
}Изменить автоответ. Для отключения используйте отдельные инструменты обслуживания.
Аккаунт и взаимодействия Изменяет данные
Разрешения: campaigns:write
operationId: campaigns.update
PATCH /campaigns/{id}
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"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"
}
},
"required": [
"id"
],
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramAccountId": {
"type": "string"
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingNextReel": {
"type": "boolean"
},
"matchAnyPost": {
"type": "boolean"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmTriggerEnabled": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"openingDmEnabled": {
"type": "boolean"
},
"openingDmMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openingDmButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requireFollow": {
"type": "boolean"
},
"followPromptMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followPromptButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "number"
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessages": {
"type": "array",
"items": {
"type": "string"
}
},
"isActive": {
"type": "boolean"
},
"wholeWordMatch": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"instagramAccount": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"instagramId": {
"type": "string"
}
},
"required": [
"id",
"username",
"instagramId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"_count": {
"type": "object",
"properties": {
"dmLogs": {
"type": "number"
}
},
"required": [
"dmLogs"
],
"additionalProperties": false
},
"trackedLink": {
"anyOf": [
{
"type": "object",
"properties": {
"destinationUrl": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"destinationUrl",
"label"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"trackedLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"destinationUrl": {
"type": "string"
},
"slug": {
"type": "string"
},
"trackedUrl": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"automationId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"_count": {
"type": "object",
"properties": {
"clicks": {
"type": "number"
}
},
"required": [
"clicks"
],
"additionalProperties": false
}
},
"required": [
"id",
"label",
"destinationUrl",
"slug",
"trackedUrl"
],
"additionalProperties": false
}
},
"reportShareEnabled": {
"type": "boolean"
},
"reportShareSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"analytics": {
"type": "object",
"properties": {
"sent": {
"type": "number"
},
"skipped": {
"type": "number"
},
"failed": {
"type": "number"
},
"clicks": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ctr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"topKeywords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"keyword",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"sent",
"skipped",
"failed",
"clicks",
"ctr",
"topKeywords"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"goal",
"instagramAccountId",
"postId",
"postUrl",
"pendingNextReel",
"matchAnyPost",
"keywords",
"matchAnyWord",
"dmTriggerEnabled",
"dmMessage",
"openingDmEnabled",
"openingDmMessage",
"openingDmButtonLabel",
"linkButtonLabel",
"requireFollow",
"followPromptMessage",
"followPromptButtonLabel",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"publicReplyEnabled",
"publicReplyMessages",
"isActive",
"wholeWordMatch",
"createdAt",
"updatedAt",
"trackedLink"
],
"additionalProperties": false
}Удалить автоответ и связанные данные.
Аккаунт и взаимодействия Изменяет данные
Разрешения: campaigns:write
operationId: campaigns.delete
DELETE /campaigns/{id}
Входные параметры · Результат Импортировать до 200 автоответов с отчётом о созданных и пропущенных строках.
Аккаунт и взаимодействия Изменяет данные
Разрешения: campaigns:extended:write
operationId: campaigns.import
POST /campaigns/import
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"instagramAccountId": {
"type": "string",
"minLength": 1
},
"campaigns": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"postId": {
"type": "string",
"minLength": 1
},
"postUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keywords": {
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"dmMessage": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"goal": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"publicReplyMessage": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"trackedUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"wholeWordMatch": {
"default": true,
"type": "boolean"
},
"isActive": {
"default": true,
"type": "boolean"
}
},
"required": [
"postId",
"keywords",
"dmMessage"
]
}
}
},
"required": [
"instagramAccountId",
"campaigns"
],
"additionalProperties": false
}Минимальный статус автоответа, доступный без действующего тарифа.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: campaigns:extended:read
operationId: campaigns.status
GET /campaigns/{id}/status
Входные параметры · Результат Отключить автоответ и/или публичный отчёт. Разрешены только isActive:false и reportShareEnabled:false.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: campaigns:extended:write
operationId: campaigns.disable
PATCH /campaigns/{id}/disable
Входные параметры · Результат Отключить автоответ; другие поля запрещены.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: campaigns:write
operationId: campaigns.update
PATCH /campaigns/{id}
Входные параметры · Результат Отключить публичный отчёт автоответа; другие поля запрещены.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: campaigns:extended:write
operationId: campaigns.update
PATCH /campaigns/{id}
Входные параметры · Результат Подключённые аккаунты Instagram без токенов доступа.
Аккаунт и взаимодействия Чтение
Разрешения: instagram:read
operationId: instagram.accounts.list
GET /instagram/accounts
Входные параметры · Результат Последние публикации Instagram, от 1 до 50.
Аккаунт и взаимодействия Чтение
Разрешения: instagram:read
operationId: instagram.posts.list
GET /instagram/posts
Входные параметры · Результат Имя и аватар подключённого Instagram.
Аккаунт и взаимодействия Чтение
Разрешения: instagram:extended:read
operationId: instagram.profile.get
GET /instagram/profile
Входные параметры · Результат Статистика публикаций и история подписчиков. Обновление расходует analytics_refreshes; максимум 500 публикаций.
Аккаунт и взаимодействия Чтение
Разрешения: instagram:extended:read
operationId: instagram.overview.get
GET /instagram/overview
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
}
},
"requestedCount": {
"anyOf": [
{
"type": "string",
"const": "all"
},
{
"type": "number"
}
]
},
"truncated": {
"type": "boolean"
},
"insightsAvailable": {
"type": "boolean"
},
"followers": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followerHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"followers": {
"type": "number"
},
"delta": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"date",
"followers",
"delta"
],
"additionalProperties": false
}
},
"totals": {
"type": "object",
"properties": {
"posts": {
"type": "number"
},
"views": {
"type": "number"
},
"reach": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
},
"saved": {
"type": "number"
},
"shares": {
"type": "number"
},
"interactions": {
"type": "number"
}
},
"required": [
"posts",
"views",
"reach",
"likes",
"comments",
"saved",
"shares",
"interactions"
],
"additionalProperties": false
},
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"permalink": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"thumbnailUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mediaType": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reach": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
},
"saved": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"caption",
"permalink",
"thumbnailUrl",
"mediaType",
"timestamp",
"views",
"reach",
"likes",
"comments",
"saved",
"shares"
],
"additionalProperties": false
}
}
},
"required": [
"account",
"accounts",
"requestedCount",
"truncated",
"insightsAvailable",
"followers",
"followerHistory",
"totals",
"posts"
],
"additionalProperties": false
}Список переписок подключённого Instagram.
Аккаунт и взаимодействия Чтение
Разрешения: inbox:read
operationId: inbox.conversations.list
GET /instagram/conversations
Входные параметры · Результат Последние 20 сообщений переписки в хронологическом порядке.
Аккаунт и взаимодействия Чтение
Разрешения: inbox:read
operationId: inbox.conversations.get
GET /instagram/conversations/{id}
Входные параметры · Результат Отправить DM; расходует dm_sent. При неизвестном результате проверьте переписку перед новым запросом.
Аккаунт и взаимодействия Изменяет данные
Разрешения: inbox:write
operationId: inbox.send
POST /instagram/conversations
Входные параметры · Результат Сводная аналитика автоответов за текущий месяц.
Аккаунт и взаимодействия Чтение
Разрешения: analytics:read
operationId: analytics.summary
GET /analytics/summary
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"period": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
},
"campaigns": {
"type": "number"
},
"activeCampaigns": {
"type": "number"
},
"dms": {
"type": "object",
"properties": {
"sent": {
"type": "number"
},
"skipped": {
"type": "number"
},
"failed": {
"type": "number"
}
},
"required": [
"sent",
"skipped",
"failed"
],
"additionalProperties": false
},
"clicks": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ctr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"topKeywords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"keyword",
"count"
],
"additionalProperties": false
}
}
},
"required": [
"period",
"campaigns",
"activeCampaigns",
"dms",
"clicks",
"ctr",
"topKeywords"
],
"additionalProperties": false
}Статистика рабочего пространства; recentLogs возвращается только с logs:read.
Аккаунт и взаимодействия Чтение
Разрешения: analytics:extended:read
operationId: analytics.dashboard
GET /dashboard/stats
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"userName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contactsCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"dmsSentThisPeriod": {
"type": "number"
}
},
"required": [
"name",
"dmsSentThisPeriod"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"instagramAccount": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"instagramId": {
"type": "string"
},
"tokenExpiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"webhookSubscribed": {
"type": "boolean"
}
},
"required": [
"id",
"username",
"instagramId",
"tokenExpiresAt",
"webhookSubscribed"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"instagramAccounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"instagramId": {
"type": "string"
},
"tokenExpiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"webhookSubscribed": {
"type": "boolean"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"username",
"instagramId",
"tokenExpiresAt",
"webhookSubscribed",
"name"
],
"additionalProperties": false
}
},
"selectedInstagramAccountId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"totalAutomations": {
"type": "number"
},
"activeAutomations": {
"type": "number"
},
"dmsSentToday": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dmsSentWeek": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dmsSentMonth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dmsSkippedMonth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dmsFailedMonth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"totalDMs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"clicksThisMonth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"totalClicks": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ctrThisMonth": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"topKeywords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"keyword",
"count"
],
"additionalProperties": false
}
},
"dailyDMs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"date",
"count"
],
"additionalProperties": false
}
},
"recentLogs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sendOperationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sendOperation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string"
},
"attemptCount": {
"type": "number"
},
"hasUnknown": {
"type": "boolean"
},
"nextAttemptAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"state",
"attemptCount",
"hasUnknown",
"nextAttemptAt"
],
"additionalProperties": false
},
"id": {
"type": "string"
},
"automationId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"commenterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"commentText": {
"type": "string"
},
"matchedKeyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"SENT",
"FAILED",
"SKIPPED_DEDUP",
"SKIPPED_RATE_LIMIT",
"SKIPPED_PLAN_LIMIT",
"SKIPPED_NO_MATCH"
]
},
"attempts": {
"type": "number"
},
"dmSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"errorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"automation": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"instagramAccount": {
"type": "object",
"properties": {
"username": {
"type": "string"
}
},
"required": [
"username"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string"
},
"commenterId": {
"type": "string"
},
"commentId": {
"type": "string"
},
"publicReplySentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"publicReplyError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"id",
"automationId",
"instagramAccountId",
"commenterName",
"commentText",
"matchedKeyword",
"status",
"attempts",
"dmSentAt",
"errorMessage",
"createdAt",
"automation",
"instagramAccount",
"workspaceId",
"commenterId",
"commentId",
"publicReplySentAt",
"publicReplyError",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"userName",
"contactsCount",
"workspace",
"instagramAccount",
"instagramAccounts",
"selectedInstagramAccountId",
"totalAutomations",
"activeAutomations",
"dmsSentToday",
"dmsSentWeek",
"dmsSentMonth",
"dmsSkippedMonth",
"dmsFailedMonth",
"totalDMs",
"clicksThisMonth",
"totalClicks",
"ctrThisMonth",
"topKeywords",
"dailyDMs",
"recentLogs"
],
"additionalProperties": false
}Журнал автоответов с пагинацией и фильтром статуса.
Аккаунт и взаимодействия Чтение
Разрешения: messages:read
operationId: messages.logs.list
GET /messages/logs
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sendOperationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sendOperation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string"
},
"attemptCount": {
"type": "number"
},
"hasUnknown": {
"type": "boolean"
},
"nextAttemptAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"state",
"attemptCount",
"hasUnknown",
"nextAttemptAt"
],
"additionalProperties": false
},
"id": {
"type": "string"
},
"automationId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"commenterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"commentText": {
"type": "string"
},
"matchedKeyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"SENT",
"FAILED",
"SKIPPED_DEDUP",
"SKIPPED_RATE_LIMIT",
"SKIPPED_PLAN_LIMIT",
"SKIPPED_NO_MATCH"
]
},
"attempts": {
"type": "number"
},
"dmSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"errorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"automation": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"instagramAccount": {
"type": "object",
"properties": {
"username": {
"type": "string"
}
},
"required": [
"username"
],
"additionalProperties": false
}
},
"required": [
"id",
"automationId",
"instagramAccountId",
"commenterName",
"commentText",
"matchedKeyword",
"status",
"attempts",
"dmSentAt",
"errorMessage",
"createdAt",
"automation",
"instagramAccount"
],
"additionalProperties": false
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"totalPages": {
"type": "number"
}
},
"required": [
"page",
"limit",
"total",
"totalPages"
],
"additionalProperties": false
}
},
"required": [
"logs",
"pagination"
],
"additionalProperties": false
}Подробный журнал сообщений с результатами публичных ответов.
Аккаунт и взаимодействия Чтение
Разрешения: logs:read
operationId: logs.list
GET /logs
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sendOperationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sendOperation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string"
},
"attemptCount": {
"type": "number"
},
"hasUnknown": {
"type": "boolean"
},
"nextAttemptAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"state",
"attemptCount",
"hasUnknown",
"nextAttemptAt"
],
"additionalProperties": false
},
"id": {
"type": "string"
},
"automationId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"commenterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"commentText": {
"type": "string"
},
"matchedKeyword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"SENT",
"FAILED",
"SKIPPED_DEDUP",
"SKIPPED_RATE_LIMIT",
"SKIPPED_PLAN_LIMIT",
"SKIPPED_NO_MATCH"
]
},
"attempts": {
"type": "number"
},
"dmSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"errorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"automation": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"keywords"
],
"additionalProperties": false
},
"instagramAccount": {
"type": "object",
"properties": {
"username": {
"type": "string"
}
},
"required": [
"username"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string"
},
"commenterId": {
"type": "string"
},
"commentId": {
"type": "string"
},
"publicReplySentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"publicReplyError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"id",
"automationId",
"instagramAccountId",
"commenterName",
"commentText",
"matchedKeyword",
"status",
"attempts",
"dmSentAt",
"errorMessage",
"createdAt",
"automation",
"instagramAccount",
"workspaceId",
"commenterId",
"commentId",
"publicReplySentAt",
"publicReplyError",
"updatedAt"
],
"additionalProperties": false
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "number"
},
"limit": {
"type": "number"
},
"total": {
"type": "number"
},
"totalPages": {
"type": "number"
}
},
"required": [
"page",
"limit",
"total",
"totalPages"
],
"additionalProperties": false
}
},
"required": [
"logs",
"pagination"
],
"additionalProperties": false
}Рабочее пространство и владелец.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: account:read
operationId: account.get
GET /account
Входные параметры · Результат Тариф, подписка, использование и ограничения тестовых аккаунтов.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: billing:read
operationId: billing.get
GET /billing
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"subscription": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"planId": {
"type": "string"
},
"status": {
"type": "string"
},
"periodStart": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"periodEnd": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"usageAnchor": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"autoRenew": {
"type": "boolean"
},
"source": {
"type": "string"
},
"snapshot": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"priceMinor": {
"type": "number"
},
"currency": {
"type": "string"
},
"intervalMonths": {
"type": "number"
},
"isTrial": {
"type": "boolean"
},
"features": {
"type": "object",
"properties": {
"instagram_connect": {
"type": "boolean"
},
"automations": {
"type": "boolean"
},
"automation_dm_trigger": {
"type": "boolean"
},
"automation_opening_dm": {
"type": "boolean"
},
"automation_follow_gate": {
"type": "boolean"
},
"automation_followup": {
"type": "boolean"
},
"automation_public_reply": {
"type": "boolean"
},
"automation_next_reel": {
"type": "boolean"
},
"automation_all_posts": {
"type": "boolean"
},
"automation_any_comment": {
"type": "boolean"
},
"automation_import": {
"type": "boolean"
},
"inbox": {
"type": "boolean"
},
"instagram_profile_view": {
"type": "boolean"
},
"instagram_posts_view": {
"type": "boolean"
},
"follower_analytics": {
"type": "boolean"
},
"automation_analytics": {
"type": "boolean"
},
"message_logs": {
"type": "boolean"
},
"reels_research": {
"type": "boolean"
},
"parser_profiles": {
"type": "boolean"
},
"reels_collection": {
"type": "boolean"
},
"competitor_search": {
"type": "boolean"
},
"dream100": {
"type": "boolean"
},
"hashtag_research": {
"type": "boolean"
},
"reels_discovery": {
"type": "boolean"
},
"reels_import_manual": {
"type": "boolean"
},
"reels_import_url": {
"type": "boolean"
},
"reels_analysis": {
"type": "boolean"
},
"research_export": {
"type": "boolean"
},
"content_lab": {
"type": "boolean"
},
"profile_analysis": {
"type": "boolean"
},
"series_create": {
"type": "boolean"
},
"variants_create": {
"type": "boolean"
},
"ai_planning": {
"type": "boolean"
},
"video_generation": {
"type": "boolean"
},
"caption_editing": {
"type": "boolean"
},
"media_upload": {
"type": "boolean"
},
"publication_scheduling": {
"type": "boolean"
},
"instagram_publishing": {
"type": "boolean"
},
"publication_analytics": {
"type": "boolean"
},
"public_reports": {
"type": "boolean"
},
"tracked_links": {
"type": "boolean"
},
"click_analytics": {
"type": "boolean"
},
"api_access": {
"type": "boolean"
},
"api_keys": {
"type": "boolean"
}
},
"required": [
"instagram_connect",
"automations",
"automation_dm_trigger",
"automation_opening_dm",
"automation_follow_gate",
"automation_followup",
"automation_public_reply",
"automation_next_reel",
"automation_all_posts",
"automation_any_comment",
"automation_import",
"inbox",
"instagram_profile_view",
"instagram_posts_view",
"follower_analytics",
"automation_analytics",
"message_logs",
"reels_research",
"parser_profiles",
"reels_collection",
"competitor_search",
"dream100",
"hashtag_research",
"reels_discovery",
"reels_import_manual",
"reels_import_url",
"reels_analysis",
"research_export",
"content_lab",
"profile_analysis",
"series_create",
"variants_create",
"ai_planning",
"video_generation",
"caption_editing",
"media_upload",
"publication_scheduling",
"instagram_publishing",
"publication_analytics",
"public_reports",
"tracked_links",
"click_analytics",
"api_access",
"api_keys"
],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"instagram_accounts": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parser_profiles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_collection_runs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"active_automations": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"api_keys": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"tracked_links": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"public_reports": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"competitors": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dream100_lists": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dream100_profiles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"retained_series": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"scheduled_publications": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"storage_bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"automations_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dm_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments_processed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"public_replies_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followups_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"clicks_recorded": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"analytics_refreshes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"api_requests": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"hashtag_runs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_imported": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_analyzed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"research_exports": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"profile_analyses": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"series_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"variants_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ai_plans": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ai_series": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_generated": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_uploaded": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_published": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"upload_bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"instagram_accounts",
"parser_profiles",
"reels_collection_runs",
"active_automations",
"api_keys",
"tracked_links",
"public_reports",
"competitors",
"dream100_lists",
"dream100_profiles",
"retained_series",
"scheduled_publications",
"storage_bytes",
"automations_created",
"dm_sent",
"comments_processed",
"public_replies_sent",
"followups_sent",
"clicks_recorded",
"analytics_refreshes",
"api_requests",
"hashtag_runs",
"reels_imported",
"reels_analyzed",
"research_exports",
"profile_analyses",
"series_created",
"variants_created",
"ai_plans",
"ai_series",
"videos_generated",
"videos_uploaded",
"videos_published",
"upload_bytes"
],
"additionalProperties": false
}
},
"required": [
"name",
"priceMinor",
"currency",
"intervalMonths",
"isTrial",
"features",
"limits"
],
"additionalProperties": false
},
"paidAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"id",
"workspaceId",
"planId",
"status",
"periodStart",
"periodEnd",
"usageAnchor",
"autoRenew",
"source",
"snapshot",
"paidAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"active": {
"type": "boolean"
},
"snapshot": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"priceMinor": {
"type": "number"
},
"currency": {
"type": "string"
},
"intervalMonths": {
"type": "number"
},
"isTrial": {
"type": "boolean"
},
"features": {
"type": "object",
"properties": {
"instagram_connect": {
"type": "boolean"
},
"automations": {
"type": "boolean"
},
"automation_dm_trigger": {
"type": "boolean"
},
"automation_opening_dm": {
"type": "boolean"
},
"automation_follow_gate": {
"type": "boolean"
},
"automation_followup": {
"type": "boolean"
},
"automation_public_reply": {
"type": "boolean"
},
"automation_next_reel": {
"type": "boolean"
},
"automation_all_posts": {
"type": "boolean"
},
"automation_any_comment": {
"type": "boolean"
},
"automation_import": {
"type": "boolean"
},
"inbox": {
"type": "boolean"
},
"instagram_profile_view": {
"type": "boolean"
},
"instagram_posts_view": {
"type": "boolean"
},
"follower_analytics": {
"type": "boolean"
},
"automation_analytics": {
"type": "boolean"
},
"message_logs": {
"type": "boolean"
},
"reels_research": {
"type": "boolean"
},
"parser_profiles": {
"type": "boolean"
},
"reels_collection": {
"type": "boolean"
},
"competitor_search": {
"type": "boolean"
},
"dream100": {
"type": "boolean"
},
"hashtag_research": {
"type": "boolean"
},
"reels_discovery": {
"type": "boolean"
},
"reels_import_manual": {
"type": "boolean"
},
"reels_import_url": {
"type": "boolean"
},
"reels_analysis": {
"type": "boolean"
},
"research_export": {
"type": "boolean"
},
"content_lab": {
"type": "boolean"
},
"profile_analysis": {
"type": "boolean"
},
"series_create": {
"type": "boolean"
},
"variants_create": {
"type": "boolean"
},
"ai_planning": {
"type": "boolean"
},
"video_generation": {
"type": "boolean"
},
"caption_editing": {
"type": "boolean"
},
"media_upload": {
"type": "boolean"
},
"publication_scheduling": {
"type": "boolean"
},
"instagram_publishing": {
"type": "boolean"
},
"publication_analytics": {
"type": "boolean"
},
"public_reports": {
"type": "boolean"
},
"tracked_links": {
"type": "boolean"
},
"click_analytics": {
"type": "boolean"
},
"api_access": {
"type": "boolean"
},
"api_keys": {
"type": "boolean"
}
},
"required": [
"instagram_connect",
"automations",
"automation_dm_trigger",
"automation_opening_dm",
"automation_follow_gate",
"automation_followup",
"automation_public_reply",
"automation_next_reel",
"automation_all_posts",
"automation_any_comment",
"automation_import",
"inbox",
"instagram_profile_view",
"instagram_posts_view",
"follower_analytics",
"automation_analytics",
"message_logs",
"reels_research",
"parser_profiles",
"reels_collection",
"competitor_search",
"dream100",
"hashtag_research",
"reels_discovery",
"reels_import_manual",
"reels_import_url",
"reels_analysis",
"research_export",
"content_lab",
"profile_analysis",
"series_create",
"variants_create",
"ai_planning",
"video_generation",
"caption_editing",
"media_upload",
"publication_scheduling",
"instagram_publishing",
"publication_analytics",
"public_reports",
"tracked_links",
"click_analytics",
"api_access",
"api_keys"
],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"instagram_accounts": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parser_profiles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_collection_runs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"active_automations": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"api_keys": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"tracked_links": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"public_reports": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"competitors": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dream100_lists": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dream100_profiles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"retained_series": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"scheduled_publications": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"storage_bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"automations_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dm_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments_processed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"public_replies_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followups_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"clicks_recorded": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"analytics_refreshes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"api_requests": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"hashtag_runs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_imported": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_analyzed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"research_exports": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"profile_analyses": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"series_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"variants_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ai_plans": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ai_series": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_generated": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_uploaded": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_published": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"upload_bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"instagram_accounts",
"parser_profiles",
"reels_collection_runs",
"active_automations",
"api_keys",
"tracked_links",
"public_reports",
"competitors",
"dream100_lists",
"dream100_profiles",
"retained_series",
"scheduled_publications",
"storage_bytes",
"automations_created",
"dm_sent",
"comments_processed",
"public_replies_sent",
"followups_sent",
"clicks_recorded",
"analytics_refreshes",
"api_requests",
"hashtag_runs",
"reels_imported",
"reels_analyzed",
"research_exports",
"profile_analyses",
"series_created",
"variants_created",
"ai_plans",
"ai_series",
"videos_generated",
"videos_uploaded",
"videos_published",
"upload_bytes"
],
"additionalProperties": false
}
},
"required": [
"name",
"priceMinor",
"currency",
"intervalMonths",
"isTrial",
"features",
"limits"
],
"additionalProperties": false
},
"periodStart": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"periodEnd": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"usage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"instagram_accounts",
"parser_profiles",
"reels_collection_runs",
"active_automations",
"api_keys",
"tracked_links",
"public_reports",
"competitors",
"dream100_lists",
"dream100_profiles",
"retained_series",
"scheduled_publications",
"storage_bytes",
"automations_created",
"dm_sent",
"comments_processed",
"public_replies_sent",
"followups_sent",
"clicks_recorded",
"analytics_refreshes",
"api_requests",
"hashtag_runs",
"reels_imported",
"reels_analyzed",
"research_exports",
"profile_analyses",
"series_created",
"variants_created",
"ai_plans",
"ai_series",
"videos_generated",
"videos_uploaded",
"videos_published",
"upload_bytes"
]
},
"label": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"monthly",
"capacity"
]
},
"used": {
"type": "number"
},
"limit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"unmeasuredFiles": {
"type": "number"
}
},
"required": [
"key",
"label",
"kind",
"used",
"limit"
],
"additionalProperties": false
}
},
"trialIdentities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instagramId": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"userId": {
"type": "string"
},
"firstUsedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"locked": {
"type": "boolean"
},
"releasedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"releaseReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"instagramId",
"workspaceId",
"userId",
"firstUsedAt",
"locked",
"releasedAt",
"releaseReason"
],
"additionalProperties": false
}
}
},
"required": [
"subscription",
"active",
"snapshot",
"periodStart",
"periodEnd",
"usage",
"trialIdentities"
],
"additionalProperties": false
}Доступные тарифы, способы оплаты и последние счета.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: billing:read
operationId: billing.checkout.catalog
GET /billing/checkout
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"priceMinor": {
"type": "number"
},
"currency": {
"type": "string"
},
"intervalMonths": {
"type": "number"
},
"isTrial": {
"type": "boolean"
},
"features": {
"type": "object",
"properties": {
"instagram_connect": {
"type": "boolean"
},
"automations": {
"type": "boolean"
},
"automation_dm_trigger": {
"type": "boolean"
},
"automation_opening_dm": {
"type": "boolean"
},
"automation_follow_gate": {
"type": "boolean"
},
"automation_followup": {
"type": "boolean"
},
"automation_public_reply": {
"type": "boolean"
},
"automation_next_reel": {
"type": "boolean"
},
"automation_all_posts": {
"type": "boolean"
},
"automation_any_comment": {
"type": "boolean"
},
"automation_import": {
"type": "boolean"
},
"inbox": {
"type": "boolean"
},
"instagram_profile_view": {
"type": "boolean"
},
"instagram_posts_view": {
"type": "boolean"
},
"follower_analytics": {
"type": "boolean"
},
"automation_analytics": {
"type": "boolean"
},
"message_logs": {
"type": "boolean"
},
"reels_research": {
"type": "boolean"
},
"parser_profiles": {
"type": "boolean"
},
"reels_collection": {
"type": "boolean"
},
"competitor_search": {
"type": "boolean"
},
"dream100": {
"type": "boolean"
},
"hashtag_research": {
"type": "boolean"
},
"reels_discovery": {
"type": "boolean"
},
"reels_import_manual": {
"type": "boolean"
},
"reels_import_url": {
"type": "boolean"
},
"reels_analysis": {
"type": "boolean"
},
"research_export": {
"type": "boolean"
},
"content_lab": {
"type": "boolean"
},
"profile_analysis": {
"type": "boolean"
},
"series_create": {
"type": "boolean"
},
"variants_create": {
"type": "boolean"
},
"ai_planning": {
"type": "boolean"
},
"video_generation": {
"type": "boolean"
},
"caption_editing": {
"type": "boolean"
},
"media_upload": {
"type": "boolean"
},
"publication_scheduling": {
"type": "boolean"
},
"instagram_publishing": {
"type": "boolean"
},
"publication_analytics": {
"type": "boolean"
},
"public_reports": {
"type": "boolean"
},
"tracked_links": {
"type": "boolean"
},
"click_analytics": {
"type": "boolean"
},
"api_access": {
"type": "boolean"
},
"api_keys": {
"type": "boolean"
}
},
"required": [
"instagram_connect",
"automations",
"automation_dm_trigger",
"automation_opening_dm",
"automation_follow_gate",
"automation_followup",
"automation_public_reply",
"automation_next_reel",
"automation_all_posts",
"automation_any_comment",
"automation_import",
"inbox",
"instagram_profile_view",
"instagram_posts_view",
"follower_analytics",
"automation_analytics",
"message_logs",
"reels_research",
"parser_profiles",
"reels_collection",
"competitor_search",
"dream100",
"hashtag_research",
"reels_discovery",
"reels_import_manual",
"reels_import_url",
"reels_analysis",
"research_export",
"content_lab",
"profile_analysis",
"series_create",
"variants_create",
"ai_planning",
"video_generation",
"caption_editing",
"media_upload",
"publication_scheduling",
"instagram_publishing",
"publication_analytics",
"public_reports",
"tracked_links",
"click_analytics",
"api_access",
"api_keys"
],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"instagram_accounts": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parser_profiles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_collection_runs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"active_automations": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"api_keys": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"tracked_links": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"public_reports": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"competitors": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dream100_lists": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dream100_profiles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"retained_series": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"scheduled_publications": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"storage_bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"automations_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"dm_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments_processed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"public_replies_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followups_sent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"clicks_recorded": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"analytics_refreshes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"api_requests": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"hashtag_runs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_imported": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reels_analyzed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"research_exports": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"profile_analyses": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"series_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"variants_created": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ai_plans": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ai_series": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_generated": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_uploaded": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videos_published": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"upload_bytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"instagram_accounts",
"parser_profiles",
"reels_collection_runs",
"active_automations",
"api_keys",
"tracked_links",
"public_reports",
"competitors",
"dream100_lists",
"dream100_profiles",
"retained_series",
"scheduled_publications",
"storage_bytes",
"automations_created",
"dm_sent",
"comments_processed",
"public_replies_sent",
"followups_sent",
"clicks_recorded",
"analytics_refreshes",
"api_requests",
"hashtag_runs",
"reels_imported",
"reels_analyzed",
"research_exports",
"profile_analyses",
"series_created",
"variants_created",
"ai_plans",
"ai_series",
"videos_generated",
"videos_uploaded",
"videos_published",
"upload_bytes"
],
"additionalProperties": false
},
"id": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"trialUsed": {
"type": "boolean"
}
},
"required": [
"name",
"priceMinor",
"currency",
"intervalMonths",
"isTrial",
"features",
"limits",
"id",
"description",
"trialUsed"
],
"additionalProperties": false
}
},
"providers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"name": {
"type": "string"
},
"testMode": {
"type": "boolean"
},
"currencies": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"provider",
"name",
"testMode",
"currencies"
],
"additionalProperties": false
}
},
"checkouts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"provider": {
"type": "string"
},
"testMode": {
"type": "boolean"
},
"status": {
"type": "string"
},
"checkoutUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planName": {
"type": "string"
},
"amountMinor": {
"type": "number"
},
"currency": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
}
},
"required": [
"id",
"provider",
"testMode",
"status",
"checkoutUrl",
"planName",
"amountMinor",
"currency",
"createdAt"
],
"additionalProperties": false
}
}
},
"required": [
"plans",
"providers",
"checkouts"
],
"additionalProperties": false
}Создать счёт для оплаты выбранного тарифа.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: billing:write
operationId: billing.checkout.create
POST /billing/checkout
Входные параметры · Результат Получить счёт без платёжных секретов.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: billing:read
operationId: billing.checkout.get
GET /billing/checkout/{id}
Входные параметры · Результат Проверить состояние счёта.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: billing:read
operationId: billing.checkout.status
GET /billing/checkout/{id}/status
Входные параметры · Результат Партнёрский кабинет: ссылка, балансы, рефералы и заявки на вывод.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: affiliates:read
operationId: affiliates.get
GET /affiliates
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"referralUrl": {
"type": "string"
},
"walletAddress": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"level1Bps": {
"type": "number"
},
"level2Bps": {
"type": "number"
},
"minimumWithdrawalUsdtCents": {
"type": "string"
},
"directCount": {
"type": "number"
},
"secondLevelCount": {
"type": "number"
},
"balances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string"
},
"earnedMinor": {
"type": "string"
},
"availableMinor": {
"type": "string"
},
"reservedMinor": {
"type": "string"
},
"paidMinor": {
"type": "string"
},
"availableUsdtCents": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"exchangeRate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"currency",
"earnedMinor",
"availableMinor",
"reservedMinor",
"paidMinor",
"availableUsdtCents",
"exchangeRate"
],
"additionalProperties": false
}
},
"referrals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
},
"joinedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"earnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string"
},
"amountMinor": {
"type": "string"
}
},
"required": [
"currency",
"amountMinor"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"label",
"level",
"joinedAt",
"earnings"
],
"additionalProperties": false
}
},
"referralsTotal": {
"type": "number"
},
"page": {
"type": "number"
},
"pageSize": {
"type": "number"
},
"withdrawals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"currency": {
"type": "string"
},
"amountMinor": {
"type": "string"
},
"usdtCents": {
"type": "string"
},
"exchangeRate": {
"type": "string"
},
"walletAddress": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"PAID",
"REJECTED"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"dueAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
"paidAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"txHash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"adminNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"currency",
"amountMinor",
"usdtCents",
"exchangeRate",
"walletAddress",
"status",
"createdAt",
"dueAt",
"paidAt",
"txHash",
"adminNote"
],
"additionalProperties": false
}
},
"withdrawalsTotal": {
"type": "number"
},
"withdrawalPage": {
"type": "number"
}
},
"required": [
"referralUrl",
"walletAddress",
"level1Bps",
"level2Bps",
"minimumWithdrawalUsdtCents",
"directCount",
"secondLevelCount",
"balances",
"referrals",
"referralsTotal",
"page",
"pageSize",
"withdrawals",
"withdrawalsTotal",
"withdrawalPage"
],
"additionalProperties": false
}Сохранить BEP20-кошелёк или удалить его значением null.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: affiliates:write
operationId: affiliates.wallet.update
PATCH /affiliates/wallet
Входные параметры · Результат Запросить вывод партнёрского вознаграждения; сумма в минимальных единицах валюты.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: affiliates:write
operationId: affiliates.withdrawals.create
POST /affiliates/withdrawals
Входные параметры · Результат Состояние заявки на вывод.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: affiliates:read
operationId: affiliates.withdrawals.status
GET /affiliates/withdrawals/{id}/status
Входные параметры · Результат Начать подключение Instagram. Владелец подтверждает подключение по confirmationUrl в браузере.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: instagram:extended:write
operationId: instagram.connection-attempts.create
POST /instagram/connection-attempts
Входные параметры · Результат Получить попытку подключения Instagram.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: instagram:extended:read
operationId: instagram.connection-attempts.get
GET /instagram/connection-attempts/{id}
Входные параметры · Результат Проверить состояние подключения Instagram.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: instagram:extended:read
operationId: instagram.connection-attempts.status
GET /instagram/connection-attempts/{id}/status
Входные параметры · Результат Отключить указанный аккаунт Instagram или все аккаунты рабочего пространства. Связанные автоответы останавливаются.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: instagram:extended:write
operationId: instagram.disconnect
POST /instagram/disconnect
Входные параметры · Результат Составить AI-план поиска хештегов
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.searchPlan
POST /research/search-plan
Входные параметры · Результат Найти и ранжировать конкурентов или сохранить выбранных в Dream100
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.competitorSearch
POST /research/competitors/search
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"query": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"niche": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"keywords": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
}
]
},
"hashtags": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
}
]
},
"excludeKeywords": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
}
]
},
"seedAccounts": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
}
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"continuation": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"persistSelected": {
"default": false,
"type": "boolean"
},
"selectedHandles": {
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"selectedCandidates": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"source": {
"type": "string",
"maxLength": 500
},
"reasons": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
}
},
"required": [
"handle",
"source",
"reasons"
]
}
},
"listName": {
"default": "Dream 100",
"type": "string",
"minLength": 1,
"maxLength": 120
}
},
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"niche": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"seedAccounts": {
"type": "array",
"items": {
"type": "string"
}
},
"limit": {
"type": "number"
},
"continuation": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"persistSelected": {
"type": "boolean"
},
"selectedHandles": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedCandidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"handle": {
"type": "string"
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"handle",
"source",
"reasons"
],
"additionalProperties": false
}
},
"listName": {
"type": "string"
}
},
"required": [
"excludeKeywords",
"seedAccounts",
"persistSelected",
"selectedHandles",
"selectedCandidates",
"listName"
],
"additionalProperties": false
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collector": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"health": {
"type": "string"
},
"reason": {
"type": "string"
},
"diagnostics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"collector",
"sourceStatus",
"message"
],
"additionalProperties": false
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profileUrl": {
"type": "string"
},
"source": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"reasons": {
"type": "array",
"items": {
"type": "string"
}
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"accountSizeLabel": {
"type": "string"
},
"relevanceScore": {
"type": "number"
},
"authorityScore": {
"type": "number"
},
"overlapScore": {
"type": "number"
},
"recentViralEvidence": {
"type": "object",
"properties": {
"reelsCount": {
"type": "number"
},
"bestScore": {
"type": "number"
},
"bestViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"bestUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"outlierLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reelsCount",
"bestScore",
"bestViews",
"bestUrl",
"outlierLabel"
],
"additionalProperties": false
},
"score": {
"type": "number"
},
"confidence": {
"type": "number"
},
"matchType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"matchedTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSnippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"savedCompetitorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"handle",
"displayName",
"profileUrl",
"source",
"sourceStatus",
"reasons",
"followerCount",
"accountSizeLabel",
"relevanceScore",
"authorityScore",
"overlapScore",
"recentViralEvidence",
"score",
"confidence"
],
"additionalProperties": false
}
},
"continuation": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"incomplete": {
"type": "boolean"
}
},
"required": [
"input",
"statuses",
"candidates",
"continuation",
"incomplete"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"requested": {
"type": "number"
},
"persisted": {
"type": "number"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"handle": {
"type": "string"
},
"competitorId": {
"type": "string"
}
},
"required": [
"handle",
"competitorId"
],
"additionalProperties": false
}
}
},
"required": [
"requested",
"persisted",
"rows"
],
"additionalProperties": false
}
],
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema2"
}
}
]
}
}
}Получить конкурента
Исследования Чтение
Разрешения: research:extended:read
operationId: research.competitorDetail
GET /research/competitors/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"profileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionIqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionMad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionSampleCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionVideoCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionScoredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"_count": {
"type": "object",
"properties": {
"videos": {
"type": "number"
}
},
"required": [
"videos"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"platform",
"handle",
"profileUrl",
"followerCount",
"estimatedMedianViews",
"collectionMedianViews",
"collectionIqr",
"collectionMad",
"collectionSampleCount",
"collectionVideoCount",
"collectionVersion",
"collectionScoredAt",
"notes",
"enabled",
"createdAt",
"updatedAt",
"_count"
],
"additionalProperties": false
}Изменить конкурента
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.competitorUpdate
PATCH /research/competitors/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"profileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionIqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionMad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionSampleCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionVideoCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionScoredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"workspaceId",
"platform",
"handle",
"profileUrl",
"followerCount",
"estimatedMedianViews",
"collectionMedianViews",
"collectionIqr",
"collectionMad",
"collectionSampleCount",
"collectionVideoCount",
"collectionVersion",
"collectionScoredAt",
"notes",
"enabled",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Удалить конкурента и связанные данные
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.competitorDelete
DELETE /research/competitors/{id}
Входные параметры · Результат Архив видео с фильтрами, оценкой вирусности и курсором
Исследования Чтение
Разрешения: research:extended:read
operationId: research.videos
GET /research/videos
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"archive": {
"default": true,
"type": "boolean",
"const": true
},
"competitorId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"runId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"includeUndated": {
"type": "boolean"
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"datePreset": {
"type": "string",
"enum": [
"all",
"today",
"yesterday",
"last7",
"last30",
"thisMonth",
"previousMonth",
"custom"
]
},
"from": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
]
},
"to": {
"anyOf": [
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
]
},
"minViews": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"minMultiplier": {
"type": "number",
"minimum": 0
},
"viralStatus": {
"default": "all",
"type": "string",
"enum": [
"all",
"breakout",
"verified_breakout",
"likely_breakout",
"not_breakout",
"insufficient_data"
]
},
"keyword": {
"type": "string",
"maxLength": 200
},
"sort": {
"default": "virality",
"type": "string",
"enum": [
"virality",
"views",
"date"
]
},
"language": {
"type": "string",
"const": "all"
}
},
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"platform": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountFollowerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"outlierScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionViralStatus": {
"type": "string"
},
"collectionBaselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionWeightedVirality": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionScoredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"competitor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"handle": {
"type": "string"
},
"platform": {
"type": "string"
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionSampleCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"collectionIqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionMad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"handle",
"platform",
"followerCount",
"estimatedMedianViews",
"collectionMedianViews",
"collectionSampleCount",
"collectionIqr",
"collectionMad"
],
"additionalProperties": false
},
"analyses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"videoId": {
"type": "string"
},
"hook": {
"type": "string"
},
"structure": {
"type": "string"
},
"adaptation": {
"type": "string"
},
"script": {
"type": "string"
},
"score": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"model": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"videoId",
"hook",
"structure",
"adaptation",
"script",
"score",
"model",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"score": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"velocityScore": {
"type": "number"
},
"engagementScore": {
"type": "number"
},
"recencyScore": {
"type": "number"
},
"capacityScore": {
"type": "number"
},
"outlierScore": {
"type": "number"
},
"confidenceScore": {
"type": "number"
},
"reliabilityScore": {
"type": "number"
},
"penaltyScore": {
"type": "number"
},
"viewsPerDay": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"engagementRate": {
"type": "number"
},
"normalizedViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"viewsPerFollower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"weightedViralityScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"baselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"robustZScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"medianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ageDays": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"sampleSize": {
"type": "number"
},
"label": {
"type": "string"
},
"outlierLabel": {
"type": "string"
},
"confidenceLabel": {
"type": "string"
},
"viralStatus": {
"type": "string"
},
"viralLabel": {
"type": "string"
},
"evidenceBasis": {
"type": "string"
},
"explanation": {
"type": "string"
},
"hasAccountContext": {
"type": "boolean"
},
"formulaVersion": {
"type": "string"
},
"preliminary": {
"type": "boolean"
},
"preliminaryReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"score",
"velocityScore",
"engagementScore",
"recencyScore",
"capacityScore",
"outlierScore",
"confidenceScore",
"reliabilityScore",
"penaltyScore",
"viewsPerDay",
"engagementRate",
"normalizedViews",
"viewsPerFollower",
"weightedViralityScore",
"baselineMultiplier",
"robustZScore",
"medianViews",
"iqr",
"mad",
"accountSize",
"ageDays",
"sampleSize",
"label",
"outlierLabel",
"confidenceLabel",
"viralStatus",
"viralLabel",
"evidenceBasis",
"explanation",
"hasAccountContext",
"formulaVersion",
"preliminary",
"preliminaryReason"
],
"additionalProperties": false
},
"captionLanguage": {
"type": "string"
},
"captionLanguageLabel": {
"type": "string"
},
"captionLanguageEvidence": {
"type": "string"
}
},
"required": [
"id",
"competitorId",
"platform",
"shortcode",
"videoId",
"url",
"caption",
"postedAt",
"views",
"likes",
"comments",
"shares",
"saves",
"accountFollowerCount",
"accountMedianViews",
"outlierScore",
"collectionViralStatus",
"collectionBaselineMultiplier",
"collectionWeightedVirality",
"collectionScoredAt",
"fetchedAt",
"createdAt",
"updatedAt",
"competitor",
"analyses",
"followers",
"score",
"captionLanguage",
"captionLanguageLabel",
"captionLanguageEvidence"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"runId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverage": {
"type": "object",
"properties": {
"withDate": {
"type": "number"
},
"withCaption": {
"type": "number"
},
"withViews": {
"type": "number"
},
"pendingDates": {
"type": "number"
}
},
"required": [
"withDate",
"withCaption",
"withViews",
"pendingDates"
],
"additionalProperties": false
},
"groups": {
"type": "object",
"properties": {
"verified_breakout": {
"type": "number"
},
"likely_breakout": {
"type": "number"
},
"not_breakout": {
"type": "number"
},
"insufficient_data": {
"type": "number"
}
},
"required": [
"verified_breakout",
"likely_breakout",
"not_breakout",
"insufficient_data"
],
"additionalProperties": false
},
"dateRange": {
"type": "object",
"properties": {
"datePreset": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"datePreset"
],
"additionalProperties": false
},
"baseline": {
"type": "string"
}
},
"required": [
"total",
"nextCursor",
"runId",
"coverage",
"groups",
"dateRange",
"baseline"
],
"additionalProperties": false
}
},
"required": [
"data",
"meta"
],
"additionalProperties": false
}Импортировать видео с переданными метаданными
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.importManual
POST /research/videos/import-manual
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"competitorId": {
"type": "string",
"minLength": 1
},
"platform": {
"default": "instagram",
"type": "string",
"maxLength": 40
},
"url": {
"type": "string",
"format": "uri"
},
"shortcode": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"rawJson": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
}
},
"required": [
"competitorId",
"url"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"platform": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountFollowerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"outlierScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionViralStatus": {
"type": "string"
},
"collectionBaselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionWeightedVirality": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionScoredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"competitorId",
"platform",
"shortcode",
"videoId",
"url",
"caption",
"postedAt",
"views",
"likes",
"comments",
"shares",
"saves",
"accountFollowerCount",
"accountMedianViews",
"outlierScore",
"collectionViralStatus",
"collectionBaselineMultiplier",
"collectionWeightedVirality",
"collectionScoredAt",
"fetchedAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Импортировать видео с переданными метаданными
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.importUrl
POST /research/videos/import-url
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"competitorId": {
"type": "string",
"minLength": 1
},
"platform": {
"default": "instagram",
"type": "string",
"maxLength": 40
},
"url": {
"type": "string",
"format": "uri"
},
"shortcode": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"rawJson": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
}
},
"required": [
"competitorId",
"url"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"platform": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountFollowerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"outlierScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionViralStatus": {
"type": "string"
},
"collectionBaselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionWeightedVirality": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionScoredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"competitorId",
"platform",
"shortcode",
"videoId",
"url",
"caption",
"postedAt",
"views",
"likes",
"comments",
"shares",
"saves",
"accountFollowerCount",
"accountMedianViews",
"outlierScore",
"collectionViralStatus",
"collectionBaselineMultiplier",
"collectionWeightedVirality",
"collectionScoredAt",
"fetchedAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Проанализировать видео
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.analysis
POST /research/analyses
Входные параметры · Результат Экспортировать выбранные строки Dream100 в CSV
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.export
POST /research/dream100-lists/export
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"rows": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"score": {
"type": "number",
"minimum": 0,
"maximum": 100
},
"confidence": {
"type": "number",
"minimum": 0,
"maximum": 100
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reasons": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"maxLength": 1000
}
},
"recentViralEvidence": {
"type": "object",
"properties": {
"bestUrl": {
"anyOf": [
{
"type": "string",
"maxLength": 2048,
"format": "uri"
},
{
"type": "null"
}
]
}
}
}
},
"required": [
"handle",
"profileUrl",
"score",
"confidence",
"followerCount",
"reasons"
]
}
}
},
"required": [
"rows"
],
"additionalProperties": false
}Создать автоответ по Reel; dryRun возвращает предварительный просмотр
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.campaign
POST /research/campaigns
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"videoId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"reelUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"instagramAccountId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"goal": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"keywords": {
"default": [
"хочу"
],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"matchAnyWord": {
"default": false,
"type": "boolean"
},
"dmMessage": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
]
},
"leadMagnetUrl": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
{
"type": "null"
}
]
},
"publicReplyEnabled": {
"default": true,
"type": "boolean"
},
"publicReplyMessage": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"default": false,
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 1440
},
"isActive": {
"default": true,
"type": "boolean"
},
"dryRun": {
"default": false,
"type": "boolean"
}
},
"required": [
"dmMessage"
],
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"name": {
"type": "string"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingNextReel": {
"type": "boolean"
},
"matchAnyPost": {
"type": "boolean"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmTriggerEnabled": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"openingDmEnabled": {
"type": "boolean"
},
"openingDmMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openingDmButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requireFollow": {
"type": "boolean"
},
"followPromptMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followPromptButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicReplyMessages": {
"type": "array",
"items": {
"type": "string"
}
},
"isActive": {
"type": "boolean"
},
"wholeWordMatch": {
"type": "boolean"
},
"reportShareSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reportShareEnabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"trackedLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"automationId": {
"type": "string"
},
"slug": {
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"destinationUrl": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"workspaceId",
"automationId",
"slug",
"label",
"destinationUrl",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"instagramAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"instagramAccountId",
"name",
"goal",
"postId",
"postUrl",
"pendingNextReel",
"matchAnyPost",
"keywords",
"matchAnyWord",
"dmTriggerEnabled",
"dmMessage",
"openingDmEnabled",
"openingDmMessage",
"openingDmButtonLabel",
"linkButtonLabel",
"requireFollow",
"followPromptMessage",
"followPromptButtonLabel",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"publicReplyEnabled",
"publicReplyMessage",
"publicReplyMessages",
"isActive",
"wholeWordMatch",
"reportShareSlug",
"reportShareEnabled",
"createdAt",
"updatedAt",
"trackedLinks",
"instagramAccount"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string"
},
"canLaunch": {
"type": "boolean"
},
"missingRequirement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requiresOfficialMetaConnection": {
"type": "boolean"
},
"reelUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"campaign": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"goal": {
"type": "string"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"leadMagnetUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "number"
},
"isActive": {
"type": "boolean"
}
},
"required": [
"name",
"goal",
"keywords",
"matchAnyWord",
"dmMessage",
"linkButtonLabel",
"leadMagnetUrl",
"publicReplyEnabled",
"publicReplyMessage",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"isActive"
],
"additionalProperties": false
}
},
"required": [
"mode",
"canLaunch",
"missingRequirement",
"requiresOfficialMetaConnection",
"reelUrl",
"postId",
"campaign"
],
"additionalProperties": false
}
]
}Проверить автоответ по Reel без запуска
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.preview
POST /research/campaigns/preview
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"videoId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"reelUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"instagramAccountId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"goal": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"keywords": {
"default": [
"хочу"
],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"matchAnyWord": {
"default": false,
"type": "boolean"
},
"dmMessage": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
]
},
"leadMagnetUrl": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"const": ""
}
]
},
{
"type": "null"
}
]
},
"publicReplyEnabled": {
"default": true,
"type": "boolean"
},
"publicReplyMessage": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"default": false,
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 1440
},
"isActive": {
"default": true,
"type": "boolean"
},
"dryRun": {
"default": true,
"type": "boolean",
"const": true
}
},
"required": [
"dmMessage"
],
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"mode": {
"type": "string"
},
"canLaunch": {
"type": "boolean"
},
"missingRequirement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"requiresOfficialMetaConnection": {
"type": "boolean"
},
"reelUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"campaign": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"goal": {
"type": "string"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"matchAnyWord": {
"type": "boolean"
},
"dmMessage": {
"type": "string"
},
"linkButtonLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"leadMagnetUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicReplyEnabled": {
"type": "boolean"
},
"publicReplyMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpEnabled": {
"type": "boolean"
},
"followUpMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDelayMinutes": {
"type": "number"
},
"isActive": {
"type": "boolean"
}
},
"required": [
"name",
"goal",
"keywords",
"matchAnyWord",
"dmMessage",
"linkButtonLabel",
"leadMagnetUrl",
"publicReplyEnabled",
"publicReplyMessage",
"followUpEnabled",
"followUpMessage",
"followUpDelayMinutes",
"isActive"
],
"additionalProperties": false
}
},
"required": [
"mode",
"canLaunch",
"missingRequirement",
"requiresOfficialMetaConnection",
"reelUrl",
"postId",
"campaign"
],
"additionalProperties": false
}Список профилей парсинга
Исследования Чтение
Разрешения: research:extended:read
operationId: research.profiles
GET /research/parser-profiles
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProxy": {
"type": "boolean"
},
"proxyEndpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"requiresReconnect": {
"type": "boolean"
},
"requiresRevalidation": {
"type": "boolean"
},
"temporarilyBlocked": {
"type": "boolean"
},
"protectionReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastValidatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"username",
"instagramUserId",
"hasProxy",
"proxyEndpoint",
"enabled",
"status",
"connected",
"requiresReconnect",
"requiresRevalidation",
"temporarilyBlocked",
"protectionReason",
"retryAt",
"nextAction",
"lastValidatedAt",
"lastError",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"profiles",
"nextCursor"
],
"additionalProperties": false
}Добавить профиль парсинга из cookies
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.profileCreate
POST /research/parser-profiles
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProxy": {
"type": "boolean"
},
"proxyEndpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"requiresReconnect": {
"type": "boolean"
},
"requiresRevalidation": {
"type": "boolean"
},
"temporarilyBlocked": {
"type": "boolean"
},
"protectionReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastValidatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"username",
"instagramUserId",
"hasProxy",
"proxyEndpoint",
"enabled",
"status",
"connected",
"requiresReconnect",
"requiresRevalidation",
"temporarilyBlocked",
"protectionReason",
"retryAt",
"nextAction",
"lastValidatedAt",
"lastError",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Получить профиль без секретов
Исследования Чтение
Разрешения: research:extended:read
operationId: research.profileDetail
GET /research/parser-profiles/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProxy": {
"type": "boolean"
},
"proxyEndpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"requiresReconnect": {
"type": "boolean"
},
"requiresRevalidation": {
"type": "boolean"
},
"temporarilyBlocked": {
"type": "boolean"
},
"protectionReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastValidatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"username",
"instagramUserId",
"hasProxy",
"proxyEndpoint",
"enabled",
"status",
"connected",
"requiresReconnect",
"requiresRevalidation",
"temporarilyBlocked",
"protectionReason",
"retryAt",
"nextAction",
"lastValidatedAt",
"lastError",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Безопасное состояние профиля
Исследования Чтение Обслуживание
Разрешения: research:extended:read
operationId: research.profileStatus
GET /research/parser-profiles/{id}/status
Входные параметры · Результат Обновить профиль, cookies, прокси либо проверить подключение
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.profileUpdate
PATCH /research/parser-profiles/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProxy": {
"type": "boolean"
},
"proxyEndpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"requiresReconnect": {
"type": "boolean"
},
"requiresRevalidation": {
"type": "boolean"
},
"temporarilyBlocked": {
"type": "boolean"
},
"protectionReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastValidatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"username",
"instagramUserId",
"hasProxy",
"proxyEndpoint",
"enabled",
"status",
"connected",
"requiresReconnect",
"requiresRevalidation",
"temporarilyBlocked",
"protectionReason",
"retryAt",
"nextAction",
"lastValidatedAt",
"lastError",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Удалить профиль парсинга
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.profileDelete
DELETE /research/parser-profiles/{id}
Входные параметры · Результат Создать пакет входа в профили парсинга
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.login
POST /research/parser-profiles/login
Входные параметры · Результат Результат пакета входа
Исследования Чтение
Разрешения: research:extended:read
operationId: research.loginDetail
GET /research/parser-profiles/login/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"QUEUED",
"RUNNING",
"COMPLETE"
]
},
"createdAt": {
"type": "string"
},
"finishedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "number"
},
"username": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"ACTION_REQUIRED"
]
},
"message": {
"type": "string"
},
"profile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"instagramUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hasProxy": {
"type": "boolean"
},
"proxyEndpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"requiresReconnect": {
"type": "boolean"
},
"requiresRevalidation": {
"type": "boolean"
},
"temporarilyBlocked": {
"type": "boolean"
},
"protectionReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastValidatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"lastError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"name",
"username",
"instagramUserId",
"hasProxy",
"proxyEndpoint",
"enabled",
"status",
"connected",
"requiresReconnect",
"requiresRevalidation",
"temporarilyBlocked",
"protectionReason",
"retryAt",
"nextAction",
"lastValidatedAt",
"lastError",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"index",
"username",
"status",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"status",
"createdAt",
"finishedAt",
"items"
],
"additionalProperties": false
}Безопасное состояние пакета входа
Исследования Чтение Обслуживание
Разрешения: research:extended:read
operationId: research.loginStatus
GET /research/parser-profiles/login/{id}/status
Входные параметры · Результат Список запусков исследования
Исследования Чтение
Разрешения: research:extended:read
operationId: research.discovery.list
GET /research/discovery-runs
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"runs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"resumeVersion": {
"type": "number"
},
"parallelism": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"portions": {
"type": "number"
},
"endReached": {
"type": "boolean"
},
"coverage": {
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFailure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tag",
"parserProfileId",
"status",
"portions",
"endReached",
"coverage",
"message",
"lastFailure",
"retryAt"
],
"additionalProperties": false
}
},
"totalTags": {
"type": "number"
},
"completedTags": {
"type": "number"
},
"activeParserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"handle": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionLanguage": {
"type": "string"
},
"captionLanguageLabel": {
"type": "string"
},
"captionLanguageEvidence": {
"type": "string"
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"accountMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountViewSamples": {
"type": "array",
"items": {
"type": "number"
}
},
"platform": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"statusMessage": {
"type": "string"
},
"matchType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"matchedTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSnippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"score": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"velocityScore": {
"type": "number"
},
"engagementScore": {
"type": "number"
},
"recencyScore": {
"type": "number"
},
"capacityScore": {
"type": "number"
},
"outlierScore": {
"type": "number"
},
"confidenceScore": {
"type": "number"
},
"reliabilityScore": {
"type": "number"
},
"penaltyScore": {
"type": "number"
},
"viewsPerDay": {
"type": "number"
},
"engagementRate": {
"type": "number"
},
"normalizedViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"viewsPerFollower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"weightedViralityScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"baselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"robustZScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"medianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ageDays": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"sampleSize": {
"type": "number"
},
"label": {
"type": "string"
},
"outlierLabel": {
"type": "string"
},
"confidenceLabel": {
"type": "string"
},
"viralStatus": {
"type": "string"
},
"viralLabel": {
"type": "string"
},
"evidenceBasis": {
"type": "string"
},
"explanation": {
"type": "string"
},
"hasAccountContext": {
"type": "boolean"
},
"formulaVersion": {
"type": "string"
}
},
"required": [
"score",
"velocityScore",
"engagementScore",
"recencyScore",
"capacityScore",
"outlierScore",
"confidenceScore",
"reliabilityScore",
"penaltyScore",
"viewsPerDay",
"engagementRate",
"normalizedViews",
"viewsPerFollower",
"weightedViralityScore",
"baselineMultiplier",
"robustZScore",
"medianViews",
"iqr",
"mad",
"accountSize",
"ageDays",
"sampleSize",
"label",
"outlierLabel",
"confidenceLabel",
"viralStatus",
"viralLabel",
"evidenceBasis",
"explanation",
"hasAccountContext",
"formulaVersion"
],
"additionalProperties": false
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"saved": {
"type": "boolean"
}
},
"required": [
"url",
"handle",
"caption",
"source",
"sourceStatus",
"statusMessage",
"score"
],
"additionalProperties": false
}
},
"candidateCount": {
"type": "number"
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collector": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"health": {
"type": "string"
},
"reason": {
"type": "string"
},
"diagnostics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"collector",
"sourceStatus",
"message"
],
"additionalProperties": false
}
},
"portions": {
"type": "number"
},
"incomplete": {
"type": "boolean"
},
"scope": {
"type": "string"
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"resumeVersion",
"parallelism",
"tags",
"totalTags",
"completedTags",
"activeParserProfileIds",
"hashtags",
"excludeKeywords",
"candidateCount",
"statuses",
"portions",
"incomplete",
"scope"
],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"runs",
"nextCursor"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Результаты запуска исследования
Исследования Чтение
Разрешения: research:extended:read
operationId: research.discovery.detail
GET /research/discovery-runs/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"resumeVersion": {
"type": "number"
},
"parallelism": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"portions": {
"type": "number"
},
"endReached": {
"type": "boolean"
},
"coverage": {
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFailure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tag",
"parserProfileId",
"status",
"portions",
"endReached",
"coverage",
"message",
"lastFailure",
"retryAt"
],
"additionalProperties": false
}
},
"totalTags": {
"type": "number"
},
"completedTags": {
"type": "number"
},
"activeParserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"handle": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionLanguage": {
"type": "string"
},
"captionLanguageLabel": {
"type": "string"
},
"captionLanguageEvidence": {
"type": "string"
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"accountMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountViewSamples": {
"type": "array",
"items": {
"type": "number"
}
},
"platform": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"statusMessage": {
"type": "string"
},
"matchType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"matchedTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSnippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"score": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"velocityScore": {
"type": "number"
},
"engagementScore": {
"type": "number"
},
"recencyScore": {
"type": "number"
},
"capacityScore": {
"type": "number"
},
"outlierScore": {
"type": "number"
},
"confidenceScore": {
"type": "number"
},
"reliabilityScore": {
"type": "number"
},
"penaltyScore": {
"type": "number"
},
"viewsPerDay": {
"type": "number"
},
"engagementRate": {
"type": "number"
},
"normalizedViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"viewsPerFollower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"weightedViralityScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"baselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"robustZScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"medianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ageDays": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"sampleSize": {
"type": "number"
},
"label": {
"type": "string"
},
"outlierLabel": {
"type": "string"
},
"confidenceLabel": {
"type": "string"
},
"viralStatus": {
"type": "string"
},
"viralLabel": {
"type": "string"
},
"evidenceBasis": {
"type": "string"
},
"explanation": {
"type": "string"
},
"hasAccountContext": {
"type": "boolean"
},
"formulaVersion": {
"type": "string"
}
},
"required": [
"score",
"velocityScore",
"engagementScore",
"recencyScore",
"capacityScore",
"outlierScore",
"confidenceScore",
"reliabilityScore",
"penaltyScore",
"viewsPerDay",
"engagementRate",
"normalizedViews",
"viewsPerFollower",
"weightedViralityScore",
"baselineMultiplier",
"robustZScore",
"medianViews",
"iqr",
"mad",
"accountSize",
"ageDays",
"sampleSize",
"label",
"outlierLabel",
"confidenceLabel",
"viralStatus",
"viralLabel",
"evidenceBasis",
"explanation",
"hasAccountContext",
"formulaVersion"
],
"additionalProperties": false
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"saved": {
"type": "boolean"
}
},
"required": [
"url",
"handle",
"caption",
"source",
"sourceStatus",
"statusMessage",
"score"
],
"additionalProperties": false
}
},
"candidateCount": {
"type": "number"
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collector": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"health": {
"type": "string"
},
"reason": {
"type": "string"
},
"diagnostics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"collector",
"sourceStatus",
"message"
],
"additionalProperties": false
}
},
"portions": {
"type": "number"
},
"incomplete": {
"type": "boolean"
},
"scope": {
"type": "string"
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"resumeVersion",
"parallelism",
"tags",
"totalTags",
"completedTags",
"activeParserProfileIds",
"hashtags",
"excludeKeywords",
"candidateCount",
"statuses",
"portions",
"incomplete",
"scope"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Безопасное состояние запуска
Исследования Чтение Обслуживание
Разрешения: research:extended:read
operationId: research.discovery.status
GET /research/discovery-runs/{id}/status
Входные параметры · Результат Проверить готовность запуска
Исследования Чтение
Разрешения: research:extended:read
operationId: research.discovery.readiness
GET /research/discovery-runs/readiness
GET /research/readiness
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserUsername": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"queueReady": {
"type": "boolean"
},
"featureAvailable": {
"type": "boolean"
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"blockedProfiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reason": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"message": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"parserProfileId": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"reason",
"retryAt",
"message",
"nextAction",
"parserProfileId"
],
"additionalProperties": false
}
},
"enabled": {
"type": "boolean"
},
"parallelism": {
"type": "number"
},
"reason": {
"type": "string"
}
},
"required": [
"ready",
"code",
"message",
"nextAction",
"retryAt",
"parserProfileId",
"parserUsername",
"queueReady",
"featureAvailable",
"parserProfileIds",
"poolCount",
"blockedProfiles",
"enabled",
"parallelism",
"reason"
],
"additionalProperties": false
}Создать запуск исследования
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.discovery.create
POST /research/discovery-runs
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hashtags": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"excludeKeywords": {
"default": [],
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"parserProfileId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"parserProfileIds": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"datePreset": {
"default": "last30",
"type": "string",
"enum": [
"today",
"yesterday",
"last7",
"last30",
"thisMonth",
"previousMonth",
"custom",
"all"
]
},
"from": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
}
]
},
"to": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
}
]
}
},
"required": [
"hashtags"
],
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"resumeVersion": {
"type": "number"
},
"parallelism": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"portions": {
"type": "number"
},
"endReached": {
"type": "boolean"
},
"coverage": {
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFailure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tag",
"parserProfileId",
"status",
"portions",
"endReached",
"coverage",
"message",
"lastFailure",
"retryAt"
],
"additionalProperties": false
}
},
"totalTags": {
"type": "number"
},
"completedTags": {
"type": "number"
},
"activeParserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"handle": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionLanguage": {
"type": "string"
},
"captionLanguageLabel": {
"type": "string"
},
"captionLanguageEvidence": {
"type": "string"
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"accountMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountViewSamples": {
"type": "array",
"items": {
"type": "number"
}
},
"platform": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"statusMessage": {
"type": "string"
},
"matchType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"matchedTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSnippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"score": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"velocityScore": {
"type": "number"
},
"engagementScore": {
"type": "number"
},
"recencyScore": {
"type": "number"
},
"capacityScore": {
"type": "number"
},
"outlierScore": {
"type": "number"
},
"confidenceScore": {
"type": "number"
},
"reliabilityScore": {
"type": "number"
},
"penaltyScore": {
"type": "number"
},
"viewsPerDay": {
"type": "number"
},
"engagementRate": {
"type": "number"
},
"normalizedViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"viewsPerFollower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"weightedViralityScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"baselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"robustZScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"medianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ageDays": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"sampleSize": {
"type": "number"
},
"label": {
"type": "string"
},
"outlierLabel": {
"type": "string"
},
"confidenceLabel": {
"type": "string"
},
"viralStatus": {
"type": "string"
},
"viralLabel": {
"type": "string"
},
"evidenceBasis": {
"type": "string"
},
"explanation": {
"type": "string"
},
"hasAccountContext": {
"type": "boolean"
},
"formulaVersion": {
"type": "string"
}
},
"required": [
"score",
"velocityScore",
"engagementScore",
"recencyScore",
"capacityScore",
"outlierScore",
"confidenceScore",
"reliabilityScore",
"penaltyScore",
"viewsPerDay",
"engagementRate",
"normalizedViews",
"viewsPerFollower",
"weightedViralityScore",
"baselineMultiplier",
"robustZScore",
"medianViews",
"iqr",
"mad",
"accountSize",
"ageDays",
"sampleSize",
"label",
"outlierLabel",
"confidenceLabel",
"viralStatus",
"viralLabel",
"evidenceBasis",
"explanation",
"hasAccountContext",
"formulaVersion"
],
"additionalProperties": false
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"saved": {
"type": "boolean"
}
},
"required": [
"url",
"handle",
"caption",
"source",
"sourceStatus",
"statusMessage",
"score"
],
"additionalProperties": false
}
},
"candidateCount": {
"type": "number"
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collector": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"health": {
"type": "string"
},
"reason": {
"type": "string"
},
"diagnostics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"collector",
"sourceStatus",
"message"
],
"additionalProperties": false
}
},
"portions": {
"type": "number"
},
"incomplete": {
"type": "boolean"
},
"scope": {
"type": "string"
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"resumeVersion",
"parallelism",
"tags",
"totalTags",
"completedTags",
"activeParserProfileIds",
"hashtags",
"excludeKeywords",
"candidateCount",
"statuses",
"portions",
"incomplete",
"scope",
"statusUrl"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Продолжить запуск исследования
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.discovery.actions
POST /research/discovery-runs/{id}/actions
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"resumeVersion": {
"type": "number"
},
"parallelism": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"portions": {
"type": "number"
},
"endReached": {
"type": "boolean"
},
"coverage": {
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastFailure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"tag",
"parserProfileId",
"status",
"portions",
"endReached",
"coverage",
"message",
"lastFailure",
"retryAt"
],
"additionalProperties": false
}
},
"totalTags": {
"type": "number"
},
"completedTags": {
"type": "number"
},
"activeParserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"handle": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionLanguage": {
"type": "string"
},
"captionLanguageLabel": {
"type": "string"
},
"captionLanguageEvidence": {
"type": "string"
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"accountMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountViewSamples": {
"type": "array",
"items": {
"type": "number"
}
},
"platform": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"statusMessage": {
"type": "string"
},
"matchType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"matchedTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSnippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"score": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"velocityScore": {
"type": "number"
},
"engagementScore": {
"type": "number"
},
"recencyScore": {
"type": "number"
},
"capacityScore": {
"type": "number"
},
"outlierScore": {
"type": "number"
},
"confidenceScore": {
"type": "number"
},
"reliabilityScore": {
"type": "number"
},
"penaltyScore": {
"type": "number"
},
"viewsPerDay": {
"type": "number"
},
"engagementRate": {
"type": "number"
},
"normalizedViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"viewsPerFollower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"weightedViralityScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"baselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"robustZScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"medianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ageDays": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"sampleSize": {
"type": "number"
},
"label": {
"type": "string"
},
"outlierLabel": {
"type": "string"
},
"confidenceLabel": {
"type": "string"
},
"viralStatus": {
"type": "string"
},
"viralLabel": {
"type": "string"
},
"evidenceBasis": {
"type": "string"
},
"explanation": {
"type": "string"
},
"hasAccountContext": {
"type": "boolean"
},
"formulaVersion": {
"type": "string"
}
},
"required": [
"score",
"velocityScore",
"engagementScore",
"recencyScore",
"capacityScore",
"outlierScore",
"confidenceScore",
"reliabilityScore",
"penaltyScore",
"viewsPerDay",
"engagementRate",
"normalizedViews",
"viewsPerFollower",
"weightedViralityScore",
"baselineMultiplier",
"robustZScore",
"medianViews",
"iqr",
"mad",
"accountSize",
"ageDays",
"sampleSize",
"label",
"outlierLabel",
"confidenceLabel",
"viralStatus",
"viralLabel",
"evidenceBasis",
"explanation",
"hasAccountContext",
"formulaVersion"
],
"additionalProperties": false
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"saved": {
"type": "boolean"
}
},
"required": [
"url",
"handle",
"caption",
"source",
"sourceStatus",
"statusMessage",
"score"
],
"additionalProperties": false
}
},
"candidateCount": {
"type": "number"
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collector": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"health": {
"type": "string"
},
"reason": {
"type": "string"
},
"diagnostics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"collector",
"sourceStatus",
"message"
],
"additionalProperties": false
}
},
"portions": {
"type": "number"
},
"incomplete": {
"type": "boolean"
},
"scope": {
"type": "string"
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"resumeVersion",
"parallelism",
"tags",
"totalTags",
"completedTags",
"activeParserProfileIds",
"hashtags",
"excludeKeywords",
"candidateCount",
"statuses",
"portions",
"incomplete",
"scope",
"statusUrl"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Приостановить запуск исследования
Исследования Изменяет данные Обслуживание
Разрешения: research:extended:write
operationId: research.discovery.actions
POST /research/discovery-runs/{id}/actions
Входные параметры · Результат Отменить запуск исследования
Исследования Изменяет данные Обслуживание
Разрешения: research:extended:write
operationId: research.discovery.actions
POST /research/discovery-runs/{id}/actions
Входные параметры · Результат Список запусков исследования
Исследования Чтение
Разрешения: research:extended:read
operationId: research.collection.list
GET /research/collection-runs
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"runs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"profilesTotal": {
"type": "number"
},
"profilesComplete": {
"type": "number"
},
"collectedCount": {
"type": "number"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"currentCompetitorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentCompetitorIds": {
"type": "array",
"items": {
"type": "string"
}
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"competitorId": {
"type": "string"
},
"handle": {
"type": "string"
},
"parserProfileId": {
"type": "string"
},
"status": {
"type": "string"
},
"stage": {
"type": "string"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"collectedCount": {
"type": "number"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endReached": {
"type": "boolean"
},
"lastFailure": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
"unknownDateCount": {
"type": "number"
},
"missingViewsCount": {
"type": "number"
},
"coverage": {
"type": "string"
}
},
"required": [
"competitorId",
"handle",
"status",
"stage",
"followers",
"collectedCount",
"message",
"endReached",
"unknownDateCount",
"missingViewsCount",
"coverage"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"profilesTotal",
"profilesComplete",
"collectedCount",
"currentCompetitorId",
"currentCompetitorIds",
"profiles"
],
"additionalProperties": false
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"runs",
"nextCursor"
],
"additionalProperties": false
}Результаты запуска исследования
Исследования Чтение
Разрешения: research:extended:read
operationId: research.collection.detail
GET /research/collection-runs/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"profilesTotal": {
"type": "number"
},
"profilesComplete": {
"type": "number"
},
"collectedCount": {
"type": "number"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"currentCompetitorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentCompetitorIds": {
"type": "array",
"items": {
"type": "string"
}
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"competitorId": {
"type": "string"
},
"handle": {
"type": "string"
},
"parserProfileId": {
"type": "string"
},
"status": {
"type": "string"
},
"stage": {
"type": "string"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"collectedCount": {
"type": "number"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endReached": {
"type": "boolean"
},
"lastFailure": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
"unknownDateCount": {
"type": "number"
},
"missingViewsCount": {
"type": "number"
},
"coverage": {
"type": "string"
}
},
"required": [
"competitorId",
"handle",
"status",
"stage",
"followers",
"collectedCount",
"message",
"endReached",
"unknownDateCount",
"missingViewsCount",
"coverage"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"profilesTotal",
"profilesComplete",
"collectedCount",
"currentCompetitorId",
"currentCompetitorIds",
"profiles"
],
"additionalProperties": false
}Безопасное состояние запуска
Исследования Чтение Обслуживание
Разрешения: research:extended:read
operationId: research.collection.status
GET /research/collection-runs/{id}/status
Входные параметры · Результат Проверить готовность запуска
Исследования Чтение
Разрешения: research:extended:read
operationId: research.collection.readiness
GET /research/collection-runs/readiness
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserUsername": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"queueReady": {
"type": "boolean"
},
"featureAvailable": {
"type": "boolean"
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"blockedProfiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reason": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"message": {
"type": "string"
},
"nextAction": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"reason",
"retryAt",
"message",
"nextAction"
],
"additionalProperties": false
}
}
},
"required": [
"ready",
"code",
"message",
"nextAction",
"retryAt",
"parserProfileId",
"parserUsername",
"queueReady",
"featureAvailable",
"parserProfileIds",
"poolCount",
"blockedProfiles"
],
"additionalProperties": false
}Создать запуск исследования
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.collection.create
POST /research/collection-runs
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"profilesTotal": {
"type": "number"
},
"profilesComplete": {
"type": "number"
},
"collectedCount": {
"type": "number"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"currentCompetitorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentCompetitorIds": {
"type": "array",
"items": {
"type": "string"
}
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"competitorId": {
"type": "string"
},
"handle": {
"type": "string"
},
"parserProfileId": {
"type": "string"
},
"status": {
"type": "string"
},
"stage": {
"type": "string"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"collectedCount": {
"type": "number"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endReached": {
"type": "boolean"
},
"lastFailure": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
"unknownDateCount": {
"type": "number"
},
"missingViewsCount": {
"type": "number"
},
"coverage": {
"type": "string"
}
},
"required": [
"competitorId",
"handle",
"status",
"stage",
"followers",
"collectedCount",
"message",
"endReached",
"unknownDateCount",
"missingViewsCount",
"coverage"
],
"additionalProperties": false
}
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"profilesTotal",
"profilesComplete",
"collectedCount",
"currentCompetitorId",
"currentCompetitorIds",
"profiles",
"statusUrl"
],
"additionalProperties": false
}Продолжить запуск исследования
Исследования Изменяет данные
Разрешения: research:extended:write
operationId: research.collection.actions
POST /research/collection-runs/{id}/actions
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parserProfileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"poolCount": {
"type": "number"
},
"datePreset": {
"type": "string"
},
"dateFrom": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"dateTo": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"failure": {
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nextAction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextRunAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"requestCount": {
"type": "number"
},
"coverage": {
"type": "string"
},
"elapsedMs": {
"type": "number"
},
"profilesTotal": {
"type": "number"
},
"profilesComplete": {
"type": "number"
},
"collectedCount": {
"type": "number"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"currentCompetitorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentCompetitorIds": {
"type": "array",
"items": {
"type": "string"
}
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"competitorId": {
"type": "string"
},
"handle": {
"type": "string"
},
"parserProfileId": {
"type": "string"
},
"status": {
"type": "string"
},
"stage": {
"type": "string"
},
"enrichmentPolicy": {
"type": "string"
},
"discoveredCount": {
"type": "number"
},
"breakoutCount": {
"type": "number"
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"collectedCount": {
"type": "number"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endReached": {
"type": "boolean"
},
"lastFailure": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"nextAction": {
"type": "string"
},
"stage": {
"type": "string"
},
"at": {
"type": "string"
},
"retryAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"httpStatus": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"requestType": {
"type": "string"
},
"parserProfileId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"reason",
"at"
],
"additionalProperties": false
},
"unknownDateCount": {
"type": "number"
},
"missingViewsCount": {
"type": "number"
},
"coverage": {
"type": "string"
}
},
"required": [
"competitorId",
"handle",
"status",
"stage",
"followers",
"collectedCount",
"message",
"endReached",
"unknownDateCount",
"missingViewsCount",
"coverage"
],
"additionalProperties": false
}
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"status",
"parserProfileId",
"parserProfileIds",
"poolCount",
"datePreset",
"dateFrom",
"dateTo",
"message",
"failure",
"nextAction",
"nextRunAt",
"createdAt",
"updatedAt",
"finishedAt",
"requestCount",
"coverage",
"elapsedMs",
"profilesTotal",
"profilesComplete",
"collectedCount",
"currentCompetitorId",
"currentCompetitorIds",
"profiles",
"statusUrl"
],
"additionalProperties": false
}Приостановить запуск исследования
Исследования Изменяет данные Обслуживание
Разрешения: research:extended:write
operationId: research.collection.actions
POST /research/collection-runs/{id}/actions
Входные параметры · Результат Отменить запуск исследования
Исследования Изменяет данные Обслуживание
Разрешения: research:extended:write
operationId: research.collection.actions
POST /research/collection-runs/{id}/actions
Входные параметры · Результат Список исследований хештегов
Исследования Чтение
Разрешения: research:read
operationId: research.hashtag.list
GET /research/hashtag-runs
GET /research/reels/hashtags
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"topic": {
"type": "string"
},
"locales": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMode": {
"type": "string"
},
"targetCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"QUEUED",
"RUNNING",
"PAUSED",
"COMPLETE",
"PARTIAL",
"FAILED",
"CANCELLED"
]
},
"health": {
"type": "string",
"enum": [
"HEALTHY",
"DEGRADED",
"BLOCKED"
]
},
"stage": {
"type": "string",
"enum": [
"PLANNING",
"GAP_ANALYSIS",
"EXPANDING",
"VERIFYING",
"FINALIZING"
]
},
"stopReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generatedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"normalizedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currentBranchId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowYieldRounds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastCheckpointAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"legacyEvidence": {
"type": "object",
"properties": {
"checkedCount": {
"type": "number"
},
"verifiedCount": {
"type": "number"
},
"rejectedCount": {
"type": "number"
},
"errorCount": {
"type": "number"
}
},
"required": [
"checkedCount",
"verifiedCount",
"rejectedCount",
"errorCount"
],
"additionalProperties": false
}
},
"required": [
"id",
"topic",
"locales",
"targetMode",
"targetCount",
"status",
"health",
"stage",
"stopReason",
"generatedCount",
"normalizedCount",
"currentBranchId",
"lowYieldRounds",
"lastCheckpointAt",
"createdAt",
"updatedAt",
"legacyEvidence"
],
"additionalProperties": false
}
}Запустить исследование хештегов
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.hashtag.create
POST /research/hashtag-runs
POST /research/reels/hashtags
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"createdByUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"topic": {
"type": "string"
},
"locales": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMode": {
"type": "string"
},
"targetCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"QUEUED",
"RUNNING",
"PAUSED",
"COMPLETE",
"PARTIAL",
"FAILED",
"CANCELLED"
]
},
"health": {
"type": "string",
"enum": [
"HEALTHY",
"DEGRADED",
"BLOCKED"
]
},
"stage": {
"type": "string",
"enum": [
"PLANNING",
"GAP_ANALYSIS",
"EXPANDING",
"VERIFYING",
"FINALIZING"
]
},
"stopReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentBranchId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"cancelRequestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"leaseToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"leaseExpiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"taxonomy": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"frontier": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
},
"sourceHealth": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"generatedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"normalizedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lowYieldRounds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"llmCallCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"instagramRequestCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastCheckpointAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"minNewGeneratedPerRound": {
"type": "number"
},
"legacyEvidence": {
"type": "object",
"properties": {
"checkedCount": {
"type": "number"
},
"verifiedCount": {
"type": "number"
},
"rejectedCount": {
"type": "number"
},
"errorCount": {
"type": "number"
}
},
"required": [
"checkedCount",
"verifiedCount",
"rejectedCount",
"errorCount"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"createdByUserId",
"topic",
"locales",
"targetMode",
"targetCount",
"idempotencyKey",
"status",
"health",
"stage",
"stopReason",
"currentBranchId",
"resumeVersion",
"cancelRequestedAt",
"leaseToken",
"leaseExpiresAt",
"taxonomy",
"frontier",
"sourceHealth",
"generatedCount",
"normalizedCount",
"lowYieldRounds",
"llmCallCount",
"instagramRequestCount",
"lastCheckpointAt",
"createdAt",
"updatedAt",
"minNewGeneratedPerRound",
"legacyEvidence"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema2"
}
}
]
}
}
}Исследование хештегов с фильтрами и курсором
Исследования Чтение
Разрешения: research:read
operationId: research.hashtag.detail
GET /research/hashtag-runs/{id}
GET /research/reels/hashtags/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"run": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"createdByUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"topic": {
"type": "string"
},
"locales": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMode": {
"type": "string"
},
"targetCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"QUEUED",
"RUNNING",
"PAUSED",
"COMPLETE",
"PARTIAL",
"FAILED",
"CANCELLED"
]
},
"health": {
"type": "string",
"enum": [
"HEALTHY",
"DEGRADED",
"BLOCKED"
]
},
"stage": {
"type": "string",
"enum": [
"PLANNING",
"GAP_ANALYSIS",
"EXPANDING",
"VERIFYING",
"FINALIZING"
]
},
"stopReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentBranchId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"cancelRequestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"leaseToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"leaseExpiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"taxonomy": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"frontier": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
},
"sourceHealth": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"generatedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"normalizedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lowYieldRounds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"llmCallCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"instagramRequestCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastCheckpointAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"minNewGeneratedPerRound": {
"type": "number"
},
"legacyEvidence": {
"type": "object",
"properties": {
"checkedCount": {
"type": "number"
},
"verifiedCount": {
"type": "number"
},
"rejectedCount": {
"type": "number"
},
"errorCount": {
"type": "number"
}
},
"required": [
"checkedCount",
"verifiedCount",
"rejectedCount",
"errorCount"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"createdByUserId",
"topic",
"locales",
"targetMode",
"targetCount",
"idempotencyKey",
"status",
"health",
"stage",
"stopReason",
"currentBranchId",
"resumeVersion",
"cancelRequestedAt",
"leaseToken",
"leaseExpiresAt",
"taxonomy",
"frontier",
"sourceHealth",
"generatedCount",
"normalizedCount",
"lowYieldRounds",
"llmCallCount",
"instagramRequestCount",
"lastCheckpointAt",
"createdAt",
"updatedAt",
"minNewGeneratedPerRound",
"legacyEvidence"
],
"additionalProperties": false
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"canonicalTag": {
"type": "string"
},
"displayTag": {
"type": "string"
},
"locale": {
"type": "string"
},
"semanticFamily": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"relevanceScore": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"relevanceReason": {
"type": "string"
},
"taxonomyPath": {
"$ref": "#/$defs/__schema3"
},
"status": {
"type": "string",
"enum": [
"CANDIDATE",
"CHECKING",
"VERIFIED",
"REJECTED",
"ERROR"
]
},
"attemptCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceMediaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceShortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceMediaType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceObservedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"canonicalTag",
"displayTag",
"locale",
"semanticFamily",
"relevanceScore",
"relevanceReason",
"taxonomyPath",
"status",
"attemptCount",
"lastErrorCode",
"evidenceMediaId",
"evidenceShortcode",
"evidenceUrl",
"evidenceMediaType",
"evidenceSource",
"evidenceObservedAt"
],
"additionalProperties": false
}
},
"taxonomyCounts": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"run",
"candidates",
"taxonomyCounts",
"nextCursor"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema2"
}
}
]
},
"__schema3": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema3"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema3"
}
}
]
}
}
}Безопасное состояние исследования хештегов
Исследования Чтение Обслуживание
Разрешения: research:extended:read
operationId: research.hashtag.status
GET /research/hashtag-runs/{id}/status
GET /research/reels/hashtags/{id}/status
Входные параметры · Результат Экспортировать сгенерированные хештеги в CSV
Исследования Изменяет данные
Разрешения: research:read
operationId: research.hashtag.export
GET /research/reels/hashtags/{id}/export
GET /research/hashtag-runs/{id}
GET /research/reels/hashtags/{id}
Входные параметры · Результат Продолжить исследование хештегов
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.hashtag.action
PATCH /research/hashtag-runs/{id}
PATCH /research/reels/hashtags/{id}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"createdByUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"topic": {
"type": "string"
},
"locales": {
"type": "array",
"items": {
"type": "string"
}
},
"targetMode": {
"type": "string"
},
"targetCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"QUEUED",
"RUNNING",
"PAUSED",
"COMPLETE",
"PARTIAL",
"FAILED",
"CANCELLED"
]
},
"health": {
"type": "string",
"enum": [
"HEALTHY",
"DEGRADED",
"BLOCKED"
]
},
"stage": {
"type": "string",
"enum": [
"PLANNING",
"GAP_ANALYSIS",
"EXPANDING",
"VERIFYING",
"FINALIZING"
]
},
"stopReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"currentBranchId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"cancelRequestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"leaseToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"leaseExpiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"taxonomy": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"frontier": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
},
"sourceHealth": {
"anyOf": [
{
"$ref": "#/$defs/__schema2"
},
{
"type": "null"
}
]
},
"generatedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"normalizedCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lowYieldRounds": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"llmCallCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"instagramRequestCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastCheckpointAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"minNewGeneratedPerRound": {
"type": "number"
},
"legacyEvidence": {
"type": "object",
"properties": {
"checkedCount": {
"type": "number"
},
"verifiedCount": {
"type": "number"
},
"rejectedCount": {
"type": "number"
},
"errorCount": {
"type": "number"
}
},
"required": [
"checkedCount",
"verifiedCount",
"rejectedCount",
"errorCount"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspaceId",
"createdByUserId",
"topic",
"locales",
"targetMode",
"targetCount",
"idempotencyKey",
"status",
"health",
"stage",
"stopReason",
"currentBranchId",
"resumeVersion",
"cancelRequestedAt",
"leaseToken",
"leaseExpiresAt",
"taxonomy",
"frontier",
"sourceHealth",
"generatedCount",
"normalizedCount",
"lowYieldRounds",
"llmCallCount",
"instagramRequestCount",
"lastCheckpointAt",
"createdAt",
"updatedAt",
"minNewGeneratedPerRound",
"legacyEvidence"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema1"
}
}
]
},
"__schema2": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema2"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema2"
}
}
]
}
}
}Отменить исследование хештегов
Исследования Изменяет данные Обслуживание
Разрешения: research:write
operationId: research.legacy.hashtag.action
PATCH /research/hashtag-runs/{id}
PATCH /research/reels/hashtags/{id}
Входные параметры · Результат Список конкурентов
Исследования Чтение
Разрешения: research:read
operationId: research.legacy.competitors.get
GET /research/competitors
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"profileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"_count": {
"type": "object",
"properties": {
"videos": {
"type": "number"
}
},
"required": [
"videos"
],
"additionalProperties": false
}
},
"required": [
"id",
"platform",
"handle",
"profileUrl",
"followerCount",
"estimatedMedianViews",
"notes",
"enabled",
"createdAt",
"updatedAt",
"_count"
],
"additionalProperties": false
}
}Сохранить конкурента
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.competitors.post
POST /research/competitors
Входные параметры · Результат Сохранённые Reels
Исследования Чтение
Разрешения: research:read
operationId: research.legacy.saved-reels.get
GET /research/saved-reels
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"platform": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountFollowerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"accountMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"outlierScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectionViralStatus": {
"type": "string"
},
"collectionBaselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionWeightedVirality": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"collectionScoredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"competitor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"handle": {
"type": "string"
},
"platform": {
"type": "string"
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"handle",
"platform",
"followerCount",
"estimatedMedianViews"
],
"additionalProperties": false
},
"analyses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"videoId": {
"type": "string"
},
"hook": {
"type": "string"
},
"structure": {
"type": "string"
},
"adaptation": {
"type": "string"
},
"script": {
"type": "string"
},
"score": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"model": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"videoId",
"hook",
"structure",
"adaptation",
"script",
"score",
"model",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"competitorId",
"platform",
"shortcode",
"videoId",
"url",
"caption",
"postedAt",
"views",
"likes",
"comments",
"shares",
"saves",
"accountFollowerCount",
"accountMedianViews",
"outlierScore",
"collectionViralStatus",
"collectionBaselineMultiplier",
"collectionWeightedVirality",
"collectionScoredAt",
"fetchedAt",
"createdAt",
"updatedAt",
"competitor",
"analyses"
],
"additionalProperties": false
}
}Сохранить Reel
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.saved-reels.post
POST /research/saved-reels
Входные параметры · Результат Входные параметры Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"competitorId": {
"type": "string",
"minLength": 1
},
"platform": {
"default": "instagram",
"type": "string",
"maxLength": 40
},
"url": {
"type": "string",
"format": "uri"
},
"shortcode": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"competitorId",
"url"
],
"additionalProperties": false
}Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"platform": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"fetchedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"id",
"competitorId",
"platform",
"shortcode",
"videoId",
"url",
"caption",
"postedAt",
"views",
"likes",
"comments",
"shares",
"saves",
"fetchedAt",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Списки Dream100
Исследования Чтение
Разрешения: research:read
operationId: research.legacy.dream100-lists.get
GET /research/dream100-lists
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"priority": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"competitor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"profileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"_count": {
"type": "object",
"properties": {
"videos": {
"type": "number"
}
},
"required": [
"videos"
],
"additionalProperties": false
}
},
"required": [
"id",
"platform",
"handle",
"profileUrl",
"followerCount",
"estimatedMedianViews",
"notes",
"enabled",
"createdAt",
"updatedAt",
"_count"
],
"additionalProperties": false
}
},
"required": [
"id",
"competitorId",
"priority",
"reason",
"source",
"createdAt",
"updatedAt",
"competitor"
],
"additionalProperties": false
}
},
"_count": {
"type": "object",
"properties": {
"entries": {
"type": "number"
}
},
"required": [
"entries"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"description",
"createdAt",
"updatedAt",
"entries",
"_count"
],
"additionalProperties": false
}
}Создать список Dream100
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.dream100-lists.post
POST /research/dream100-lists
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"priority": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"competitor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"profileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"_count": {
"type": "object",
"properties": {
"videos": {
"type": "number"
}
},
"required": [
"videos"
],
"additionalProperties": false
}
},
"required": [
"id",
"platform",
"handle",
"profileUrl",
"followerCount",
"estimatedMedianViews",
"notes",
"enabled",
"createdAt",
"updatedAt",
"_count"
],
"additionalProperties": false
}
},
"required": [
"id",
"competitorId",
"priority",
"reason",
"source",
"createdAt",
"updatedAt",
"competitor"
],
"additionalProperties": false
}
},
"_count": {
"type": "object",
"properties": {
"entries": {
"type": "number"
}
},
"required": [
"entries"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"description",
"createdAt",
"updatedAt",
"entries",
"_count"
],
"additionalProperties": false
}Изменить список Dream100
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.dream100-lists.patch
PATCH /research/dream100-lists
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"competitorId": {
"type": "string"
},
"priority": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"competitor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"platform": {
"type": "string"
},
"handle": {
"type": "string"
},
"profileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"estimatedMedianViews": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"_count": {
"type": "object",
"properties": {
"videos": {
"type": "number"
}
},
"required": [
"videos"
],
"additionalProperties": false
}
},
"required": [
"id",
"platform",
"handle",
"profileUrl",
"followerCount",
"estimatedMedianViews",
"notes",
"enabled",
"createdAt",
"updatedAt",
"_count"
],
"additionalProperties": false
}
},
"required": [
"id",
"competitorId",
"priority",
"reason",
"source",
"createdAt",
"updatedAt",
"competitor"
],
"additionalProperties": false
}
},
"_count": {
"type": "object",
"properties": {
"entries": {
"type": "number"
}
},
"required": [
"entries"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"description",
"createdAt",
"updatedAt",
"entries",
"_count"
],
"additionalProperties": false
}Удалить список Dream100
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.dream100-lists.delete
DELETE /research/dream100-lists
Входные параметры · Результат Список анализов видео
Исследования Чтение
Разрешения: research:read
operationId: research.legacy.analyses.get
GET /research/analyses
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"videoId": {
"type": "string"
},
"hook": {
"type": "string"
},
"structure": {
"type": "string"
},
"adaptation": {
"type": "string"
},
"script": {
"type": "string"
},
"score": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"model": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"video": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"competitor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"handle": {
"type": "string"
},
"platform": {
"type": "string"
}
},
"required": [
"id",
"handle",
"platform"
],
"additionalProperties": false
}
},
"required": [
"id",
"url",
"caption",
"competitor"
],
"additionalProperties": false
}
},
"required": [
"id",
"videoId",
"hook",
"structure",
"adaptation",
"script",
"score",
"model",
"createdAt",
"updatedAt",
"video"
],
"additionalProperties": false
}
}Исследовать Reels по ключевым словам, хештегам и исходным аккаунтам
Исследования Изменяет данные
Разрешения: research:write
operationId: research.legacy.reels.post
POST /research/reels
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"seedAccounts": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "string"
}
},
"includeSamples": {
"type": "boolean"
},
"limit": {
"type": "number"
},
"dateRange": {
"type": "object",
"properties": {
"preset": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"to": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"strict": {
"type": "boolean"
},
"label": {
"type": "string"
}
},
"required": [
"preset",
"from",
"to",
"strict",
"label"
],
"additionalProperties": false
}
},
"required": [
"keywords",
"hashtags",
"seedAccounts",
"excludeKeywords",
"includeSamples",
"limit",
"dateRange"
],
"additionalProperties": false
},
"startedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"collector": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"message": {
"type": "string"
},
"health": {
"type": "string"
},
"reason": {
"type": "string"
},
"diagnostics": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"collector",
"sourceStatus",
"message"
],
"additionalProperties": false
}
},
"parserDisconnected": {
"type": "boolean"
},
"reels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"handle": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionLanguage": {
"type": "string"
},
"captionLanguageLabel": {
"type": "string"
},
"captionLanguageEvidence": {
"type": "string"
},
"postedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"saves": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followerCount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"followers": {
"type": "object",
"properties": {
"count": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"const": "profile_html_meta"
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approximate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"count",
"source",
"fetchedAt",
"approximate"
],
"additionalProperties": false
},
"accountMedianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountViewSamples": {
"type": "array",
"items": {
"type": "number"
}
},
"platform": {
"type": "string"
},
"profileUrl": {
"type": "string"
},
"shortcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"type": "string"
},
"sourceStatus": {
"type": "string"
},
"statusMessage": {
"type": "string"
},
"matchType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"matchedTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSnippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"evidenceSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"score": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"velocityScore": {
"type": "number"
},
"engagementScore": {
"type": "number"
},
"recencyScore": {
"type": "number"
},
"capacityScore": {
"type": "number"
},
"outlierScore": {
"type": "number"
},
"confidenceScore": {
"type": "number"
},
"reliabilityScore": {
"type": "number"
},
"penaltyScore": {
"type": "number"
},
"viewsPerDay": {
"type": "number"
},
"engagementRate": {
"type": "number"
},
"normalizedViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"viewsPerFollower": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"weightedViralityScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"baselineMultiplier": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"robustZScore": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"medianViews": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iqr": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mad": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"accountSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"ageDays": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"sampleSize": {
"type": "number"
},
"label": {
"type": "string"
},
"outlierLabel": {
"type": "string"
},
"confidenceLabel": {
"type": "string"
},
"viralStatus": {
"type": "string"
},
"viralLabel": {
"type": "string"
},
"evidenceBasis": {
"type": "string"
},
"explanation": {
"type": "string"
},
"hasAccountContext": {
"type": "boolean"
},
"formulaVersion": {
"type": "string"
}
},
"required": [
"score",
"velocityScore",
"engagementScore",
"recencyScore",
"capacityScore",
"outlierScore",
"confidenceScore",
"reliabilityScore",
"penaltyScore",
"viewsPerDay",
"engagementRate",
"normalizedViews",
"viewsPerFollower",
"weightedViralityScore",
"baselineMultiplier",
"robustZScore",
"medianViews",
"iqr",
"mad",
"accountSize",
"ageDays",
"sampleSize",
"label",
"outlierLabel",
"confidenceLabel",
"viralStatus",
"viralLabel",
"evidenceBasis",
"explanation",
"hasAccountContext",
"formulaVersion"
],
"additionalProperties": false
},
"videoId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"saved": {
"type": "boolean"
}
},
"required": [
"url",
"handle",
"caption",
"source",
"sourceStatus",
"statusMessage",
"score"
],
"additionalProperties": false
}
},
"continuation": {
"anyOf": [
{
"$ref": "#/$defs/__schema1"
},
{
"type": "null"
}
]
},
"incomplete": {
"type": "boolean"
}
},
"required": [
"input",
"startedAt",
"finishedAt",
"statuses",
"parserDisconnected",
"reels",
"continuation",
"incomplete"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema1"
}
}
]
}
}
}Проверить доступность создания серии.
Лаборатория контента Чтение
Разрешения: content-lab:read
operationId: content-lab.eligibility
GET /content-lab/eligibility
Входные параметры · Результат Список серий и вариантов.
Лаборатория контента Чтение
Разрешения: content-lab:read
operationId: content-lab.experiments.list
GET /content-lab/experiments
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"experiments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"createdByUserId": {
"type": "string"
},
"publicationTarget": {
"type": "string",
"enum": [
"TRIAL",
"PROFILE"
]
},
"sourceType": {
"type": "string"
},
"sourceInstagramMediaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceFileState": {
"type": "string"
},
"originalCaption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionMode": {
"type": "string",
"enum": [
"ORIGINAL",
"AI"
]
},
"requestedVariantCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experimentId": {
"type": "string"
},
"ordinal": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"seed": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"generationVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileSizeBytes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionStatus": {
"type": "string"
},
"captionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"captionError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generationStatus": {
"type": "string"
},
"fileState": {
"type": "string"
},
"posterFileState": {
"type": "string"
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
},
"captionFeatureAvailable": {
"type": "boolean"
}
},
"required": [
"id",
"experimentId",
"ordinal",
"seed",
"revision",
"generationVersion",
"fileVersion",
"fileSizeBytes",
"durationMs",
"width",
"height",
"sha256",
"caption",
"captionStatus",
"captionVersion",
"captionError",
"generationStatus",
"fileState",
"posterFileState",
"publication",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
}
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"instagramAccountId",
"createdByUserId",
"publicationTarget",
"sourceType",
"sourceInstagramMediaId",
"sourceFileState",
"originalCaption",
"captionMode",
"requestedVariantCount",
"status",
"version",
"lastErrorCode",
"lastErrorMessage",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
},
"required": [
"experiments"
],
"additionalProperties": false
}Серия и её варианты.
Лаборатория контента Чтение
Разрешения: content-lab:read
operationId: content-lab.experiments.get
GET /content-lab/experiments/{experimentId}
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"experiment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"createdByUserId": {
"type": "string"
},
"publicationTarget": {
"type": "string",
"enum": [
"TRIAL",
"PROFILE"
]
},
"sourceType": {
"type": "string"
},
"sourceInstagramMediaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceFileState": {
"type": "string"
},
"originalCaption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionMode": {
"type": "string",
"enum": [
"ORIGINAL",
"AI"
]
},
"requestedVariantCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experimentId": {
"type": "string"
},
"ordinal": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"seed": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"generationVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileSizeBytes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionStatus": {
"type": "string"
},
"captionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"captionError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generationStatus": {
"type": "string"
},
"fileState": {
"type": "string"
},
"posterFileState": {
"type": "string"
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
},
"captionFeatureAvailable": {
"type": "boolean"
}
},
"required": [
"id",
"experimentId",
"ordinal",
"seed",
"revision",
"generationVersion",
"fileVersion",
"fileSizeBytes",
"durationMs",
"width",
"height",
"sha256",
"caption",
"captionStatus",
"captionVersion",
"captionError",
"generationStatus",
"fileState",
"posterFileState",
"publication",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
}
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"instagramAccountId",
"createdByUserId",
"publicationTarget",
"sourceType",
"sourceInstagramMediaId",
"sourceFileState",
"originalCaption",
"captionMode",
"requestedVariantCount",
"status",
"version",
"lastErrorCode",
"lastErrorMessage",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"experiment"
],
"additionalProperties": false
}Безопасное состояние серии.
Лаборатория контента Чтение Обслуживание
Разрешения: content-lab:read
operationId: content-lab.experiments.status
GET /content-lab/experiments/{experimentId}/status
Входные параметры · Результат Аналитика опубликованных вариантов.
Лаборатория контента Чтение
Разрешения: content-lab:read
operationId: content-lab.analytics
GET /content-lab/analytics
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"totals": {
"type": "object",
"properties": {
"views": {
"type": "number"
},
"reach": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
},
"saved": {
"type": "number"
},
"shares": {
"type": "number"
},
"interactions": {
"type": "number"
},
"published": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"follows": {
"type": "null"
}
},
"required": [
"views",
"reach",
"likes",
"comments",
"saved",
"shares",
"interactions",
"published",
"follows"
],
"additionalProperties": false
},
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"views": {
"type": "number"
},
"reach": {
"type": "number"
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
},
"saved": {
"type": "number"
},
"shares": {
"type": "number"
},
"id": {
"type": "string"
},
"experimentId": {
"type": "string"
},
"variant": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"username": {
"type": "string"
},
"permalink": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"type": "string"
},
"total_interactions": {
"type": "number"
},
"follows": {
"type": "null"
}
},
"required": [
"views",
"reach",
"likes",
"comments",
"saved",
"shares",
"id",
"experimentId",
"variant",
"username",
"permalink",
"publishedAt",
"caption",
"total_interactions",
"follows"
],
"additionalProperties": {}
}
},
"followsUnavailableReason": {
"type": "string"
}
},
"required": [
"totals",
"publications",
"followsUnavailableReason"
],
"additionalProperties": {}
}Последние или лучшие Reels аккаунта.
Лаборатория контента Чтение
Разрешения: content-lab:read
operationId: content-lab.account-analysis.get
GET /content-lab/account-analysis
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
},
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sourceCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"type": "string"
},
"thumbnailUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timestamp": {
"type": "string"
},
"views": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"reach": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"likes": {
"type": "number"
},
"comments": {
"type": "number"
}
},
"required": [
"id",
"sourceCursor",
"caption",
"thumbnailUrl",
"timestamp",
"views",
"reach",
"likes",
"comments"
],
"additionalProperties": false
}
},
"scannedMediaCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"account",
"posts",
"scannedMediaCount",
"nextCursor"
],
"additionalProperties": false
}Создать серию из готовой загрузки content-lab. Загрузка потребляется один раз.
Лаборатория контента Изменяет данные
Разрешения: content-lab:write
operationId: content-lab.experiments.create
POST /content-lab/experiments
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experiment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"createdByUserId": {
"type": "string"
},
"publicationTarget": {
"type": "string",
"enum": [
"TRIAL",
"PROFILE"
]
},
"sourceType": {
"type": "string"
},
"sourceInstagramMediaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceFileState": {
"type": "string"
},
"originalCaption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionMode": {
"type": "string",
"enum": [
"ORIGINAL",
"AI"
]
},
"requestedVariantCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experimentId": {
"type": "string"
},
"ordinal": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"seed": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"generationVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileSizeBytes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionStatus": {
"type": "string"
},
"captionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"captionError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generationStatus": {
"type": "string"
},
"fileState": {
"type": "string"
},
"posterFileState": {
"type": "string"
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
},
"captionFeatureAvailable": {
"type": "boolean"
}
},
"required": [
"id",
"experimentId",
"ordinal",
"seed",
"revision",
"generationVersion",
"fileVersion",
"fileSizeBytes",
"durationMs",
"width",
"height",
"sha256",
"caption",
"captionStatus",
"captionVersion",
"captionError",
"generationStatus",
"fileState",
"posterFileState",
"publication",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
}
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"instagramAccountId",
"createdByUserId",
"publicationTarget",
"sourceType",
"sourceInstagramMediaId",
"sourceFileState",
"originalCaption",
"captionMode",
"requestedVariantCount",
"status",
"version",
"lastErrorCode",
"lastErrorMessage",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"experiment",
"statusUrl"
],
"additionalProperties": false
}Создать серию из Reel аккаунта.
Лаборатория контента Изменяет данные
Разрешения: content-lab:write
operationId: content-lab.account-analysis.create
POST /content-lab/account-analysis
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experiment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"createdByUserId": {
"type": "string"
},
"publicationTarget": {
"type": "string",
"enum": [
"TRIAL",
"PROFILE"
]
},
"sourceType": {
"type": "string"
},
"sourceInstagramMediaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceFileState": {
"type": "string"
},
"originalCaption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionMode": {
"type": "string",
"enum": [
"ORIGINAL",
"AI"
]
},
"requestedVariantCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experimentId": {
"type": "string"
},
"ordinal": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"seed": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"generationVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileSizeBytes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionStatus": {
"type": "string"
},
"captionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"captionError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generationStatus": {
"type": "string"
},
"fileState": {
"type": "string"
},
"posterFileState": {
"type": "string"
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
},
"captionFeatureAvailable": {
"type": "boolean"
}
},
"required": [
"id",
"experimentId",
"ordinal",
"seed",
"revision",
"generationVersion",
"fileVersion",
"fileSizeBytes",
"durationMs",
"width",
"height",
"sha256",
"caption",
"captionStatus",
"captionVersion",
"captionError",
"generationStatus",
"fileState",
"posterFileState",
"publication",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
}
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspaceId",
"instagramAccountId",
"createdByUserId",
"publicationTarget",
"sourceType",
"sourceInstagramMediaId",
"sourceFileState",
"originalCaption",
"captionMode",
"requestedVariantCount",
"status",
"version",
"lastErrorCode",
"lastErrorMessage",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"experiment",
"statusUrl"
],
"additionalProperties": false
}Сохранить описание с проверкой версии.
Лаборатория контента Изменяет данные
Разрешения: content-lab:write
operationId: content-lab.caption.edit
PATCH /content-lab/experiments/{experimentId}/variants/{variantId}/caption
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"variant": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"experimentId": {
"type": "string"
},
"ordinal": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"seed": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"generationVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"fileSizeBytes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"durationMs": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"width": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"height": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionStatus": {
"type": "string"
},
"captionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"captionError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"generationStatus": {
"type": "string"
},
"fileState": {
"type": "string"
},
"posterFileState": {
"type": "string"
},
"publication": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
},
"captionFeatureAvailable": {
"type": "boolean"
}
},
"required": [
"id",
"experimentId",
"ordinal",
"seed",
"revision",
"generationVersion",
"fileVersion",
"fileSizeBytes",
"durationMs",
"width",
"height",
"sha256",
"caption",
"captionStatus",
"captionVersion",
"captionError",
"generationStatus",
"fileState",
"posterFileState",
"publication",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
}
},
"required": [
"variant"
],
"additionalProperties": false
}Запланировать вариант серии.
Лаборатория контента Изменяет данные
Разрешения: content-lab:write
operationId: content-lab.schedule
POST /content-lab/experiments/{experimentId}/variants/{variantId}/schedule
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"publication": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
},
"statusUrl": {
"type": "string"
}
},
"required": [
"publication",
"statusUrl"
],
"additionalProperties": false
}Отменить запланированный вариант до начала публикации.
Лаборатория контента Изменяет данные Обслуживание
Разрешения: content-lab:write
operationId: content-lab.cancel
POST /content-lab/experiments/{experimentId}/variants/{variantId}/cancel
Входные параметры · Результат Запланировать доступные варианты серии с интервалом.
Лаборатория контента Изменяет данные
Разрешения: content-lab:write
operationId: content-lab.plan
POST /content-lab/experiments/{experimentId}/plan
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"publications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variantId": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"actorUserId": {
"type": "string"
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"type": "string"
},
"scheduleVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"actionVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"variantSha256Snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"captionSnapshot": {
"type": "string"
},
"publicationStatus": {
"type": "string"
},
"graduationStrategy": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastErrorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastErrorMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextActionAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"captionEditable": {
"type": "boolean"
}
},
"required": [
"id",
"variantId",
"instagramAccountId",
"actorUserId",
"scheduledAtUtc",
"scheduleTimezone",
"scheduleVersion",
"actionVersion",
"variantRevision",
"variantSha256Snapshot",
"captionSnapshot",
"publicationStatus",
"graduationStrategy",
"apiVersion",
"version",
"lastErrorCode",
"lastErrorMessage",
"nextActionAt",
"createdAt",
"updatedAt",
"captionEditable"
],
"additionalProperties": false
}
},
"statusUrl": {
"type": "string"
}
},
"required": [
"publications",
"statusUrl"
],
"additionalProperties": false
}Список публикаций.
Публикации Чтение
Разрешения: publishing:read
operationId: publishing.posts.list
GET /publishing/posts
Входные параметры · Результат Получить публикацию.
Публикации Чтение
Разрешения: publishing:read
operationId: publishing.posts.get
GET /publishing/posts/{postId}
Входные параметры · Результат Безопасное состояние публикации.
Публикации Чтение Обслуживание
Разрешения: publishing:read
operationId: publishing.posts.status
GET /publishing/posts/{postId}/status
Входные параметры · Результат Создать и запланировать публикацию из загрузки publishing. При schedulingError перенесите созданную публикацию.
Публикации Изменяет данные
Разрешения: publishing:write
operationId: publishing.posts.create
POST /publishing/posts
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"post": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"instagramAccountId": {
"type": "string"
},
"caption": {
"type": "string"
},
"status": {
"type": "string"
},
"publicationTarget": {
"type": "string",
"enum": [
"TRIAL",
"PROFILE"
]
},
"scheduledAtUtc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduleTimezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publishedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"errorCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"canReschedule": {
"type": "boolean"
},
"canCancel": {
"type": "boolean"
}
},
"required": [
"id",
"instagramAccountId",
"caption",
"status",
"publicationTarget",
"scheduledAtUtc",
"scheduleTimezone",
"publishedAt",
"errorCode",
"canReschedule",
"canCancel"
],
"additionalProperties": false
},
"schedulingError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusUrl": {
"type": "string"
}
},
"required": [
"id",
"post",
"schedulingError",
"statusUrl"
],
"additionalProperties": false
}Перенести публикацию.
Публикации Изменяет данные
Разрешения: publishing:write
operationId: publishing.posts.reschedule
PATCH /publishing/posts/{postId}/reschedule
Входные параметры · Результат Отменить публикацию до её начала.
Публикации Изменяет данные Обслуживание
Разрешения: publishing:write
operationId: publishing.posts.cancel
POST /publishing/posts/{postId}/cancel
Входные параметры · Результат Метаданные текущего OAuth-подключения или API-ключа без секрета.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: Авторизованный доступ
operationId: mcp.connection.current.get
Входные параметры · Результат Отозвать только текущее подключение; новые вызовы этим доступом будут запрещены.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: Авторизованный доступ
operationId: mcp.connection.current.revoke
Входные параметры · Результат Безопасное состояние идемпотентной операции. Результаты не раскрываются.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: Авторизованный доступ
operationId: mcp.operation.status
GET /operations/{id}/status
Входные параметры · Результат Создать загрузку видео на один час. Передайте бинарное тело в uploadUrl с Bearer или откройте browserUrl в аккаунте владельца.
Лаборатория контента Изменяет данные
Разрешения: content-lab:write
operationId: mcp.uploads.content-lab.create
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"purpose": {
"type": "string",
"enum": [
"content-lab",
"publishing"
]
},
"status": {
"type": "string",
"enum": [
"CREATED",
"UPLOADING",
"READY",
"CONSUMED",
"CANCELLED",
"DELETING",
"DELETED",
"EXPIRED"
]
},
"mimeType": {
"type": "string"
},
"sizeBytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"expiresAt": {
"type": "string"
},
"uploadUrl": {
"type": "string"
},
"browserUrl": {
"type": "string"
},
"resource": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"purpose",
"status",
"mimeType",
"sizeBytes",
"sha256",
"expiresAt",
"uploadUrl",
"browserUrl",
"resource"
],
"additionalProperties": false
}Создать загрузку видео на один час. Передайте бинарное тело в uploadUrl с Bearer или откройте browserUrl в аккаунте владельца.
Публикации Изменяет данные
Разрешения: publishing:write
operationId: mcp.uploads.publishing.create
Входные параметры · Результат Результат Скопировать
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"purpose": {
"type": "string",
"enum": [
"content-lab",
"publishing"
]
},
"status": {
"type": "string",
"enum": [
"CREATED",
"UPLOADING",
"READY",
"CONSUMED",
"CANCELLED",
"DELETING",
"DELETED",
"EXPIRED"
]
},
"mimeType": {
"type": "string"
},
"sizeBytes": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sha256": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"expiresAt": {
"type": "string"
},
"uploadUrl": {
"type": "string"
},
"browserUrl": {
"type": "string"
},
"resource": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"purpose",
"status",
"mimeType",
"sizeBytes",
"sha256",
"expiresAt",
"uploadUrl",
"browserUrl",
"resource"
],
"additionalProperties": false
}Безопасное состояние загрузки без платной квоты.
Аккаунт и взаимодействия Чтение Обслуживание
Разрешения: Авторизованный доступ
operationId: mcp.uploads.status
Входные параметры · Результат Отменить неиспользованную загрузку и освободить место.
Аккаунт и взаимодействия Изменяет данные Обслуживание
Разрешения: Авторизованный доступ
operationId: mcp.uploads.cancel
Входные параметры · Результат