{ "openapi": "3.0.1", "info": { "title": "Instagram Mentions Tagged Brand Monitor", "description": "Track Instagram posts where a brand or account is tagged or mentioned. Export flat, analytics-ready data for brand monitoring, UGC discovery, influencer campaign tracking, and competitor research.", "version": "1.0", "x-build-id": "qus6myp5mIInYL4bf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~instagram-mentions-tagged-brand-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-instagram-mentions-tagged-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/coregent~instagram-mentions-tagged-brand-monitor/runs": { "post": { "operationId": "runs-sync-coregent-instagram-mentions-tagged-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/coregent~instagram-mentions-tagged-brand-monitor/run-sync": { "post": { "operationId": "run-sync-coregent-instagram-mentions-tagged-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": [ "targets", "sessionCookie" ], "properties": { "targets": { "title": "Target Handles", "type": "array", "description": "Instagram usernames / handles to monitor. Provide without the leading @. Example: brandname", "items": { "type": "string" }, "default": [ "nike" ] }, "sessionCookie": { "title": "Instagram sessionid Cookie", "type": "string", "description": "Required — paste your Instagram `sessionid` cookie here. Instagram login-walls the tagged-feed endpoints, so the actor authenticates as you to retrieve data.\n\n**Get it in 30 seconds:** sign in at instagram.com → open DevTools (F12) → Application tab → Cookies → https://www.instagram.com → copy the `sessionid` value. Full walkthrough in the README.\n\nThe value is used only for this run — never logged, never written to the dataset. Treat it like a password. Tip: use a secondary Instagram account, not your main." }, "resultsLimit": { "title": "Results Limit (per target)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of matched posts to return per target handle.", "default": 200 }, "maxTargets": { "title": "Max Targets to Process", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of target handles to process in a single run.", "default": 25 }, "includeTagged": { "title": "Include Tagged Posts", "type": "boolean", "description": "Include posts where the target is tagged (usertag / photo tag).", "default": true }, "includeMentioned": { "title": "Include Mentioned Posts", "type": "boolean", "description": "Include posts that mention the target handle (e.g. @target) in the caption.", "default": true }, "startDate": { "title": "Start Date", "type": "string", "description": "Optional lower date bound (ISO 8601, e.g. 2026-01-01). Posts older than this are excluded." }, "endDate": { "title": "End Date", "type": "string", "description": "Optional upper date bound (ISO 8601, e.g. 2026-04-30). Posts newer than this are excluded." }, "postTypes": { "title": "Post Types", "uniqueItems": true, "type": "array", "description": "Filter by media type. Leave empty or include 'all' to accept every type.", "items": { "type": "string", "enum": [ "all", "post", "reel", "video", "carousel" ], "enumTitles": [ "All types", "Image post", "Reel", "Video", "Carousel" ] }, "default": [ "all" ] }, "sortOrder": { "title": "Sort Order", "enum": [ "platform_default", "newest", "oldest" ], "type": "string", "description": "Order matched posts. Default follows the platform's native order.", "default": "platform_default" }, "includeAuthorDetails": { "title": "Include Author Details", "type": "boolean", "description": "Include post author fields (verified, follower count when available, category) on each matched row.", "default": true }, "includeCaption": { "title": "Include Caption", "type": "boolean", "description": "Include the post caption text in the output.", "default": true }, "includeRecentCommentsPreview": { "title": "Include Recent Comments Preview", "type": "boolean", "description": "Include a short preview of recent comments on each matched post (best effort).", "default": false }, "brandKeywords": { "title": "Brand Keywords", "type": "array", "description": "Optional brand-related keywords to match against captions/hashtags. Matches surface in brandKeywordMatches and hasBrandKeywordHint.", "items": { "type": "string" }, "default": [] }, "dedupeByPostId": { "title": "Deduplicate by Post ID", "type": "boolean", "description": "Return only one row per matched post even if a post matches multiple targets.", "default": true }, "excludeOwnPosts": { "title": "Exclude Own Posts", "type": "boolean", "description": "Exclude posts authored by the target handle itself (useful for UGC-only monitoring).", "default": false }, "requestTimeoutSecs": { "title": "Request Timeout (seconds)", "minimum": 30, "maximum": 900, "type": "integer", "description": "Maximum time in seconds for processing each target handle.", "default": 300 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of targets to process concurrently.", "default": 1 }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Enable verbose logging for debugging.", "default": false } } }, "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 } } }, "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 } } } } } } } } } }