Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "<string>",
    "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "<string>",
    "status": "running",
    "trigger": "agent",
    "run_number": 123,
    "questionnaire_revision": 123,
    "content_revision": 123,
    "platform": "<string>",
    "focus": "<string>",
    "audited_source_key": "<string>",
    "proposed_source_key": "<string>",
    "finding_count": 1,
    "open_count": 1,
    "has_running_remediation": true,
    "created_by": "<string>",
    "error": {
      "code": "<string>",
      "message": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

Audit

Start a questionnaire↔survey audit

Creates a questionnaire↔survey audit pinned to a saved content revision and starts survey.audit (detect only).

content_revision defaults to the current tip. 404 if that revision does not exist. Source is loaded from the pinned revision — do not send a free-form source body. Unsaved editor drafts are not a revision.

Re-running on the same saved revision is allowed. 409 audit_already_exists only while an audit is still running for that revision.

Returns 202 { data: audit } with workflow_id (detect World run). Subscribe via GET /v1/workflows/{workflow_id} and .../stream. Domain payloads do not include stream_url.

Newest-wins across revisions: a new POST replaces any active detect run for this survey (survey.audit:{surveyId}).

POST

surveys

{surveyId}

audits

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "<string>",
    "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "<string>",
    "status": "running",
    "trigger": "agent",
    "run_number": 123,
    "questionnaire_revision": 123,
    "content_revision": 123,
    "platform": "<string>",
    "focus": "<string>",
    "audited_source_key": "<string>",
    "proposed_source_key": "<string>",
    "finding_count": 1,
    "open_count": 1,
    "has_running_remediation": true,
    "created_by": "<string>",
    "error": {
      "code": "<string>",
      "message": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "resource": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "endpoint_id": "<string>",
  "event_id": "<string>",
  "delivery_id": "<string>",
  "api_key_id": "<string>",
  "integration_id": "<string>",
  "audit_id": "<string>",
  "status": "<string>",
  "details": "<unknown>",
  "question_ids": [
    "<string>"
  ],
  "survey_ids": [
    "<string>"
  ],
  "revisions": [
    123
  ]
}

Path Parameters

surveyId

string<uuid>

required

Body

application/json

content_revision

integer

focus

string

Minimum string length: 1

trigger

enum<string>

Available options:

agent,

user,

programming

Response

Audit accepted

data

object

required

Show child attributes

Surveys

Workflows

API keys

Integrations

Webhooks

Settings

Meta

Start a questionnaire↔survey audit

Path Parameters

Body

Response