{ "openapi": "3.0.1", "info": { "title": "Ahrefs Traffic Checker & API: Bulk Website & Page Traffic", "description": "Check Ahrefs organic traffic for many websites, folders or single pages: traffic value, top pages, top countries, top keywords and history, by country. Adds DR and competitors for domains and tracks traffic changes between runs. Works on the free Apify plan.", "version": "0.1", "x-build-id": "qlXXvNQ6ojyASXLdG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~ahrefs-traffic-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-ahrefs-traffic-checker", "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/s_actors~ahrefs-traffic-checker/runs": { "post": { "operationId": "runs-sync-s_actors-ahrefs-traffic-checker", "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/s_actors~ahrefs-traffic-checker/run-sync": { "post": { "operationId": "run-sync-s_actors-ahrefs-traffic-checker", "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": { "targets": { "title": "🌐 Websites, folders or pages", "type": "array", "description": "One domain or URL per line. With \"Target mode: auto\" a domain or homepage is checked as the whole website, a URL with a path as that exact page. Duplicates are checked once. Up to 5,000 per run.", "items": { "type": "string" } }, "mode": { "title": "🎯 Target mode", "enum": [ "auto", "subdomains", "domain", "prefix", "exact" ], "type": "string", "description": "What Ahrefs counts for each line, like the mode switch in Ahrefs Site Explorer. \"URL prefix\" gives the traffic of a whole folder or section, \"Exact URL\" of one page.", "default": "auto" }, "country": { "title": "🌍 Country of top pages and keywords", "enum": [ "all", "al", "dz", "as", "ad", "ao", "ai", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bd", "be", "bz", "bj", "bt", "bo", "ba", "bw", "br", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "cf", "td", "cl", "co", "cg", "ck", "cr", "ci", "hr", "cy", "cz", "cd", "dk", "dj", "dm", "do", "ec", "eg", "sv", "ee", "et", "fj", "fi", "fr", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gp", "gt", "gg", "gy", "ht", "hn", "hk", "hu", "is", "in", "id", "ie", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kw", "kg", "la", "lv", "lb", "ls", "ly", "li", "lt", "lu", "mg", "mw", "my", "mv", "ml", "mt", "mu", "mx", "fm", "md", "mn", "me", "ms", "ma", "mz", "na", "nr", "np", "nl", "nz", "ni", "ne", "ng", "nu", "mk", "no", "om", "pk", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "ro", "rw", "sh", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "za", "kr", "es", "lk", "sr", "se", "ch", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "ug", "ua", "ae", "gb", "us", "uy", "uz", "vu", "vn", "vg", "vi", "zm", "zw" ], "type": "string", "description": "Top pages and top keywords from Google in this country (their traffic is the traffic from that country). Total traffic, history and the country split stay worldwide.", "default": "all" }, "liveCheck": { "title": "⚡ Live check on Ahrefs", "enum": [ "always", "missing" ], "type": "string", "description": "Every target is checked live in Ahrefs' own free Traffic Checker (the \"Live check\" charge). With \"Only for websites missing from the free index\", popular whole websites come from the Ahrefs Top index instead: traffic, value, countries, keywords and history without top pages, and no \"Live check\" charge. Folders and pages are always checked live.", "default": "always" }, "includeIndexData": { "title": "📊 Add DR, competitors and 12-month history for websites", "type": "boolean", "description": "Whole websites found in the Ahrefs Top index also get Domain Rating, keyword count, traffic rank, exact traffic per country, top competing websites and 12 months of traffic and traffic value. No extra charge.", "default": true }, "trackChanges": { "title": "🔔 Track changes between runs", "type": "boolean", "description": "Remember each target's traffic, top pages and top keywords and add the change since the previous run with the same tracker name, plus new top pages and keywords. Schedule the Actor weekly or monthly to watch your sites, competitors or content.", "default": false }, "onlyChanged": { "title": "Return only changed targets", "type": "boolean", "description": "With tracking on: return (and pay the target charge for) only targets whose traffic, top pages or top keywords changed since the previous run, plus new targets.", "default": false }, "monitorName": { "title": "Tracker name", "type": "string", "description": "Separate trackers for separate lists, e.g. \"my-sites\" and \"competitors\".", "default": "default" }, "includeHistory": { "title": "🗓️ Include monthly history", "type": "boolean", "description": "Monthly organic traffic for the last 6 months (live check) and 12 months with traffic value (index, whole websites).", "default": true }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Log every request retry.", "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 } } } } } } } } } }