Reports

Get Search Console country or device breakdown

Returns Search Console rows grouped by country or device for a mapped site.

get/api/sites/{id}/search-console/breakdowns

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/search-console/breakdowns
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Query parameters

fromstring date-time
tostring date-time
pagestring

Exact Search Console page URL filter.

pathstring

HitKeep path filter matched against Search Console page URLs.

countrystring

Search Console country code filter.

devicestring

Search Console device filter.

limitinteger

Maximum rows for table endpoints. Between 1 and 100.

dimension'country' | 'device' required

Breakdown dimension.

Response

Search Console report

data_source'google_search_console' required
dimension'query' | 'page' | 'country' | 'device' required

Changes

No recorded changes to this operation across all 1 revision of this API.