{ "openapi": "3.0.1", "info": { "title": "Local Competitor Service Page Snapshot", "description": "Snapshot local competitor service pages and extract services, geography, proof, CTAs, offers, reviews, media, and page-positioning evidence", "version": "1.0", "x-build-id": "aS2mzD479c4uDqCEU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~local-competitor-service-page-snapshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-local-competitor-service-page-snapshot", "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/junipr~local-competitor-service-page-snapshot/runs": { "post": { "operationId": "runs-sync-junipr-local-competitor-service-page-snapshot", "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/junipr~local-competitor-service-page-snapshot/run-sync": { "post": { "operationId": "run-sync-junipr-local-competitor-service-page-snapshot", "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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Public pages to fetch when HTML snapshots are not supplied.", "items": { "type": "string" }, "default": [] }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Optional public XML sitemaps used for same-domain discovery.", "items": { "type": "string" }, "default": [] }, "htmlInputs": { "title": "HTML snapshots", "type": "array", "description": "Optional source-backed HTML snapshots for deterministic extraction.", "items": { "type": "object", "required": [ "html" ], "properties": { "sourceId": { "type": "string", "title": "Source Id", "description": "Source Id value for htmlInputs.items." }, "sourceUrl": { "type": "string", "title": "Source Url", "description": "Source Url value for htmlInputs.items." }, "title": { "type": "string", "title": "Title", "description": "Title value for htmlInputs.items." }, "html": { "type": "string", "title": "Html", "description": "Html value for htmlInputs.items." }, "currentHtml": { "type": "string", "title": "Current Html", "description": "Current Html value for htmlInputs.items." }, "sourceType": { "type": "string", "title": "Source Type", "description": "Source Type value for htmlInputs.items." }, "httpStatus": { "type": "integer", "title": "Http Status", "description": "Http Status value for htmlInputs.items." } } }, "default": [] }, "allowedDomains": { "title": "Allowed domains", "type": "array", "description": "Optional domain allowlist applied to every fetched or discovered URL.", "items": { "type": "string" }, "default": [] }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum public pages fetched or analyzed.", "default": 1 }, "maxDepth": { "title": "Maximum crawl depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "Same-domain internal-link discovery depth.", "default": 0 }, "includeEvidence": { "title": "Include evidence", "type": "boolean", "description": "Include source excerpts in dataset rows.", "default": true }, "includeRawSnapshots": { "title": "Include raw snapshots", "type": "boolean", "description": "Write capped raw HTML snapshots to key-value storage.", "default": false }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between public HTTP requests in milliseconds.", "default": 250 }, "timeoutMs": { "title": "Request timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 15000 }, "userAgentMode": { "title": "User agent mode", "enum": [ "standard", "compatibility" ], "type": "string", "description": "HTTP user-agent profile.", "default": "standard" }, "competitorUrls": { "title": "Competitor URLs", "type": "array", "description": "Public competitor service or location pages.", "items": { "type": "string" }, "default": [ "https://example.com/" ] }, "targetServices": { "title": "Target services", "type": "array", "description": "Services checked in visible competitor copy.", "items": { "type": "string" }, "default": [] }, "targetLocations": { "title": "Target locations", "type": "array", "description": "Locations checked in visible competitor copy.", "items": { "type": "string" }, "default": [] }, "captureScreenshots": { "title": "Capture screenshots", "type": "boolean", "description": "Reserved compatibility flag; static HTML runs emit an explicit diagnostic when true.", "default": false }, "extractOffers": { "title": "Extract offers", "type": "boolean", "description": "Extract visible discounts, free estimates, and special offers.", "default": true }, "compareToOwnUrl": { "title": "Owned comparison URL", "type": "string", "description": "Optional owned page processed with identical evidence logic.", "default": "" }, "maxCompetitors": { "title": "Maximum competitors", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum competitor domains analyzed.", "default": 1 }, "maxPagesPerCompetitor": { "title": "Maximum pages per competitor", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum pages retained for each competitor domain.", "default": 1 }, "maxChargeUsd": { "title": "Maximum charge", "minimum": 0, "maximum": 100, "type": "number", "description": "Maximum estimated PPE spend before a graceful stop.", "default": 35 }, "includeReport": { "title": "Generate reports", "type": "boolean", "description": "Write Markdown, CSV, JSON evidence, and run metadata.", "default": true } } }, "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 } } } } } } } } } }