Preview segment rules without saving
Preview segment rules without saving
POST
/projects/{project_uid}/rank-tracker/segments/previewAuthorization
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/preview" \ -H "Content-Type: application/json" \ -d '{ "rules": [ { "field": "path", "operator": "starts_with", "value": "string" } ] }'{ "data": { "matched_count": 0, "avg_position": 0, "overlap_count": 0, "examples": [ "http://example.com" ] }}{ "message": "Unauthenticated."}{ "message": "string", "code": "string"}{ "message": "Project not found or not accessible."}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }}{ "message": "string", "code": "string"}{ "message": "string", "code": "string"}