{ "openapi": "3.0.1", "info": { "title": "Backlink Checker API - Backlinks & Competitor Gap", "description": "Check any domain's backlinks from $0.015 — rank, backlinks, referring domains, spam score, broken links — up to 100 domains per run. Plus ranked referring-domain lists, a competitor backlink gap, and new/lost monitoring that only charges when something changed. Native index data, not a UI scraper.", "version": "0.0", "x-build-id": "NPbTiqkzTb0qEf1bS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/doesaiknow~backlink-checker-api-referring-domains-competitor-gap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-doesaiknow-backlink-checker-api-referring-domains-competitor-gap", "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/doesaiknow~backlink-checker-api-referring-domains-competitor-gap/runs": { "post": { "operationId": "runs-sync-doesaiknow-backlink-checker-api-referring-domains-competitor-gap", "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/doesaiknow~backlink-checker-api-referring-domains-competitor-gap/run-sync": { "post": { "operationId": "run-sync-doesaiknow-backlink-checker-api-referring-domains-competitor-gap", "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": "Target domains", "minItems": 1, "maxItems": 100, "type": "array", "description": "One or more target domains to analyze (e.g. monday.com). Each is normalized (scheme/path/`www.` stripped, lowercased) and deduplicated before any upstream API call (identical tasks are not refundable per upstream API ToS). One dataset row is produced per unique domain (in `monitor` mode, one row per link gained or lost). FREE PLAN: 3 domains in `check` mode, or 1 domain in `summary` mode — extra domains are trimmed and the run explains why. Paid plans: up to 100 domains, all modes.", "items": { "type": "string", "minLength": 1, "maxLength": 253 } }, "mode": { "title": "Mode", "enum": [ "summary", "check", "referring_domains", "competitor_gap", "monitor" ], "type": "string", "description": "What to return per domain. 'check' = cheapest lookup ($0.015/domain), bulk-check up to 100 domains — rank, backlinks, referring domains, spam score, broken links. 'summary' = full backlink profile for one domain (the default). 'referring_domains' = ranked list of referring domains. 'competitor_gap' = domains linking to your competitors but NOT to your target (requires the Competitors field). 'monitor' = new & lost referring domains since your last run — you're only charged on runs that actually find changes. FREE PLAN: 'check' allows 3 domains; every other mode is clamped to 1 domain in 'summary'.", "default": "summary" }, "monitorLabel": { "title": "Monitor label (monitor mode only)", "maxLength": 100, "type": "string", "description": "Optional name for this watchlist in 'monitor' mode, e.g. \"client-acme\" or \"my-sites\". The label is how the Actor remembers where it left off, so each label keeps its own independent history — use different labels to track the same domain in separate watchlists (say, a weekly and a monthly report). Leave empty and a label is derived from the set of domains you submitted, so re-running the same list automatically continues it. Ignored in other modes." }, "competitors": { "title": "Competitors (gap mode only)", "minItems": 0, "maxItems": 10, "type": "array", "description": "Rival domains for `competitor_gap` mode. The actor returns referring domains that link to these competitors but NOT to your target — your backlink prospecting list. Ignored in other modes. Normalized + deduplicated like `domains`.", "items": { "type": "string", "minLength": 1, "maxLength": 253 } }, "limit": { "title": "Row limit (list modes)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows returned for `referring_domains`, `competitor_gap`, and `monitor` modes. In `monitor` the cap applies per direction, so a domain that both gained and lost links can return up to 2× this many rows. Ignored by `summary` and `check`. Flat pricing — a higher limit returns more rows at the same price. 1–1000.", "default": 100 }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "Treat the target as a whole domain including its subdomains (e.g. blog.monday.com counts toward monday.com). Passed through to the upstream API. Default true.", "default": true } } }, "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 } } }, "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 } } } } } } } } } }