Results

Get query fan-out

The sub-questions engines searched behind one prompt, and the brand's visibility on each.
GEThttps://api.vidrys.com/v1/projects/{project_id}/prompts/{prompt_id}/fanout
Plan
Grow and above
Key
read
Rate cost
1 unit

Fan-out tracking is off unless it's switched on for the workspace, which is a Custom-plan arrangement. Without it, sub_queries comes back empty rather than failing.

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.

prompt_idstringrequired

The prompt to open up.

Response · 200

application/json

prompt_idstring

The prompt you asked about.

sub_queriesobject[]

The sub-questions engines searched, most visible first. Empty when fan-out tracking is off.

+Show child attributes
textstring

The sub-question.

visibilitynumber

Share of its answers that mention the brand, 0–100.

probesinteger

Answers counted.

by_modelobject[]

The same, per engine.

+Show child attributes
platform_labelstring

Engine name.

visibilitynumber

0–100.

probesinteger

Answers counted.

Errors

404 not_foundThe project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
401 unauthorizedNo 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_requiredThe workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approvedThe workspace is still waiting for approval, or wasn't approved.
429 rate_limitedToo 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.