{ "openapi": "3.0.1", "info": { "title": "Substack Sponsor Intelligence", "description": "Analyze Substack newsletters to extract sponsor data, detect monetization patterns, and generate structured intelligence using pattern matching and AI.", "version": "1.0", "x-build-id": "3NSLyi2EiuUENVfYm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dramatic_jonquil~substack-sponsor-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dramatic_jonquil-substack-sponsor-intelligence", "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/dramatic_jonquil~substack-sponsor-intelligence/runs": { "post": { "operationId": "runs-sync-dramatic_jonquil-substack-sponsor-intelligence", "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/dramatic_jonquil~substack-sponsor-intelligence/run-sync": { "post": { "operationId": "run-sync-dramatic_jonquil-substack-sponsor-intelligence", "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": [ "newsletterUrls" ], "properties": { "newsletterUrls": { "title": "Newsletter URLs", "type": "array", "description": "List of Substack newsletter URLs to analyze", "items": { "type": "string" } }, "maxPostsPerNewsletter": { "title": "Max Posts Per Newsletter", "type": "integer", "description": "How many recent posts to analyze per newsletter (0 = all)", "default": 50 }, "sinceDate": { "title": "Analyze Posts Since", "type": "string", "description": "Only analyze posts published after this date (YYYY-MM-DD)" }, "detectionMode": { "title": "Detection Mode", "enum": [ "pattern_match", "ai_enhanced" ], "type": "string", "description": "pattern_match is cheaper; ai_enhanced uses LLM for better detection", "default": "pattern_match" }, "enableCanonicalFallback": { "title": "Enable Canonical URL Fallback", "type": "boolean", "description": "When archive API returns no post content, fetch the post's canonical URL to extract content. Slightly slower but dramatically improves detection coverage.", "default": true }, "maxAiCharactersPerPost": { "title": "Max AI Characters Per Post", "type": "integer", "description": "Maximum characters of cleaned post content to send to AI in ai_enhanced mode", "default": 12000 }, "requestDelayMs": { "title": "Request Delay (ms)", "type": "integer", "description": "Delay between archive requests per newsletter", "default": 800 }, "chargePerNewsletter": { "title": "Charge Per Newsletter", "type": "boolean", "description": "If true, charge Apify PPE event for each newsletter analyzed", "default": false }, "chargePerAiPost": { "title": "Charge Per AI Post", "type": "boolean", "description": "If true, charge Apify PPE event for each post analyzed in ai_enhanced mode", "default": false }, "includeSummaryRecordInDataset": { "title": "Include Summary Record In Dataset", "type": "boolean", "description": "If true, push a final summary record into the dataset", "default": true }, "includePostsWithNoSponsors": { "title": "Include Posts With No Sponsors", "type": "boolean", "description": "If true, include a row for every analyzed post, even those with no sponsors", "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 } } } } } } } } } }