{ "openapi": "3.0.1", "info": { "title": "Creator Campaign Score & Audience Signal API", "description": "Score supplied creator metrics for campaign shortlists with transparent reach, engagement, views, consistency, data quality, cohort ranks, and anomaly signals.", "version": "0.1", "x-build-id": "ULglm5gywEgsD3wYT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/8tp~creator-campaign-suitability-score-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-8tp-creator-campaign-suitability-score-api", "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/8tp~creator-campaign-suitability-score-api/runs": { "post": { "operationId": "runs-sync-8tp-creator-campaign-suitability-score-api", "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/8tp~creator-campaign-suitability-score-api/run-sync": { "post": { "operationId": "run-sync-8tp-creator-campaign-suitability-score-api", "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": { "creator_dataset_id": { "title": "Creator metrics dataset", "type": "string", "description": "Optional selected Apify Dataset containing rows in the documented aggregate-metrics contract. It takes precedence over inline creators." }, "creators": { "title": "Supplied creator metric rows", "minItems": 1, "maxItems": 10000, "type": "array", "description": "Aggregate metrics only; do not supply bios, captions, comments, audience-member data, contact data, or source objects.", "items": { "type": "object", "additionalProperties": false, "required": [ "creator_id", "platform", "followers", "posts_sampled" ], "properties": { "creator_id": { "type": "string", "title": "Private creator identifier", "description": "Caller-chosen identifier used to create a namespaced pseudonym. Hidden in output by default.", "minLength": 1, "maxLength": 256 }, "platform": { "type": "string", "title": "Platform family", "description": "Caller-declared broad platform family; this does not authenticate source provenance.", "editor": "select", "enum": [ "generic", "instagram", "tiktok", "youtube", "other" ], "enumTitles": [ "Generic", "Instagram", "TikTok", "YouTube", "Other" ] }, "followers": { "type": "integer", "title": "Followers", "description": "Supplied follower count at the measurement time.", "minimum": 0, "maximum": 2000000000 }, "average_likes": { "type": "number", "title": "Average likes", "description": "Average likes across the caller's declared sample.", "minimum": 0, "maximum": 2000000000 }, "average_comments": { "type": "number", "title": "Average comments", "description": "Average comments across the same declared sample. Comment text is neither accepted nor needed.", "minimum": 0, "maximum": 2000000000 }, "average_views": { "type": "number", "title": "Average views", "description": "Average views across the same declared sample, when the source exposes a comparable view counter.", "minimum": 0, "maximum": 20000000000 }, "posts_sampled": { "type": "integer", "title": "Posts sampled", "description": "Number of posts represented by the supplied averages.", "minimum": 1, "maximum": 1000000 }, "interaction_cv": { "type": "number", "title": "Interaction coefficient of variation", "description": "Optional standard deviation divided by mean for per-post likes plus comments. Supply a nonnegative value.", "minimum": 0, "maximum": 10 }, "view_cv": { "type": "number", "title": "View coefficient of variation", "description": "Optional standard deviation divided by mean for per-post view counts.", "minimum": 0, "maximum": 10 } } }, "default": [ { "creator_id": "sample-alpha", "platform": "instagram", "followers": 42000, "average_likes": 1680, "average_comments": 84, "average_views": 31000, "posts_sampled": 24, "interaction_cv": 0.42, "view_cv": 0.55 }, { "creator_id": "sample-bravo", "platform": "tiktok", "followers": 180000, "average_likes": 7200, "average_comments": 310, "average_views": 265000, "posts_sampled": 30, "interaction_cv": 0.78, "view_cv": 0.91 }, { "creator_id": "sample-charlie", "platform": "youtube", "followers": 85000, "average_likes": 3100, "average_comments": 240, "average_views": 52000, "posts_sampled": 18, "interaction_cv": 0.36, "view_cv": 0.48 }, { "creator_id": "sample-delta", "platform": "generic", "followers": 12000, "average_likes": 460, "average_comments": 22, "average_views": 8200, "posts_sampled": 12, "interaction_cv": 0.61, "view_cv": 0.74 } ] }, "id_namespace": { "title": "Private ID namespace", "minLength": 8, "maxLength": 256, "type": "string", "description": "Owner-chosen namespace mixed into stable pseudonymous row IDs. Use a campaign or workspace-specific value; it is never emitted.", "default": "private-campaign" }, "include_creator_ids": { "title": "Include raw creator IDs", "type": "boolean", "description": "Off by default for data minimization. Enable only when authorized workflows need the supplied identifier in output.", "default": false }, "max_creator_rows": { "title": "Maximum creator rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on selected Dataset rows read and scored. The 10,000-row ceiling keeps paid-event reconciliation bounded.", "default": 10000 }, "max_source_bytes": { "title": "Maximum source bytes", "minimum": 100000, "maximum": 32000000, "type": "integer", "description": "Maximum compact-JSON bytes retained from the selected source before scoring stops.", "default": 16000000 }, "max_source_row_bytes": { "title": "Maximum bytes per row", "minimum": 1024, "maximum": 1000000, "type": "integer", "description": "Reject a single oversized source row instead of partially interpreting it.", "default": 100000 }, "as_of": { "title": "Analysis timestamp", "type": "string", "description": "Optional timezone-aware ISO 8601 semantic timestamp. Omit for deterministic null output." } } }, "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 } } } } } } } } } }