Generate JSON export

get

https://vitalsapi.luscii.com/v1/export/{reportType}

Generate a paginated json export to be received via response body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Export API allows you to directly access data from your organization.

🚧
NOTE: The Export API is not intended or designed for the use in a clinical setting where the data is used to provide care to patients.
Data can be used for business intelligence purposes, for example to analyse the use and effectiveness of Luscii in your organization.

Accessible by HC_ADMIN and HC_SUPPORTER.

Path Params

reportType

string

enum

required

Report type.

Query Params

startDate

date

First day of the selected data. Must be given if the reportType is 'alerts', 'measurements', 'plannedActions', 'patientsWorkflowHistory', 'patientsProgramsHistory', 'patientsSettingsHistory' or 'usersStatusChangeReasons'. Optional if reportType is 'measurementsWithQuestionnaires' or 'measurementsForQuestionnaires'. Forbidden for other values of reportType.

endDate

date

Last day of the selected data. Must be given if the reportType is 'alerts', 'measurements', 'plannedActions', 'patientsWorkflowHistory', 'patientsProgramsHistory', 'patientsSettingsHistory' or 'usersStatusChangeReasons'. Optional if reportType is 'measurementsWithQuestionnaires' or 'measurementsForQuestionnaires'. Forbidden for other values of reportType.

cursor

string

Cursor to paginate the results

perPage

integer

1 to 200

Defaults to 50

Number of items per page

Responses

422

Unprocessable entity, i.e. Validation error

503

Service unavailable, e.g. when the functionality is disabled

NOTE: The Export API is not intended or designed for the use in a clinical setting where the data is used to provide care to patients.

200Success response if everything works