Visits

Get details about a specific visit under the given project and query.

get/projects/{project_id}/queries/{query_id}/visits/{visit_uuid}

Request

Base URL
https://api.datavant.io/v2
Auth
OAuth 2
Client credentials
Token URLhttps://api.datavant.io/v2/oauth2/token
TypeScript
https://skmtc.dev/datavant/apis/datavant-rest-api/docs/projects/:project_id/queries/:query_id/visits/:visit_uuid/get.ts
A function with typed inputs. Its response is checked against the schema.

project_idstring required

query_idstring required

visit_uuidstring required

version-datavantstring

Version of the Orders API to use with this call

Successful Response

uuidstring required

Unique identifier for the visit.

Enum for visit statuses.

status_detailsVisitStatusDetail[] required

Further details about the current visit status.

updated_atstring date-time required

Date and time when the visit was last updated.

created_atstring date-time required

Date and time when the visit was created.

order_idstring required

Customer-facing identifier for the order.

No recorded changes to this operation across all 2 revisions of this API.