API

Create Dashboard

post
https://api.medocity.net/v3/dashboard

Create a new custom dashboard with the provided details. [scope: Dashboard, claim: Write]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Name Type Description
dashboardTitle string Title of Dashboard.
dashboardSettings > widgetSerializedData string Serialized Widget data.
type string Denotes the type of the dashboard.
reachTrial string Defines if this is a reach trial.
clinicalTrial string Defines if this is a clinical trial.
Body Params

The data transfer object containing the details required to create a new custom dashboard.

string
required
length between 3 and 45

The title of the dashboard to be created. It should be between 3 and 45 characters long.

dashboardSettings
object
required

Serialized data of the widgets in the dashboard, detailing their configuration and state.

string
enum
required

The type of the dashboard, indicating whether it is a general dashboard or a health summary dashboard.

Allowed:
string

The unique identifier for the reach trial associated with this dashboard. This field is optional.

string

The unique identifier for the clinical trial associated with this dashboard. This field is optional.

Response

Updated almost 2 years ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago