{ "openapi": "3.0.1", "info": { "title": "Engagement Rate & Fake Follower Checker: Instagram, TikTok & YT", "description": "Engagement rate, fake follower warning signs, creator score, grade and a shortlist/check/skip verdict for Instagram, TikTok and YouTube creators from any scraper dataset, CSV or Sheet. No scraping or login. Follower, engagement and niche filters. Charged per creator scored. Agent-ready: MCP, x402.", "version": "0.1", "x-build-id": "cxeJCWkIUteDXIpzy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nerolabs~engagement-rate-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nerolabs-engagement-rate-checker", "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/nerolabs~engagement-rate-checker/runs": { "post": { "operationId": "runs-sync-nerolabs-engagement-rate-checker", "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/nerolabs~engagement-rate-checker/run-sync": { "post": { "operationId": "run-sync-nerolabs-engagement-rate-checker", "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", "properties": { "datasetIds": { "title": "Datasets", "type": "array", "description": "One or more scraper datasets: Instagram profile or post scrapers, TikTok scrapers, YouTube scrapers. Posts and profiles of the same creator are merged, so add the profile run and the posts run together. Every creator-level column is kept. In an integration set it to [\"{{resource.defaultDatasetId}}\"]." }, "fileUrl": { "title": "File or Google Sheet URL", "type": "string", "description": "A public link to a CSV, Excel, JSON or JSON Lines file: scraper rows, or your own creator list with a username and followers column (plus avgLikes, avgComments or engagementRate if you have them). A normal Google Sheets link works when shared as 'Anyone with the link can view'." }, "fileFormat": { "title": "File format", "enum": [ "auto", "csv", "tsv", "json", "jsonl", "xlsx" ], "type": "string", "description": "Leave on 'Detect automatically' unless the link has no file extension.", "default": "auto" }, "sheetName": { "title": "Excel sheet name", "type": "string", "description": "Which sheet to read from an Excel workbook. Defaults to the first sheet." }, "data": { "title": "Creator rows", "type": "array", "description": "Rows as JSON objects, for a quick run or an AI agent call, e.g. [{\"username\": \"...\", \"platform\": \"instagram\", \"followers\": 25000, \"avgLikes\": 600, \"avgComments\": 25}] or raw scraper rows." }, "minFollowers": { "title": "Minimum followers", "minimum": 0, "type": "integer", "description": "Leave out creators below this follower count (not charged). 0 = no minimum.", "default": 0 }, "maxFollowers": { "title": "Maximum followers", "minimum": 0, "type": "integer", "description": "Leave out creators above this follower count (not charged). 0 = no maximum.", "default": 0 }, "minEngagementRate": { "title": "Minimum engagement rate (%)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Leave out creators whose engagement rate is below this (not charged). 0 = no minimum.", "default": 0 }, "nicheKeywords": { "title": "Niche words", "type": "array", "description": "Keep only creators whose bio, captions or hashtags contain at least one of these words, e.g. fitness, vegan, skincare. Others are left out and not charged.", "items": { "type": "string" } }, "lookbackDays": { "title": "Only posts from the last (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Judge creators on posts from this many days back (used when at least 3 posts fall inside it). 0 = all posts given.", "default": 120 }, "maxPostsPerCreator": { "title": "Posts per creator", "minimum": 1, "maximum": 200, "type": "integer", "description": "The most recent posts used per creator. Pinned posts are left out when there are enough others.", "default": 30 }, "keep": { "title": "Rows to keep", "enum": [ "all", "scored", "not_skip", "shortlist" ], "type": "string", "description": "Which creators to write. 'All' also writes creators that could not be scored (private, no follower count) with the reason.", "default": "all" }, "keepOriginalFields": { "title": "Keep original columns", "type": "boolean", "description": "Keep the creator's own columns from your scraper (profile fields, not every post) next to the new ones.", "default": true }, "exportFormats": { "title": "Also save as a file", "type": "array", "description": "Also save the results as CSV or Excel in the run's key-value store (charged once per file).", "items": { "type": "string", "enum": [ "csv", "xlsx" ], "enumTitles": [ "CSV", "Excel (xlsx)" ] } }, "outputDatasetName": { "title": "Also append to a named dataset", "type": "string", "description": "Name of a dataset to append the results to, to keep a running creator list across runs." }, "maxItems": { "title": "Max input rows", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop reading after this many input rows.", "default": 200000 } } }, "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 } } } } } } } } } }