{ "openapi": "3.0.1", "info": { "title": "Beehiiv Newsletter Scraper", "description": "Collect public Beehiiv newsletter profiles and posts from submitted URLs. Return publication details, post metadata, available content in plain text, Markdown, or HTML, plus images, links, and sponsor signals in an Apify dataset. Public pages need no customer credentials.", "version": "0.0", "x-build-id": "DL6KtnyzBBYgQC8Gj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~beehiiv/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-beehiiv", "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/maximedupre~beehiiv/runs": { "post": { "operationId": "runs-sync-maximedupre-beehiiv", "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/maximedupre~beehiiv/run-sync": { "post": { "operationId": "run-sync-maximedupre-beehiiv", "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": [ "resultType" ], "properties": { "resultType": { "title": "Result type", "enum": [ "posts", "newsletterProfiles", "productPages" ], "type": "string", "description": "Choose the kind of public Beehiiv data to return." }, "posts": { "title": "Posts", "type": "object", "description": "Use these fields when Result type is Posts. A publication URL finds its public posts, and a post URL retrieves that post.", "properties": { "urls": { "title": "Publication or post URLs", "type": "array", "description": "Add one or more public Beehiiv publication or post URLs.", "editor": "requestListSources", "prefill": [ "https://product.beehiiv.com/p/post-likes-comments-sharing" ] }, "keywords": { "title": "Post keywords", "type": "array", "description": "Optionally enter one or more words or phrases to filter Posts.", "editor": "stringList", "items": { "type": "string" } }, "dateFrom": { "title": "Published from", "type": "string", "description": "Keep Posts published on or after this date, in UTC.", "editor": "datepicker", "dateType": "absolute", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dateTo": { "title": "Published to", "type": "string", "description": "Keep Posts published on or before this date, in UTC.", "editor": "datepicker", "dateType": "absolute", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "accessLevel": { "title": "Access level", "type": "string", "description": "Keep Posts with this public access state. Omit this field to keep all states.", "editor": "select", "enum": [ "all", "free", "premium", "preview", "metadataOnly", "unavailable" ], "enumTitles": [ "All states", "Free", "Premium", "Preview only", "Metadata only", "Unavailable" ] }, "readingTimeMin": { "title": "Minimum reading time", "type": "integer", "description": "Keep Posts with at least this estimated reading time, in minutes.", "editor": "number", "minimum": 0 }, "readingTimeMax": { "title": "Maximum reading time", "type": "integer", "description": "Keep Posts with no more than this estimated reading time, in minutes.", "editor": "number", "minimum": 0 } } }, "newsletterProfiles": { "title": "Newsletter profiles", "type": "object", "description": "Use these fields when Result type is Newsletter profiles. Add one or more public Beehiiv publication URLs.", "properties": { "publicationUrls": { "title": "Publication URLs", "type": "array", "description": "Add one or more public Beehiiv publication URLs.", "editor": "requestListSources" } } }, "productPages": { "title": "Product pages", "type": "object", "description": "Use these fields when Result type is Product pages.", "properties": { "urls": { "title": "Product URLs", "type": "array", "description": "Add one or more public Beehiiv product page URLs.", "editor": "requestListSources" } } }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Optional work limit for the selected result type. Omit it to collect all available results until the source is exhausted." } } }, "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 } } } } } } } } } }