Skip to content
digizeDocs

Search performance

GET
/api/v1/search-console/performance
curl --request GET \
  --url https://digize.com/api/v1/search-console/performance \
  --header 'x-api-key: <x-api-key>'

How the sites showed on Google: each site’s clicks, impressions and position by day for up to 180 days, its devices and countries, and the top searches and pages over 28 days.

Needs the analytics:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
property
required
string | null
status
required
object
property
required
string | null
syncing
required
boolean
syncedAt
required
Any of:
string format: date-time
error
required
string | null
lastDate
required
string | null
stale
required

The numbers are old enough that a page should start a sync.

boolean
sites
required
Array<object>
object
host
required
string
days
required
Array<object>
object
date
required
string format: date-time
clicks
required
number
impressions
required
number
position
required
number
devices
required
Array<object>
object
label
required
string
share
required
number
countries
required
Array<object>
object
label
required
string
share
required
number
queries
required
Array<object>
object
host
required
string
path
required
string
url
required
string
clickShare
required

Its part of its site’s clicks over 28 days.

number
impressionShare
required
number
previousClickShare
required
number
position
required
number
previousPosition
required
number
query
required
string
pages
required
Array<object>
object
host
required
string
path
required
string
url
required
string
clickShare
required

Its part of its site’s clicks over 28 days.

number
impressionShare
required
number
previousClickShare
required
number
position
required
number
previousPosition
required
number
title
required
string

Example generated

{
  "property": "example",
  "status": {
    "property": "example",
    "syncing": true,
    "syncedAt": "2026-04-15T12:00:00Z",
    "error": "example",
    "lastDate": "example",
    "stale": true
  },
  "sites": [
    {
      "host": "example",
      "days": [
        {
          "date": "2026-04-15T12:00:00Z",
          "clicks": 1,
          "impressions": 1,
          "position": 1
        }
      ],
      "devices": [
        {
          "label": "example",
          "share": 1
        }
      ],
      "countries": [
        {
          "label": "example",
          "share": 1
        }
      ]
    }
  ],
  "queries": [
    {
      "host": "example",
      "path": "example",
      "url": "example",
      "clickShare": 1,
      "impressionShare": 1,
      "previousClickShare": 1,
      "position": 1,
      "previousPosition": 1,
      "query": "example"
    }
  ],
  "pages": [
    {
      "host": "example",
      "path": "example",
      "url": "example",
      "clickShare": 1,
      "impressionShare": 1,
      "previousClickShare": 1,
      "position": 1,
      "previousPosition": 1,
      "title": "example"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}