Skip to content

Dashboard API

This section describes the endpoint /dashboard with associated resources.

GET Convert dashboard folder names into folder ID

Returns an array with IDs of matchin folders.

NOTE: Folder names in the Singular dashboard do not have to be unique.

Requires for authentication a Username and Password.

Method URL Sample URL
GET /dashboard/folder?{folder_path} https://app.singular.live/apiv1/dashboard/folder?path=/Tutorial Compositions/Fitness - Blue

REQUEST

QUERY PARAMETERS

Parameter Description Required
{folder_path} The absolute folder path yes

RESPONSE

STATUS 200 - application/json - Returns an array with JSON representation folder ids.

EXAMPLE

1
["bf894740-b83c-455b-a72f-40f7f72a519c"]

STATUS 400 Returned if parameter path not specified.

EXAMPLE

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "code": 400,
  "error_detail": [
    {
      "param": "path",
      "message": "Please specify 'path'"
    }
  ],
  "message": "Please specify 'path'"
}

STATUS 401 Returned if authorisation failed.

EXAMPLE

1
2
3
4
5
6
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}

GET List folder content

Returns a list of all elements in the folder specified by its folder_id.

Requires for authentication a Username and Password.

Method URL Sample URL
GET /dashboard/folder/{folder_id}/elements?type={element_type} https://app.singular.live/apiv1/dashboard/folder/bf894740-b83c-455b-a72f-40f7f72a519c/elements?type=c

REQUEST

QUERY PARAMETERS

Parameter Description Required
{folder_id} The id of a folder yes
{element_type} The type of elements to list optional

Supported element_types are:

Type Description
c composition
ai control app instance
i asset/image
d data node
fo folder

RESPONSE

STATUS 200 - application/json - Returns an array with the full JSON representation of matching elements.

EXAMPLE: List elements of any type in the specified folder

Request URL:

1
https://app.singular.live/apiv1/dashboard/folder/bf894740-b83c-455b-a72f-40f7f72a519c/elements

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
[
  {
    "name": "Asset Library",
    "user_id": null,
    "refId": 75236,
    "fid": "632710eb-5db1-4959-9448-ae990337e8e7",
    "uuid": null,
    "url": null,
    "updated_at": "2019-01-07T13:51:11.000Z",
    "firebaseUrl": null,
    "ts": "2019-01-07T13:51:11.000Z",
    "type": "fo",
    "thumbnail": null,
    "sort_order": 0
  },
  {
    "name": "Fitness - Blue",
    "user_id": 2290,
    "refId": 127088,
    "fid": "55dcd77f-5235-448b-b3c5-e83fa17c18df",
    "uuid": null,
    "url": null,
    "updated_at": "2019-01-07T10:31:12.000Z",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/users/2290/channels/-LVbrRGQWFOYO9CmomPo",
    "ts": "2019-01-07T10:31:12.000Z",
    "type": "c",
    "thumbnail": "//images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/cd8bdc102b9e4896b1d7845d28f2a12b~mv2/v1/fit/w_150,h_150/a09092c83999c36da3644f0a13b713a4.png#w_907,h_510,mt_image%2Fpng",
    "sort_order": 1
  },
  {
    "name": "Singular Icon 2017.png",
    "user_id": 2290,
    "refId": 652130,
    "fid": "a58ae757-d9f4-47d5-9c65-6a7aee812290",
    "uuid": null,
    "url": null,
    "updated_at": "2019-01-07T13:44:55.000Z",
    "firebaseUrl": null,
    "ts": "2019-01-07T13:44:55.000Z",
    "type": "i",
    "thumbnail": "//images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/7ac7d13628064c48932295f08259691b~mv2/v1/fit/w_150,h_150/a6dc52bf395181f4b33033b12a0b5b8a.png#w_116,h_102,mt_image%2Fpng",
    "sort_order": 2
  },
  {
    "name": "Fitness - Control",
    "user_id": 2290,
    "refId": 104734,
    "fid": "2aa51adf-40ad-4cb7-9224-d071511a6000",
    "uuid": null,
    "url": null,
    "updated_at": "2019-01-07T10:32:19.000Z",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/104734",
    "ts": "2019-01-07T10:32:19.000Z",
    "type": "ai",
    "thumbnail": "//apptemplates.singular.live/57/115/icon.png",
    "sort_order": 3
  },
  {
    "name": "Data Node (Baseline Crawl)",
    "user_id": 2290,
    "refId": 1232,
    "fid": "1492aff6-0235-4fcc-936a-afe84ae49cc2",
    "uuid": null,
    "url": null,
    "updated_at": "2018-08-25T08:04:05.000Z",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/users/2290/dataNodes/-LKDMPexd7eqFOya_fdj",
    "ts": "2018-08-25T08:04:05.000Z",
    "type": "d",
    "thumbnail": null,
    "sort_order": 4
  }
]

EXAMPLE: List compositions in the specified folder

Request URL:

1
https://app.singular.live/apiv1/dashboard/folder/bf894740-b83c-455b-a72f-40f7f72a519c/elements?type=c

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[
  {
    "name": "Fitness - Blue",
    "user_id": 2290,
    "refId": 127088,
    "fid": "55dcd77f-5235-448b-b3c5-e83fa17c18df",
    "uuid": null,
    "url": null,
    "updated_at": "2019-01-07T10:31:12.000Z",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/users/2290/channels/-LVbrRGQWFOYO9CmomPo",
    "ts": "2019-01-07T10:31:12.000Z",
    "type": "c",
    "thumbnail": "//images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/cd8bdc102b9e4896b1d7845d28f2a12b~mv2/v1/fit/w_150,h_150/a09092c83999c36da3644f0a13b713a4.png#w_907,h_510,mt_image%2Fpng",
    "sort_order": 1
  }
]

EXAMPLE: List control app instances in the specified folder

Request URL:

1
https://app.singular.live/apiv1/dashboard/folder/bf894740-b83c-455b-a72f-40f7f72a519c/elements?type=ai

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[
  {
    "name": "Fitness - Control",
    "user_id": 2290,
    "refId": 104734,
    "fid": "2aa51adf-40ad-4cb7-9224-d071511a6000",
    "uuid": null,
    "url": null,
    "updated_at": "2019-01-07T10:32:19.000Z",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/104734",
    "ts": "2019-01-07T10:32:19.000Z",
    "type": "ai",
    "thumbnail": "//apptemplates.singular.live/57/115/icon.png",
    "sort_order": 3
  }
]

STATUS 401 Returned if authorisation failed.

EXAMPLE

1
2
3
4
5
6
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}