Exports

Request an export

Start a whole-project export — every section of the API in one document, paged to the end. Answers straight away with a job to poll.

POSThttps://api.vidrys.com/v1/projects/{project_id}/exports

Plan: Custom
Key: read
Rate cost: 1 unit

A project can have one export running at a time: asking again while one is in flight returns that job rather than starting a second. Up to 20 exports a day per workspace.

The job is built as the credential that asked for it. Revoke the key before it finishes and the export fails instead of completing.

Finished bundles are kept for 7 days.

Request an export

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

202 · success

{
  "id": "6f5e4d3c-2b1a-4098-8765-4321fedcba98",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "created_at": "2026-09-22T08:14:02Z",
  "completed_at": null,
  "error": null,
  "bundle": null
}

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 · 202

application/json

idstring

Export id.

project_idstring

The project exported.

statusstring

Where the job is.

Values:pendingrunningdonefailed

created_atstring

When it was requested (ISO 8601).

completed_atstringnullable

When it finished.

errorstringnullable

Why it failed.

bundleobjectnullable

The data, once status is done — only on Get an export. Each section is what the matching endpoint returns, every page included; a section the plan or project can't read is null.

+Show child attributes

generated_atstring

When the bundle was built (ISO 8601).

projectobject

The project.

+Show child attributes

idstring

Project id (a UUID). Every project-scoped call takes it.

namestring

The brand the project tracks.

industrystringnullable

The industry set on the project.

visibilityobjectnullable

Visibility overview over 90d.

visibility_trendobjectnullable

Visibility trend over 90d.

promptsobject[]

Every prompt.

resultsobject[]

Every latest-run result.

gapsobject[]

Every gap.

citationsobject[]

Every cited domain.

sentimentobjectnullable

Sentiment over 90d.

competitorsobjectnullable

Competitor standings.

competitor_analysisobjectnullable

Competitor analysis.

content_assetsobject[]

Every content opportunity.

queueobject[]

Every content-queue task.

impactobjectnullable

Impact.

topic_coverageobjectnullable

Topic coverage.

site_auditobjectnullable

Site audit.

ai_referralsobjectnullable

AI referral traffic.

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