ScrepyDocs

Eligible targets and supported input options

Eligible targets and supported input options. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

GET/projects/{project_uid}/backlinks/options

Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/backlinks/options"
{  "data": {    "targets": {      "project": {        "name": "string",        "domain": "string"      },      "competitors": [        {          "id": 0,          "name": "string",          "domain": "string"        }      ],      "usage": {        "used": 0,        "limit": 0,        "can_add": true      }    },    "sorting": {      "property1": {        "columns": [          "string"        ],        "default": "string"      },      "property2": {        "columns": [          "string"        ],        "default": "string"      }    },    "statuses": [      "live"    ],    "limit": {      "default": 50,      "maximum": 100    }  }}

Overview

Previous Page

Backlink profile summary, history, and top breakdowns

Backlink profile summary, history, and top breakdowns. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.