{ "openapi": "3.0.1", "info": { "title": "Influencer Campaign Analytics API - Posts, Creators, Storyclash", "description": "Export influencer campaign data from your own Storyclash account: every campaign, every tracked post on Instagram, TikTok, YouTube, Facebook and X with reach, interactions and media value, and every creator with followers, cost, shop sales and link clicks. Read only. Bring your own token.", "version": "0.1", "x-build-id": "YPD6RrBFxXo8vfnxO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~influencer-campaign-analytics-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-influencer-campaign-analytics-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/nabeelbaghoor~influencer-campaign-analytics-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-influencer-campaign-analytics-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/nabeelbaghoor~influencer-campaign-analytics-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-influencer-campaign-analytics-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": { "mode": { "title": "What to read", "enum": [ "campaigns", "posts", "creators" ], "type": "string", "description": "Campaigns lists every campaign and market report in your account and needs nothing else, so it is the default. Campaign posts reads every post the chosen campaigns tracked, with metrics and creator. Campaign creators reads every creator in the chosen campaigns, including those without posts, with followers, cost, shop sales and link clicks.", "default": "campaigns" }, "campaignIds": { "title": "Campaign IDs", "type": "array", "description": "Posts and creators modes. The campaign number, as the campaigns mode lists it, or the campaign URL (app.storyclash.com/campaigns/detail/1234). Up to 100 per run.", "items": { "type": "string" } }, "from": { "title": "Start date", "type": "string", "description": "Posts and creators modes. Read from this date (YYYY-MM-DD, an ISO timestamp or unix seconds). It must fall inside the campaign period; leave empty for the campaign start." }, "to": { "title": "End date", "type": "string", "description": "Posts and creators modes. Read up to this date, inclusive for a plain date. It must fall inside the campaign period; leave empty for the campaign end." }, "platforms": { "title": "Platforms", "type": "array", "description": "Posts mode. Keep only posts from these platforms. Leave empty for all.", "items": { "type": "string", "enum": [ "Instagram", "TikTok", "Youtube", "Facebook", "Twitter" ], "enumTitles": [ "Instagram", "TikTok", "YouTube", "Facebook", "X (Twitter)" ] } }, "postTypes": { "title": "Post types", "type": "array", "description": "Posts mode. Keep only these post types. Leave empty for all.", "items": { "type": "string", "enum": [ "Post", "Story", "Reel", "Video", "Shorts" ] } }, "campaignType": { "title": "Campaign type", "enum": [ "all", "campaign", "marketReport" ], "type": "string", "description": "Campaigns mode. Keep campaigns, market reports or both.", "default": "all" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 250000, "type": "integer", "description": "The most rows this run returns and charges for. The provider returns posts 1,000 per page and caps an account at 250,000 posts.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 60, "type": "integer", "description": "Pacing. The provider allows one request per hour for each result page of a campaign, and one every 10 seconds while it sets up a new API account.", "default": 6 }, "apiKey": { "title": "API token", "type": "string", "description": "Your own Storyclash API token, which Storyclash issues on request through your customer success manager. Stored as a secret. You can instead set the DATA_API_KEY environment secret." } } }, "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 } } } } } } } } } }