{ "openapi": "3.0.1", "info": { "title": "Backlink Checker & Monitor", "description": "Backlink checker with an API for any website worldwide: backlinks, referring domains and anchor texts of a domain or page, with the rank of each linking page and domain, dofollow status and first and last seen dates. Monitor mode reports new and lost backlinks between runs.", "version": "0.1", "x-build-id": "uFYZwOVtwnqQJAgbt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datapulsehq~backlink-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datapulsehq-backlink-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/datapulsehq~backlink-checker/runs": { "post": { "operationId": "runs-sync-datapulsehq-backlink-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/datapulsehq~backlink-checker/run-sync": { "post": { "operationId": "run-sync-datapulsehq-backlink-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": "Targets", "type": "array", "description": "Domains, subdomains or page URLs, up to 100. A value with a path (https://example.com/blog/post) is checked as that page only. Without this field the Actor runs a small example.", "items": { "type": "string" } }, "maxBacklinks": { "title": "Maximum backlinks per target", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Backlinks with the highest link score come first. 0 skips the list. Up to 10,000. Users on the Apify free plan get at most 20 rows per run in total.", "default": 100 }, "maxReferringDomains": { "title": "Maximum referring domains per target", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Referring domains with the highest domain rank come first. 0 skips the list. Up to 10,000.", "default": 0 }, "maxAnchors": { "title": "Maximum anchors per target", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Anchor texts with the most backlinks come first. 0 skips the list. Up to 1,000.", "default": 0 }, "backlinkMode": { "title": "Backlink grouping", "enum": [ "as_is", "one_per_domain", "one_per_anchor" ], "type": "string", "description": "How the backlinks list is grouped.", "default": "as_is" }, "dofollowOnly": { "title": "Dofollow backlinks only", "type": "boolean", "description": "Return only backlinks without a nofollow attribute. Applies to the backlinks list.", "default": false }, "includeSubdomains": { "title": "Include subdomains", "type": "boolean", "description": "For a domain target, also count links to its subdomains.", "default": true }, "monitor": { "title": "Monitor mode", "type": "boolean", "description": "Compare the backlinks and referring domains lists with the previous monitor run for the same target and settings, and output only new and lost links. The first run saves the baseline and outputs the full lists.", "default": false }, "useCache": { "title": "Use cached results", "type": "boolean", "description": "Reuse results for the same target and settings from earlier runs. Ignored in monitor mode.", "default": true }, "cacheTtlDays": { "title": "Cache age limit (days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum age of cached results.", "default": 7 }, "pushSummaryToDataset": { "title": "Add run summary to the dataset", "type": "boolean", "description": "Append the run summary as the last dataset row. It is always saved as SUMMARY in the key-value store.", "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 } } } } } } } } } }