{ "openapi": "3.0.1", "info": { "title": "SaaS Pricing Monitor — Plans, Change Alerts & Battlecard", "description": "**Stateful SaaS pricing-page monitor.** Structured plan cards (name ↔ price ↔ period ↔ features), typed change events (`price_changed`, `plan_added`, `trial_changed`…) via KV diffing, plus a competitive battlecard. Keyword mode auto-discovers competitor pricing pages — no URL paste needed.", "version": "0.1", "x-build-id": "BHjzNs3dnoEqIpfWK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bovi~saas-pricing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bovi-saas-pricing-monitor", "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/bovi~saas-pricing-monitor/runs": { "post": { "operationId": "runs-sync-bovi-saas-pricing-monitor", "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/bovi~saas-pricing-monitor/run-sync": { "post": { "operationId": "run-sync-bovi-saas-pricing-monitor", "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": { "keyword": { "title": "Keyword (auto-discover competitors)", "type": "string", "description": "Describe the SaaS category and the actor finds the top competitor pricing pages itself — no URL paste needed. Example: 'project management software' or 'email marketing platform'. Combine with explicit URLs below; discovery fills the remaining slots up to Max competitors." }, "pricingPageUrls": { "title": "Pricing page URLs", "type": "array", "description": "Public SaaS pricing page URLs to monitor, e.g. ['https://slack.com/pricing', 'https://www.notion.com/pricing']. Optional when a keyword is set.", "items": { "type": "string" } }, "maxCompetitors": { "title": "Max competitors per run", "minimum": 1, "maximum": 25, "type": "integer", "description": "Cap on the number of pricing pages monitored in one run (explicit URLs + auto-discovered). Each successfully extracted page = one pricing-snapshot charge.", "default": 10 }, "emitBattlecard": { "title": "Emit competitive battlecard", "type": "boolean", "description": "Aggregate all monitored pages into one decision-ready battlecard record: cheapest paid entry, price ranges, free-tier/trial matrix, plan matrix, and this run's changes. One battlecard-report charge per run.", "default": true }, "eventTypes": { "title": "Change event types to emit", "type": "array", "description": "Filter which typed change events are emitted (and charged). Leave empty for ALL. Valid: price_changed, plan_added, plan_removed, trial_changed, annual_discount_changed, billing_period_changed, features_changed, page_changed_unparsed.", "items": { "type": "string" } }, "kvStoreName": { "title": "KV store name for state persistence", "type": "string", "description": "Named Apify Key-Value store that persists per-URL pricing state between runs. Keep the same name across scheduled runs to enable change detection — the first run on a URL bootstraps a baseline and emits no change events.", "default": "saas-pricing-monitor-state" }, "forceBrowser": { "title": "Force browser rendering", "type": "boolean", "description": "Skip the fast static fetch and render every page in a stealth browser (Camoufox). Slower; use only if a target page returns empty plans via the default path. The actor normally escalates to the browser automatically when needed.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Defaults to US residential proxies — pinning one country keeps geo-localized pricing pages stable between runs (a rotating exit country flips currencies and re-baselines your monitors).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }