{ "openapi": "3.0.1", "info": { "title": "Website Traffic Estimator: Similarweb Visits & Rank", "description": "Check monthly visits, global rank, traffic sources, top countries and keywords for a list of websites from public Similarweb estimates. Compare competitors, score leads and monitor traffic changes. No login or API key.", "version": "0.2", "x-build-id": "DXZlmdJklMShJt2ox" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cliqtomedia~website-traffic-estimator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cliqtomedia-website-traffic-estimator", "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/cliqtomedia~website-traffic-estimator/runs": { "post": { "operationId": "runs-sync-cliqtomedia-website-traffic-estimator", "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/cliqtomedia~website-traffic-estimator/run-sync": { "post": { "operationId": "run-sync-cliqtomedia-website-traffic-estimator", "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": { "domains": { "title": "Websites", "minItems": 1, "type": "array", "description": "Add domains or full URLs. Duplicate entries and www are removed. Other subdomains stay separate. Broken entries are skipped and counted in RUN_SUMMARY. The run checks as many domains as its timeout and charge limit allow.", "items": { "type": "string" } }, "domainsText": { "title": "Paste a list", "type": "string", "description": "Add domains or URLs separated by commas, spaces or new lines. These are added to Websites." }, "mode": { "title": "Run mode", "enum": [ "lookup", "monitor" ], "type": "string", "description": "Choose lookup for one report. Choose monitor to compare this run with your saved state.", "default": "lookup" }, "stateName": { "title": "Monitor store name", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", "type": "string", "description": "Required in monitor mode. Use your own store name, 3–63 letters, digits or hyphens. Reuse it for the same list and options." }, "includeSources": { "title": "Traffic sources", "type": "boolean", "description": "Include the available channel shares. Shares are fractions from 0 to 1. Hidden shares stay null.", "default": true }, "includeCountries": { "title": "Top countries", "type": "boolean", "description": "Include countries and their available traffic shares.", "default": true }, "includeDetails": { "title": "More public data", "type": "boolean", "description": "Include public company data, audience, similar sites, keywords, referrals, social networks, advertising, interests and rank history. Locked names are left out.", "default": true }, "onlyChanges": { "title": "Only changed profiles", "type": "boolean", "description": "In monitor mode, write only new or changed profiles. Every checked domain is charged, including unchanged domains.", "default": false }, "fallbackToOpenData": { "title": "Use fallback data", "type": "boolean", "description": "If Similarweb fails, try SimilarSites and Tranco. SimilarSites visits have no known month. Tranco is a separate popularity rank. Fallback rows are partial.", "default": false }, "outputFormat": { "title": "Row format", "enum": [ "full", "flat" ], "type": "string", "description": "Full keeps lists as JSON arrays. Flat writes lists as JSON text in columns ending in Json, for spreadsheets.", "default": "full" }, "minMonthlyVisits": { "title": "Minimum monthly visits", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Write successful profiles only when visits meet this minimum. 0 means no filter. All checked domains are charged.", "default": 0 }, "maxGlobalRank": { "title": "Largest global rank number", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Keep ranks at or above this position: 100 means ranks 1–100. 0 means no filter. All checked domains are charged.", "default": 0 }, "countries": { "title": "Main audience countries", "type": "array", "description": "Keep profiles whose main audience country is in this list. Use uppercase two-letter codes such as US or GB. Empty means no country filter.", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "default": [] }, "categoryFilter": { "title": "Category contains", "maxLength": 120, "type": "string", "description": "Keep profiles whose category contains this text. Empty means no category filter. All checked domains are charged.", "default": "" }, "includeAiTraffic": { "title": "AI referral report", "type": "boolean", "description": "Optional AI chatbot referrals, history and prompts. Off by default. Enabling this adds one AI check charge per checked domain, including unavailable reports.", "default": false }, "proxyMode": { "title": "Connection route", "enum": [ "auto", "direct", "datacenter", "residential" ], "type": "string", "description": "Auto tries direct, datacenter and residential routes in that order and stops at the first one that works. Choose one route to use only that route.", "default": "auto" }, "maxConcurrency": { "title": "Parallel domain checks", "minimum": 1, "maximum": 15, "type": "integer", "description": "Check 1–15 domains at once. Lower this if the source asks you to slow down.", "default": 4 }, "websites": { "title": "Additional websites", "type": "array", "description": "Alternative website list for API integrations. Added to Websites.", "items": { "type": "string" } }, "deliveryConnector": { "title": "Send results to (optional)", "type": "string", "description": "Your Slack, Notion or other MCP connector. After the run the Actor posts a short summary there. Connect services once in Apify Console → MCP connectors." }, "deliveryTarget": { "title": "Notion page or channel (optional)", "type": "string", "description": "Where to post the summary: a Notion page link (each run is added on top of that page) or a Slack channel ID. Leave empty to let the connector decide." } } }, "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 } } } } } } } } } }