{ "openapi": "3.0.1", "info": { "title": "Instagram Brand Mentions & UGC Monitor", "description": "Collect newly observed public Instagram tagged posts, keyword results, and campaign hashtag posts in one deduplicated feed with persistent first-seen state.", "version": "1.0", "x-build-id": "zh2xUz58lS8XC4788" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data-slayer~instagram-brand-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data-slayer-instagram-brand-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/data-slayer~instagram-brand-monitor/runs": { "post": { "operationId": "runs-sync-data-slayer-instagram-brand-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/data-slayer~instagram-brand-monitor/run-sync": { "post": { "operationId": "run-sync-data-slayer-instagram-brand-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "monitorId" ], "properties": { "monitorId": { "title": "Monitor ID", "pattern": "^[a-z0-9][a-z0-9_-]{2,63}$", "minLength": 3, "maxLength": 64, "type": "string", "description": "Stable lowercase ID. Reuse it on scheduled runs to keep first-seen state." }, "brandAccount": { "title": "Brand account (optional)", "minLength": 1, "maxLength": 200, "type": "string", "description": "One public Instagram username or profile URL." }, "keywords": { "title": "Brand keywords (optional)", "minItems": 1, "maxItems": 5, "type": "array", "description": "Up to 5 exact phrases. Results retain configured and literal-match evidence.", "items": { "type": "string", "minLength": 2, "maxLength": 80 } }, "hashtags": { "title": "Campaign hashtags (optional)", "minItems": 1, "maxItems": 5, "type": "array", "description": "Up to 5 hashtags, with or without #.", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "firstRunBehavior": { "title": "First run", "enum": [ "emit_current", "baseline_only" ], "type": "string", "description": "Return current posts or save them only as a baseline.", "default": "emit_current" }, "keywordMatchPolicy": { "title": "Keyword result policy", "enum": [ "include_configured_matches", "literal_matches_only" ], "type": "string", "description": "Keep all configured search results or only literal caption, hashtag, or @mention matches.", "default": "include_configured_matches" }, "maxPagesPerInput": { "title": "Maximum pages per monitored input", "minimum": 1, "maximum": 3, "type": "integer", "description": "Check 1–3 pages for each configured source.", "default": 1 }, "maxItemsPerInput": { "title": "Maximum observed items per monitored input", "minimum": 1, "maximum": 100, "type": "integer", "description": "Stop keeping items for an account, keyword, or hashtag after this many unique media IDs. Available results can be lower.", "default": 50 }, "maxItemsPerRun": { "title": "Maximum observed items per run", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap across all monitored inputs. When reached, the Actor stops checking more pages or inputs and reports which inputs were not scanned.", "default": 250 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }