OpenAPI 3.0.02026-08-195190397.1 KB

0ca29c993972

Rank Tracking

List tracked keywords

Returns the list of tracked keywords for a team.

get/v3/rank-tracking/keywords

Query parameters

teamIdstring

Team ID

startDatestring

Start date (YYYY-MM-DD, UTC) for GSC position summary window.

endDatestring

End date (YYYY-MM-DD, UTC) for GSC position summary window.

daysinteger

Days to look back for GSC position summary (legacy fallback).

includeInactiveboolean

When true, also returns soft-untracked (active=false) keywords so the UI can offer re-tracking. Defaults to false (active only).

fields'minimal' | 'summary'

Set to 'minimal' for a trimmed payload (keyword text + targeting + tracked flags only, no positionHistory/resultHistory). Intended for callers that only check whether a keyword is tracked. Set to 'summary' for everything except resultHistory - keeps positionHistory, so callers that plot a rank trend but never open a SERP snapshot skip the largest part of the payload. Omit for the full response.

Response

Default Response