List Dashboards

GET /dashboards
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/dashboards

Returns a list of Dashboards

query Parameters
Arrow
Name
Description
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
app_idstring
The ID of the application, assigned by Ocamba API.


Example: 1001
company_idstring
The ID of the company, assigned by Ocamba API.
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
creator_idstring
The ID of the member who creates a dashboard, assigned by Ocamba API.
descriptionstring
The detailed dashboard description. Minimum length 5. Maximum length 1000.


Example: Displays user activity
iconstring
The dashboard icon.
idstring (uuid)
The ID of the dashboard, generated by Ocamba API.


Example: 2c9ab0a8-d0d2-49aa-b790-9697cc3aed14
is_defaultinteger
Describe dashboard default status.


Example: 1
namestring
The dashboard name. Minimum length 1. Maximum length 100.


Example: Activity dashboard
systeminteger
Describe dashboard system status.


Example: 1
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "id": "2c9ab0a8-d0d2-49aa-b790-9697cc3aed14",
  "app_id": "1001",
  "name": "Activity dashboard",
  "description": "Displays user activity",
  "system": 1,
  "is_default": 1,
  "create_time": "2021-07-30 12:50:13",
  "update_time": "2021-07-30 12:50:13"
}