Get Search Console overview

GET

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

curl --request GET \
  --url 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/search-console/overview?limit=10' \
  --cookie hk_token=<hk_token>

Returns aggregate Google Search Console clicks, impressions, CTR, and average position for a mapped site.

Authorizations

• cookieAuth
• bearerAuth
• 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.

Responses

200

Search Console report

Media type application/json

object

average_position

required

number

clicks

required

integer

ctr

required

number

data_source

required

string

Allowed value: google_search_console

impressions

required

integer

Example

{
  "data_source": "google_search_console"
}

400

Invalid request

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

401

Unauthorized

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

403

Access denied

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

412

Search Console property is not mapped

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

429

Too many requests

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}

503

Service not available

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}