List segments, suggestions, and unmatched count
List segments, suggestions, and unmatched count
GET
/projects/{project_uid}/rank-tracker/segmentsAuthorization
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}$Query Parameters
device?string
Default
"mobile"Value in
- "mobile"
- "desktop"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/projects/string/rank-tracker/segments"{ "data": { "segments": [ { "id": 0, "name": "string", "rules": [ { "field": "path", "operator": "starts_with", "value": "string" } ], "matched_count": 0, "avg_position": 0 } ], "suggestions": [ { "name": "string", "rules": [ { "field": "path", "operator": "starts_with", "value": "string" } ], "matched_count": 0, "avg_position": 0, "examples": [ "http://example.com" ] } ], "unmatched_count": 0 }}{ "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"}