Dashboards

Dashboards can be used to display session data in graphs, grids and other dashboard widgets.

Dashboards when fetched via the API return a data record with the follow keys:

  • id - a unique identifier for the dashboard in the Mobile Data Anywhere system.
  • name - The name of the dashboard
  • xml_data - The raw xml data used to save the dashboard.

Example JSON object:

{
    "id": 123
    "name": "My Dashboard",
    "xml_data": "<?xml version="1.0" encoding="UTF-8"?><Dashboard></Dashboard></?xml> ",
}
>>>

GET /api/v1/dashboards/:id
Get the details for a specific dashboard.

Params

Param name Description
id
required

The id of the dashboard.

Validations:

  • Must be a Integer
>>>

GET /api/v1/dashboards
Return a list of all dashbords in the user's account

>>>

POST /api/v1/dashboards
Save a new dashboard.

>>>

PUT /api/v1/dashboards
Update an existing dashboard .

Params

Param name Description
id
required

The id of the dashboard.

Validations:

  • Must be a Integer
last_fetch_date
required

The date/time that this dashboard was last requested from the server.

Validations:

  • Must be a String
>>>

DELETE /api/v1/dashboards/:id
Remove a dashboard from your account

Params

Param name Description
id
required

The id of the dashboard.

Validations:

  • Must be a Integer
>>>

GET /api/v1/dashboards/:id
Remove a dashboard from your account

Params

Param name Description
id
required

The id of the dashboard.

Validations:

  • Must be a Integer