SEO

Get the SEO overview

Google search performance from the brand's own Search Console property: clicks, impressions, average position, keywords in the top 10, pages with impressions, the site health score, and the daily trend.

GEThttps://api.vidrys.com/v1/projects/{project_id}/seo/overview

Plan: Track and above
Key: read
Rate cost: 1 unit
MCP tool: get_seo_overview

Search Console finalises each day about three days late, so the most recent days keep moving. The first sync fills in up to sixteen months of daily totals, so history starts before the day the property was connected.

curl --request GET \
  --url "https://api.vidrys.com/v1/projects/{project_id}/seo/overview" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "connected": true,
  "awaiting_data": false,
  "kpis": {
    "clicks": 1840,
    "impressions": 96200,
    "avg_position": 14.6,
    "keywords_in_top10": 23,
    "pages_with_impressions": 88,
    "site_health_score": 71.5,
    "site_health_delta": 4
  },
  "trend": [
    {
      "date": "2026-09-01",
      "clicks": 58,
      "impressions": 3100,
      "avg_position": 14.9
    },
    {
      "date": "2026-09-02",
      "clicks": 63,
      "impressions": 3320,
      "avg_position": 14.4
    }
  ]
}

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Path parameters

project_idstringrequired

The project's id, from List projects.

Query parameters

rangeenum<string>default 30d

How far back to measure, counted from the newest run.

Values:7d30d90d

Response · 200

application/json

connectedboolean

Whether Search Console is connected. False: every figure below is empty.

awaiting_databoolean

Connected, but nothing synced for the range yet — zeros here are an absence of data, not a site with no traffic.

kpisobject

The tiles on the SEO overview, over the range.

+Show child attributes

clicksinteger

Clicks from Google search.

impressionsinteger

Times the site appeared in results.

avg_positionnumbernullable

Mean of the daily average positions.

keywords_in_top10integer

Search Console queries ranking in the top 10 in the latest window.

pages_with_impressionsinteger

Pages Google showed at least once in the latest window.

site_health_scorenumbernullable

The latest site health score, 0–100.

site_health_deltanumbernullable

Change in the score since the previous audit, in points.

trendobject[]

One point per day in the range, oldest first.

+Show child attributes

datestring

Day, as YYYY-MM-DD.

clicksinteger

Clicks from Google search that day, from Search Console.

impressionsinteger

Times the site appeared in results that day.

avg_positionnumbernullable

Average position across the day's impressions. Null when Search Console reported none.

Errors

403 plan_feature_unavailable	The feature is on a higher plan. Bulk exports and webhooks are Custom-only.
404 not_found	The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
422 invalid_request	A parameter or body field is missing or has the wrong type or value. The message names the field. Also returned when a write would pass the plan's prompt limit.
401 unauthorized	No key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated.
402 plan_required	The workspace's plan doesn't include API access. It's included on every plan from Track up — Solo is the one without it.
403 workspace_not_approved	The workspace is still waiting for approval, or wasn't approved.
429 rate_limited	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry.

Every code, and what to retry, is in Errors.