{ "openapi": "3.0.1", "info": { "title": "Website Traffic Checker (Visits, Sources & Chatbot Referrals)", "description": "Get monthly visits, ranks, bounce rate, traffic sources, top countries and ChatGPT, Claude and Gemini referral shares for up to 5,000 domains (Similarweb public estimates). Competitor watch flags what changed since last run. Adds email provider, SPF, DMARC, tech stack. No login. $0.70/1,000.", "version": "0.1", "x-build-id": "jRvgD3Ben5ZgGm01c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/locaihost~website-traffic/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-locaihost-website-traffic", "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~website-traffic/runs": { "post": { "operationId": "runs-sync-locaihost-website-traffic", "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~website-traffic/run-sync": { "post": { "operationId": "run-sync-locaihost-website-traffic", "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": [ "domains" ], "properties": { "domains": { "title": "Domains or website URLs", "type": "array", "description": "One per line, up to 5,000. Bare domains (airtable.com), URLs (https://www.shopify.com/pricing) or email addresses (info@acme.com) all work: each is reduced to its main domain and duplicates are merged.", "items": { "type": "string" } }, "includeWebsiteChecks": { "title": "Add website and email set-up columns", "type": "boolean", "description": "Also check each domain's email provider, SPF and DMARC, DNS host, hosting and CDN, tech stack (CMS, shop, analytics, chat), SSL expiry and registrar. Same price. Turn off for traffic columns only, which is faster.", "default": true }, "onlyNew": { "title": "Only domains not delivered this month", "type": "boolean", "description": "For schedules: skip a domain if an earlier run already delivered its estimate for the current month (SimilarWeb publishes one new month at a time). Skipped domains are not charged. The memory is shared by every run of this Actor on your account.", "default": false }, "compareWithPrevious": { "title": "Compare with last run (competitor watch)", "type": "boolean", "description": "Remember each domain's visits, rank and AI chatbot shares, and add change columns (visitsChangePct, aiShareChange, chatbotShareChanges, globalRankChange, changed) against the last run of this watch list. Domains seen for the first time get empty change columns. The memory stays in your own Apify account.", "default": false }, "watchName": { "title": "Watch list name", "type": "string", "description": "Keeps separate memories for separate lists on one account, for example \"competitors\" and \"suppliers\". Leave as default for one list.", "default": "default" }, "onlyChanged": { "title": "Only return domains that changed", "type": "boolean", "description": "Return and charge only rows where SimilarWeb published a newer month or a number moved past the thresholds below. Unchanged domains and domains seen for the first time are remembered but not returned or charged. Switches the comparison on.", "default": false }, "minVisitsChangePct": { "title": "Visits change that counts (%)", "minimum": 0, "type": "integer", "description": "Within the same month, visits must move by at least this many percent to count as changed. A newer month always counts.", "default": 10 }, "minAiShareChangePts": { "title": "AI share change that counts (points)", "minimum": 0, "type": "number", "description": "Within the same month, the AI chatbot share of visits, or one chatbot's share of the AI referrals, must move by at least this many percentage points.", "default": 1 }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many domains. 0 = no limit.", "default": 0 } } }, "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 } } } } } } } } } }