{ "openapi": "3.0.1", "info": { "title": "Lead Enrichment Pipeline", "description": "Turn a list of company domains into CRM ready rows. One pass returns contact details, the technology each company runs, and whether they are hiring, so a raw domain list becomes a qualified account list.", "version": "0.1", "x-build-id": "lfLEuhBf8B4cv0kwN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~lead-enrichment-pipeline/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-lead-enrichment-pipeline", "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/arched_friend~lead-enrichment-pipeline/runs": { "post": { "operationId": "runs-sync-arched_friend-lead-enrichment-pipeline", "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/arched_friend~lead-enrichment-pipeline/run-sync": { "post": { "operationId": "run-sync-arched_friend-lead-enrichment-pipeline", "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": [ "websites" ], "properties": { "websites": { "title": "Company websites", "type": "array", "description": "One entry per company. Bare domains such as gymshark.com or full URLs both work.", "items": { "type": "string" } }, "enrichContacts": { "title": "Find contact details", "type": "boolean", "description": "Emails, phone numbers and social profiles, read from the homepage and contact pages.", "default": true }, "enrichTechnologies": { "title": "Find the technology stack", "type": "boolean", "description": "Ecommerce platform, CMS, analytics, payments, marketing and support tools.", "default": true }, "enrichHiring": { "title": "Find hiring signals", "type": "boolean", "description": "Looks for the company's public job board and reports how many roles are open. Hiring is the earliest public sign that budget is moving.", "default": true }, "renderJavaScript": { "title": "Run the page like a browser", "type": "boolean", "description": "On, each page is rendered and every network request it makes is inspected, which catches the tools a tag manager injects at runtime. Off is faster but only sees the raw HTML.", "default": true }, "requireEmail": { "title": "Only keep companies with an email", "type": "boolean", "description": "Drops companies where no email address could be found.", "default": false }, "includeTechnologies": { "title": "Only keep companies using", "type": "array", "description": "Keep a company only when it runs these, for example Shopify or Klaviyo. Leave empty to keep every company.", "items": { "type": "string" } }, "matchMode": { "title": "Match mode", "enum": [ "any", "all" ], "type": "string", "description": "Whether the list above means any of them or all of them.", "default": "any" }, "excludeTechnologies": { "title": "Drop companies using", "type": "array", "description": "Drop companies already running a tool you compete with.", "items": { "type": "string" } }, "onlyMatching": { "title": "Return matching companies only", "type": "boolean", "description": "Off, every company is returned with a matchesFilter flag so you can see what was rejected and why.", "default": false }, "categories": { "title": "Report only these technology categories", "type": "array", "description": "Limit the technology report. Leave empty to report everything found.", "items": { "type": "string", "enum": [ "Ecommerce platform", "CMS", "Web framework", "Analytics", "Tag manager", "Marketing automation", "Email marketing", "Live chat", "Advertising", "Payments", "Ecommerce apps", "Reviews", "CDN", "Hosting", "Web server", "Consent management", "Security", "Monitoring", "Search", "Video", "Scheduling and forms", "A/B testing", "Fonts", "Authentication" ] } }, "minConfidence": { "title": "Minimum technology confidence", "enum": [ "medium", "high" ], "type": "string", "description": "High keeps only matches proven by a vendor script, a response header, a cookie or a generator tag.", "default": "medium" }, "maxPagesPerSite": { "title": "Pages to read per company", "minimum": 1, "maximum": 8, "type": "integer", "description": "The homepage is always read. The rest is split between contact pages, which carry the emails, and product or pricing pages, which reveal more of the stack.", "default": 3 }, "maxRequestsPerCrawl": { "title": "Max requests total", "minimum": 1, "type": "integer", "description": "Hard cap on requests across the run, for cost control. Leave empty for no cap." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional proxy for larger runs or sites that rate limit by IP." } } }, "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 } } } } } } } } } }