Skip to content
Overwatch API

Get the Search performance payload

GET
/v1/sites/{id}/search-console
curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/search-console \
  --header 'x-api-key: <x-api-key>'

28-day totals + daily trend from the synced Search Analytics data, top pages (joined with live SEO issue counts and index verdicts), top queries, and index-coverage rollups from the URL Inspection sweep. Search data lags roughly two days and syncs daily.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string format: uuid

The site’s UUID.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The Search performance payload.

Media typeapplication/json
object
connection
required

A site’s Search Console connection, projected for display. The OAuth refresh token is sealed at rest and never appears in any response.

object
configured
required

Whether the server has a Google OAuth client configured.

boolean
status
required
string | null
Allowed values: pending-property connected error revoked
googleEmail
required
string | null
property
required
string | null
analyticsSyncedAt
required

Epoch ms of the last analytics sweep, or null.

integer | null
error
required
string | null
insights
required

Computed findings over the search data - striking-distance queries, low-CTR pages, orphan winners, host/protocol splits - each with its evidence items.

Array<object>
object
kind
required
string
Allowed values: striking-distance low-ctr orphan-pages host-split
tone
required
string
Allowed values: tip warning
title
required
string
text
required
string
items
required
Array<object>
object
label
required
string
detail
required
string
totals
required
object
clicks
required
integer
impressions
required
integer
ctr
required
number
position
required
number | null
trend
required

Daily totals, ascending by date.

Array<object>
object
date
required
string
clicks
required
integer
impressions
required
integer
ctr
required
number
position
required
number
topPages
required
Array<object>
object
url
required
string format: uri
gscUrl
required
string
clicks
required
integer
impressions
required
integer
ctr
required
number
position
required
number
issues
required

Live SEO issue count on the page.

integer
indexVerdict
required
string | null
coverageState
required
string | null
topQueries
required
Array<object>
object
query
required
string
clicks
required
integer
impressions
required
integer
ctr
required
number
position
required
number
coverage
required
object
inspected
required
integer
uninspected
required
integer
notIndexed
required
integer
byState
required
object
key
additional properties
integer
notIndexedExamples
required
Array<object>
object
url
required
string format: uri
verdict
required
string | null
coverageState
required
string | null
googleCanonical
required
string | null
Example
{
  "connection": {
    "status": "pending-property"
  },
  "insights": [
    {
      "kind": "striking-distance",
      "tone": "tip"
    }
  ]
}

401

Section titled “ 401 ”

Missing or invalid credentials.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
  "error": "invalid api key"
}

404

Section titled “ 404 ”

Site not found, SEO app off, or Search Console not connected.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Examplegenerated
{
  "error": "example"
}