ScrepyDocs

Create a segment

Create a segment

POST/projects/{project_uid}/rank-tracker/segments

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}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/projects/string/rank-tracker/segments" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "rules": [      {        "field": "path",        "operator": "starts_with",        "value": "string"      }    ]  }'
{  "data": {    "id": 0,    "name": "string",    "rules": [      {        "field": "path",        "operator": "starts_with",        "value": "string"      }    ],    "matched_count": 0,    "avg_position": 0  }}