View Dashboard

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

Retrieves the details of a Dashboard that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
When you retrieve a collection of some source, you can specify a subset of fields to be returned for each source. For efficiency, every source in a collection is represented by the default representation.


Example: fields=field1,field2,field3
viewstring
You can request one of the predefined representations(default, full) or custom representation according to your needs.


Example: view=full/default
sortstring
The collection of accounts can be sorted by name, type, create_time, campaign_count and zone_count (ASC) is a default.


Example: sort=-field1,filed2
pagestring
When you retrieve a collection of sources, pagination is enforced by default. If you don't specify a value for the collection size, 10 is used as a default.


Example: page=1,10

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ dashboard ]
An array of all created items.
Dashboard
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
totalinteger
A total number of items.


Example: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "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"
    }
  ]
}