Skip to Content
veriom

Get discovery summary

Discovery's progress for the workspace Overview, without its fields or values. It never starts a profile, so any member can read it before anyone opens Discovery.

GET
/v1/workspaces/{workspace_id}/discovery/summary

Discovery's progress for the workspace Overview, without its fields or values.

It never starts a profile, so any member can read it before anyone opens Discovery.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Response Body

Successful Response

application/json
  1. response

How far the workspace's Discovery context is, for the Overview: no fields, no values.

completed_required_fields*Completed Required Fields
Range0 <= value
completion_percent*Completion Percent
Range0 <= value <= 100
next_question*|

The open question Discovery asks next, highest priority first.

open_contradictions*Open Contradictions
Range0 <= value
open_questions*Open Questions
Range0 <= value
pending_suggestions*Pending Suggestions

Boundary suggestions awaiting a decision.

Range0 <= value
published*Published

A version of the context has been published.

registered_sources*Registered Sources

Active registered sources.

Range0 <= value
required_field_count*Required Field Count
Range0 <= value
source_groups*Source Groups

Active source groups.

Range0 <= value
started*Started

False until someone opens Discovery for the first time.

status*Status

The profile status, or not_started.

version*Version

The profile version, 0 before it starts.

Range0 <= value
Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/discovery/summary'
Example Response
{  "completed_required_fields": 0,  "completion_percent": 0,  "next_question": {    "category": "string",    "field_key": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "prompt": "string",    "why_asked": "string"  },  "open_contradictions": 0,  "open_questions": 0,  "pending_suggestions": 0,  "published": true,  "registered_sources": 0,  "required_field_count": 0,  "source_groups": 0,  "started": true,  "status": "string",  "version": 0}