{ "openapi": "3.0.1", "info": { "title": "Company Change Monitor (Weekly Signals for Company Lists)", "description": "Weekly change alerts for company lists. Watch competitors, prospects or a portfolio and see what changed at each company (jobs, tech, reviews, ads, pricing), with the reason. Unchanged rows can be free. $6 per 1,000 at basic depth, $25 full.", "version": "0.1", "x-build-id": "CcEFQG62tqKcplqWK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/locaihost~company-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-locaihost-company-change-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/locaihost~company-change-monitor/runs": { "post": { "operationId": "runs-sync-locaihost-company-change-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/locaihost~company-change-monitor/run-sync": { "post": { "operationId": "run-sync-locaihost-company-change-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": { "companies": { "title": "Companies", "type": "array", "description": "The companies to watch: a website domain (\"stripe.com\"), a website address, or a company name (\"Monzo\"). Keep the same list on every run: each company is compared with its own last snapshot. For several companies with the same name, add the country: {\"name\": \"Sage\", \"country\": \"GB\"}." }, "watchName": { "title": "Watch list name", "type": "string", "description": "Keeps separate lists apart in your account: \"competitors\" and \"prospects\" each remember their own companies. Use the same name on every run of a list. Leave empty for one default list.", "default": "" }, "onlyChanged": { "title": "Charge only changed companies", "type": "boolean", "description": "Companies with no change since the last run get a short free row (who, unchanged, since when) instead of a full charged one. First runs and changed companies are full rows. Turn it on for weekly schedules.", "default": false }, "companiesFile": { "title": "Or a CSV file / Google Sheet", "type": "string", "description": "A public CSV link, a Google Sheet shared as \"anyone with the link\", or the key of a CSV in this run's key-value store. Columns are found by their header: domain (or website, url), company (or name) and country. Its companies are added to the list above." }, "depth": { "title": "Depth", "enum": [ "basic", "full" ], "type": "string", "description": "Basic reads the sources a plain web request can reach (about 10 seconds a company). Full adds website traffic estimates, the LinkedIn company page (employee band, industry), Google Maps (rating, locations), Meta and LinkedIn ad counts and the competitors section (up to 30 seconds a company). Basic checks cost $6 per 1,000; a check is charged the full price ($25 per 1,000) only when a full-depth source returned data. G2 and Capterra are not read in this version.", "default": "full" }, "sources": { "title": "Only these sources", "type": "array", "description": "Leave empty for all. Basic: site, dns, jobs, visa, trustpilot, sitejabber, googleAds, youtube, instagram, apps, sec, formD, registry, ukContracts. Full depth: traffic, linkedin, metaAds, linkedinAds, maps. Section keys (see Sections) work here too. Sources another one needs are added automatically (jobs needs site).", "default": [], "items": { "type": "string" } }, "icp": { "title": "Ideal customer profile (for icpScore)", "type": "object", "description": "Optional. Scores every company 0 to 100 against who you sell to, with the reasons. Fields: industries, countries (ISO codes), employeesMin, employeesMax, requiredTech, forbiddenTech, minMonthlyVisits. Unknown facts count half, a ruled-out technology scores 0." }, "maxCompanies": { "title": "Max companies", "minimum": 0, "type": "integer", "description": "Stop after this many companies (0 = all, up to 5,000 per run). Companies past the limit keep their last snapshot.", "default": 0 }, "concurrency": { "title": "Companies at a time", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many companies are read at the same time (1 to 16). Lower it if you run on less memory.", "default": 6 }, "mode": { "title": "Mode", "type": "string", "description": "Monitor compares each company with its last snapshot. Enrich gives plain rows with no comparison. Always \"monitor\" in this Actor.", "default": "monitor" }, "includePeople": { "title": "Decision-makers (people)", "type": "boolean", "description": "Not used by the monitor: people come from the Company Enrichment Actor. Always off here.", "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 }, "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 } } } } } } } } } }