Site

Get topic coverage

Which subtopics of your category the site covers, and which it doesn't.

GEThttps://api.vidrys.com/v1/projects/{project_id}/topic-coverage

Plan: Grow and above
Key: read
Rate cost: 1 unit
MCP tool: get_topic_coverage

Get topic coverage

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

200 · success

{
  "records": [
    {
      "category": "payment",
      "website_name": "acmeinvoicing.com",
      "coverage_score": 62.5,
      "covered_subtopics": [
        "invoicing",
        "recurring billing",
        "tax handling",
        "refunds",
        "payment links"
      ],
      "missing_subtopics": [
        "chargebacks",
        "multi-currency",
        "payouts"
      ],
      "total_subtopics": 8,
      "analyzed_at": "2026-09-19T21:04:11Z"
    }
  ]
}

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.

Response · 200

application/json

recordsobject[]

One row per category the site is read against.

+Show child attributes

categorystring

The topic area, e.g. payment.

website_namestringnullable

The site read.

coverage_scorenumber

Share of the category's subtopics the site covers, 0–100.

covered_subtopicsstring[]

Subtopics found.

missing_subtopicsstring[]

Subtopics not found.

total_subtopicsinteger

Subtopics checked.

analyzed_atstringnullable

When the site was last read (ISO 8601).

Errors

404 not_found	The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
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 Grow, Scale and Custom.
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.