Competitors

Get competitor standings

Each tracked competitor's visibility and your head-to-head win rate against it, biggest threat first.

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

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

A head-to-head is only reported once the two brands have appeared in the same answer at least min_co_appearances times (8). Below that, win_rate is null — a small sample is not a result.

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

200 · success

{
  "rivals": [
    {
      "name": "Northwind Billing",
      "visibility": 62.5,
      "win_rate": 30,
      "co_appearances": 10
    },
    {
      "name": "Contoso Books",
      "visibility": 45,
      "win_rate": 55.6,
      "co_appearances": 9
    },
    {
      "name": "Fabrikam Pay",
      "visibility": 12.5,
      "win_rate": null,
      "co_appearances": 3
    }
  ],
  "total_probes": 40,
  "min_co_appearances": 8
}

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

rivalsobject[]

Tracked competitors, biggest threat (lowest head-to-head win rate) first; rows without a win rate last.

+Show child attributes

namestring

Competitor.

visibilitynumber

Share of the latest run's answers that name it, 0–100.

win_ratenumbernullable

Of the answers naming both, the share that name the brand first, 0–100. Null below min_co_appearances.

co_appearancesinteger

Answers that name both the brand and this competitor.

total_probesinteger

Answers in the latest run.

min_co_appearancesinteger

Shared answers needed before a head-to-head win rate is reported. Always 8.

Errors

404 not_found	The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
403 forbidden	The workspace or the member the key acts as can't do this in the dashboard either — for example a project with competitive analysis switched off.
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.