Search Console

Search Console rows by several dimensions (Growth+)

Changed on

Google Search Console rows grouped by 1 to 3 dimensions (date, country, device, page, query, searchAppearance, property) over a date range, each row carrying its dimension values as fields plus impressions, clicks, ctr (0..1) and position, ranked by impressions, clicks, ctr or position, paginated. Google ranks rows by clicks and returns at most 25,000 per request (truncated: true when reached); start_row moves that window. Query rows exclude anonymized queries, so rows add up to less than the summary totals. Requires a connected Search Console property (Growth+) and live reads: stored reads return ERR_INVALID_PARAM. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access and ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. A combination Google refuses comes back as ERR_INVALID_PARAM with its reason.

get/search_console/rows

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • Auth
    API key in header Authorization

Query parameters

project_idinteger required

Project ID

dimensionsstring required

Comma-separated dimensions to group by, 1 to 3 of date, country, device, page, query, searchAppearance, property. Each becomes a field of every row; country and device values are lowercase. property is the Search Console property the row comes from (see the property parameter).

rangeinteger

Number of days to look back, today included (alternative to from/to). At most 487, Google's retention.

fromstring date

Start date (YYYY-MM-DD). Defaults to 30 days ago.

tostring date

End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.

sort'impressions' | 'clicks' | 'ctr' | 'position'
pageinteger
per_pageinteger
start_rowinteger

Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.

output'flat' | 'csv'

Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. 'flat' returns the same metadata plus 'columns' and 'rows'; 'csv' returns those rows as text/csv. Errors are always returned as JSON.

search_type'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'

Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.

filtersstring

Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{"dimension":"page","operator":"contains","expression":"/blog/"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.

data_state'final' | 'all'

final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.

aggregation_type'auto' | 'byPage' | 'byProperty'

How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.

propertystring

Which Search Console properties to read; /search_console/properties lists them. Omit it for the primary property, or pass one property id (e.g. sc-domain:example.com) to read that one; both answer with property. A comma-separated list of ids, or all, combines several and answers with properties, excluded_properties and property_errors instead: excluded_properties are left out because another selected property already counts them (a URL-prefix property under a domain property), so no click is counted twice; property_errors are properties Google refused, left out of the figures and also named in the X-Search-Console-Property-Errors header. When Google refuses every property, the request fails as a single-property read would.

Response

Search Console rows

project_idinteger
fromstring date
tostring date
data_throughstring date nullable

Latest date Google has published for the property, or for every combined property (it lags 2-3 days). Later days are missing, not zero.

pageinteger
per_pageinteger
totalinteger

Rows in this window (one Google request, at most 25,000)

sortstring
start_rowinteger

Present when start_row was set

truncatedboolean

Present (true) when Google returned 25,000 rows, so more rows exist past this window

dimensionsstring[]
request_idstring

Changes