{ "openapi": "3.0.1", "info": { "title": "Website Traffic Database — Bulk Lookup API", "description": "Look up indexed website traffic and ranking records or discover sites by available source metrics. Bulk export: JSON, CSV, Excel and API. PPE: $5/1K website records; usage extra.", "version": "2.3", "x-build-id": "eNV8gikuURxHR3wc2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~website-traffic-database/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-website-traffic-database", "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/apivault_labs~website-traffic-database/runs": { "post": { "operationId": "runs-sync-apivault_labs-website-traffic-database", "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/apivault_labs~website-traffic-database/run-sync": { "post": { "operationId": "run-sync-apivault_labs-website-traffic-database", "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": { "workflow": { "title": "Workflow", "enum": [ "auto", "traffic", "globalRank", "domains", "similarSites" ], "type": "string", "description": "Choose one way to find websites. Auto-detect preserves existing integrations and uses this priority: domain lookup, similar sites, global rank, then traffic filters.", "default": "auto" }, "minVisits": { "title": "Minimum monthly visits", "minimum": 0, "type": "integer", "description": "Minimum visits in the latest tracked month. Zero is accepted. Ignored in rank, domain and similar-site workflows.", "default": 1000 }, "maxVisits": { "title": "Maximum monthly visits", "type": "integer", "description": "Return sites with at most this many visits in the most recent month. Leave empty for no upper limit." }, "topGlobalRank": { "title": "Top sites worldwide (enter N, e.g. 100)", "minimum": 1, "type": "integer", "description": "Stored global ranks 1–N, sorted ascending. Ignores optional refine filters; maxResults still caps delivery. Missing ranks and ties can mean fewer or more candidates than N." }, "category": { "title": "Category contains", "type": "string", "description": "Literal case-insensitive category substring. Available only where a category is stored; applied in traffic workflow." }, "country": { "title": "Top country (code)", "type": "string", "description": "Two-letter code for the stored top visitor country, not company location or all traffic countries." }, "minSearchShare": { "title": "Minimum search-traffic share (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Keep only sites where organic search is at least this % of traffic (e.g. 50 = SEO-dependent sites). Leave empty to ignore." }, "hasAiTraffic": { "title": "Only sites with AI/LLM traffic", "type": "boolean", "description": "Keep only sites that get visits from AI assistants (ChatGPT, Perplexity, etc.).", "default": false }, "onlyGrowing": { "title": "Only growing sites", "type": "boolean", "description": "Require positive earliest-to-latest tracked-month growth before result limits. Unknown growth does not qualify.", "default": false }, "minGrowthPercent": { "title": "Minimum growth (%)", "type": "integer", "description": "Minimum percent change from earliest to latest tracked month; not necessarily month-over-month. Unknown or zero baseline does not qualify." }, "keyword": { "title": "Ranks for keyword", "type": "string", "description": "Literal case-insensitive substring of available top keyword names. This is a stored keyword sample, not a live SERP or exhaustive ranking index. Combine with traffic/category filters." }, "trafficSource": { "title": "Traffic channel", "enum": [ "search", "direct", "social", "referral", "mail", "ads", "ai" ], "type": "string", "description": "Which traffic channel to filter by (used together with 'Minimum channel share' below). E.g. pick 'social' + 40 to find sites where social is 40%+ of traffic.", "default": "search" }, "minSourceShare": { "title": "Minimum channel share (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Keep only sites where the chosen 'Traffic channel' is at least this % of total traffic (e.g. 40). Leave empty to ignore this filter." }, "maxBounce": { "title": "Maximum bounce rate (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Keep only sites with a bounce rate at or below this % (lower = more engaged visitors, e.g. 40). Leave empty to ignore." }, "minPagesPerVisit": { "title": "Minimum pages per visit", "minimum": 0, "type": "integer", "description": "Keep only sites where visitors view at least this many pages per visit (engagement, e.g. 3). Leave empty to ignore." }, "minTimeOnSite": { "title": "Minimum time on site (seconds)", "minimum": 0, "type": "integer", "description": "Keep only sites with an average visit duration of at least this many seconds (e.g. 120 = 2 min). Leave empty to ignore." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum delivered websites; default five for Console, API and MCP. Up to 50000 uses a bounded globally sorted selection. Larger limits use bulk segment-order export, not global top-N. Charge limits can stop delivery earlier.", "default": 5 }, "sortBy": { "title": "Sort by", "enum": [ "visits", "global_rank", "bounce", "pages", "time_on_site", "category_rank", "country_rank", "ai_visits" ], "type": "string", "description": "Which field to sort results by.", "default": "visits" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Highest first (descending) or lowest first (ascending).", "default": "desc" }, "outputPreset": { "title": "Output detail", "enum": [ "compact", "outreach", "full" ], "type": "string", "description": "Compact keeps core metrics, period and evidence. Outreach adds engagement and channel mix. Full includes the stored monthly series, top countries and top keywords. Default is outreach; unknown metrics remain null.", "default": "outreach" }, "domains": { "title": "Domains to look up", "type": "array", "description": "Public domains or HTTP(S) URLs. Normalize www/path, deduplicate. Credentials, ports, IPs and local hosts are rejected. Only tracked domains return rows. maxResults/offset/output/sort still apply; refine filters are ignored.", "items": { "type": "string" } }, "similarTo": { "title": "Find competitors of this domain", "type": "string", "description": "One tracked domain. Return stored category peers within 25%–400% of its latest monthly visits; not verified commercial competitors. Refine filters are ignored; seed is excluded. Requires stored category and positive visits." }, "offset": { "title": "Skip matching websites", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Bounded sorted selection only. Prefer SUMMARY.nextInput. Offset plus maxResults must not exceed 50000. Data can change between runs; no snapshot is retained.", "default": 0 }, "checkedWithinDays": { "title": "Record checked within days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Traffic workflow only. Require a non-future dataDate within this many days. Record check date is not the metric month. Leave empty to allow older stored estimates." } } }, "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 } } } } } } } } } }