---
title: "Get Search Console country or device breakdown REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Get Search Console country or device breakdown, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apisitesidsearch-consolebreakdowns/"
---

# Get Search Console country or device breakdown REST API

GET

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

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/search-console/breakdowns?limit=10&dimension=country';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/search-console/breakdowns?limit=10&dimension=country' \
  --cookie hk_token=<hk_token>
```

-

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

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**
- **[bearerAuth](https://hitkeep.com/api/#bearerauth)**
- **[apiKeyAuth](https://hitkeep.com/api/#apikeyauth)**

## Parameters

### Path Parameters

**id**

required

string format: uuid

### Query Parameters

**from**

string format: date-time

**to**

string format: date-time

**page**

string

Exact Search Console page URL filter.

**path**

string

HitKeep path filter matched against Search Console page URLs.

**country**

string

Search Console country code filter.

**device**

string

Search Console device filter.

**limit**

integer

default: 10 >= 1 <= 100

Maximum rows for table endpoints. Between 1 and 100.

**dimension**

required

string

Allowed values: country device

Breakdown dimension.

## Responses

### 200

Search Console report

application/json

object

**data_source**

required

string

Allowed value: google_search_console

**dimension**

required

string

Allowed values: query page country device

**rows**

required

Array<object>

object

**average_position**

required

number

**clicks**

required

integer

**ctr**

required

number

**impressions**

required

integer

**value**

required

string

##### Example

```
{
  "data_source": "google_search_console",
  "dimension": "query"
}
```

### 400

Invalid request

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 401

Unauthorized

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 403

Access denied

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 412

Search Console property is not mapped

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 429

Too many requests

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 503

Service not available

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

[Previous Test report delivery](https://hitkeep.com/api/operations/apireportsreport_idtest-send/)[Next Get Search Console overview](https://hitkeep.com/api/operations/apisitesidsearch-consoleoverview/)