Visibility

Get sentiment

How the answers that do mention the brand describe it — overall, per engine, and day by day.

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

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

Get sentiment

curl --request GET \
  --url "https://api.vidrys.com/v1/projects/{project_id}/sentiment?range=30d" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "range": "30d",
  "positive": 38.5,
  "neutral": 53.8,
  "negative": 7.7,
  "dominant": "neutral",
  "net_score": 30.8,
  "net_score_delta": 4.1,
  "mentions": 52,
  "by_platform": [
    {
      "platform_label": "ChatGPT",
      "dominant": "neutral",
      "net_score": 22.2,
      "mentions": 18
    }
  ],
  "trend": [
    {
      "date": "2026-09-20",
      "positive": 7,
      "neutral": 10,
      "negative": 1,
      "mentions": 18
    }
  ]
}

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

rangestring

The window the numbers cover.

Values:7d30d90d

positivenumber

Share of mentioning answers with a positive tone, 0–100.

neutralnumber

Share with a neutral tone, 0–100.

negativenumber

Share with a negative tone, 0–100. The three add up to about 100.

dominantstringnullable

The most common tone. Null with no mentions.

Values:positiveneutralnegative

net_scorenumber

positive minus negative, from −100 to 100.

net_score_deltanumbernullable

Change in net_score against the previous window, in points. Null if either window has no mentions.

mentionsinteger

Answers in the window that mention the brand.

by_platformobject[]

Per engine, for engines with at least one mention.

+Show child attributes

platform_labelstring

Engine name.

dominantstringnullable

Most common tone.

Values:positiveneutralnegative

net_scorenumber

−100 to 100.

mentionsinteger

Mentioning answers.

trendobject[]

Tone counts per day across the window.

+Show child attributes

datestring

Day, as YYYY-MM-DD.

positiveinteger

Positive answers.

neutralinteger

Neutral answers.

negativeinteger

Negative answers.

mentionsinteger

All mentioning answers.

Errors

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 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.