Query search analytics

The host, as returned by List properties, or a bare host or URL such as example.com, which is matched to a verified host (https first, www ignored). A host with no match returns 404 yandex_site_not_found with valid_properties. Missing returns 400 missing_site.

First day, YYYY-MM-DD. Missing returns 400 missing_dates; any other format returns 400 invalid_date. The same applies to endDate, which must not be before startDate.

Last day, YYYY-MM-DD.

query (popular queries) or date (a daily trend). Anything else returns 400 invalid_dimension; page is not available because Yandex has no page dimension.

date returns one row per day, chronological, for the whole host, or for one query when you send filterQuery. Rows carry clicks, impressions, ctr and, when Yandex sends them, position. The query must be one of the host's popular queries for the date range, otherwise the call returns 404 yandex_query_not_found. A trend takes no compareTo (read two date ranges instead) and no filterQueryContains. The default rowLimit is 500.

Only traffic from this device type: desktop, mobile or tablet. Anything else returns 400 invalid_device.

Keep rows whose query equals this, ignoring letter case. Cannot be combined with filterQueryContains.

Keep rows whose query contains this text, ignoring letter case.

Keep rows with at least this many impressions. With compareTo, a row passes when either period meets it, so a page that lost everything still shows.

Keep rows with at least this many clicks (same rule with compareTo).

Keep rows with an average position at or above this number. Excludes rows with no position.

Keep rows with an average position at or below this number.

Keep rows with a CTR at or below this, as a fraction from 0 to 1.

previous_period also reads the period of the same length that ends the day before startDate and adds previous, delta and status to every row. Every delta reads positive is better: clicks, impressions and ctr are current minus previous, and position is previous minus current, so a positive position means the row moved up. status is both, new (only in the current period) or lost (only in the previous one). Anything else returns 400 invalid_compare_to.

clicks, impressions, ctr or position; with compareTo also clicks_delta, impressions_delta, ctr_delta or position_delta. The default order is clicks, then impressions. Anything else returns 400 invalid_sort.

asc or desc. The default is largest first, except position, where the best (lowest) comes first. For the biggest losers use sort=clicks_delta&order=asc.

Comma-separated subset of keys, clicks, impressions, ctr, position, previous, delta and status. Keeps a large response small. An unknown name returns 400 invalid_fields.

Offset into the sorted rows, to read past the first page. Use next_start_row from a response that says has_more.

Rows to return, at most 1000.

bing or yandex.

The website that was read.

Present only when your site was matched to a different website (for example a bare host); site then holds the one used.

Result rows.

Rows in this response.

Rows that passed every filter, before rowLimit and startRow.

true when more matching rows follow this page.

Present when has_more is true: pass it as startRow for the next page.

What this data does and does not cover.

Echoed when you sent device.

With compareTo: true when either period had more than the 1000 queries one read covers, so a row marked new or lost may only be outside the rows read.