Pages

List pages with their search performance

Returns every page in the team inventory merged with its Search Console clicks, impressions, CTR, average position and keyword count for the selected window. Pages with no search traffic are included so they stay findable.

get/v3/pages/list

Query parameters

teamIdstring

Team ID

startDatestring

Start date (YYYY-MM-DD, UTC).

endDatestring

End date (YYYY-MM-DD, UTC).

daysinteger

Days to look back when startDate/endDate are omitted.

countrystring

ISO-3 country code to filter Search Console rows by.

devicestring

Device filter: desktop, mobile or tablet.

typestring

Search type: web, image, video or news.

searchstring

Filter to pages whose URL or title contains this text.

limitinteger

Rows to return (max 200).

offsetinteger

Rows to skip.

sortKey'clicks' | 'impressions' | 'ctr' | 'position' | 'keywords' | 'url' | 'auditScore' | 'aiCitations'

Column to sort on. Defaults to clicks.

sortDir'asc' | 'desc'

Sort direction. Defaults to desc.

Response

Default Response

totalinteger required
connectedboolean
startDatestring nullable
endDatestring nullable

Changes

Changed in 2 of the 47 revisions of this API.3

    • ○

      added the new enum value aiCitations to the query request parameter sortKey

      request-parameter-enum-value-added

    • ○

      added the new enum value auditScore to the query request parameter sortKey

      request-parameter-enum-value-added

    • ○

      endpoint added

      endpoint-added