Playlist API

    Get all existing playlist for the current organization using pagination

    Example Request:

    Querystring Parameters:

    These parameters are used as querystring parameters.

    • query - Limit response to playlist having a name like this value.
    • limit - Limit response to X number of playlist.

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    3. [
    4.   {
    5.     "id": 1,
    6.     "name": "my playlist",
    7.     "interval": "5m"
    8.   }
    9. ]

    Get one playlist

    GET /api/playlists/:id

    Example Request:

    1. GET /api/playlists/1 HTTP/1.1
    2. Accept: application/json
    3. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    1. HTTP/1.1 200
    2. Content-Type: application/json
    3. {
    4.   "id" : 1,
    5.   "name": "my playlist",
    6.   "interval": "5m",
    7.   "orgId": "my org",
    8.   "items": [
    9.     {
    10.       "id": 1,
    11.       "playlistId": 1,
    12.       "type": "dashboard_by_id",
    13.       "value": "3",
    14.       "order": 1,
    15.       "title":"my third dashboard"
    16.     },
    17.     {
    18.       "id": 2,
    19.       "playlistId": 1,
    20.       "type": "dashboard_by_tag",
    21.       "value": "myTag",
    22.       "order": 2,
    23.       "title":"my other dashboard"
    24.     }
    25.   ]
    26. }

    GET /api/playlists/:id/items

    Example Request:

    Example Response:

    1. Content-Type: application/json
    2. [
    3.   {
    4.     "id": 1,
    5.     "playlistId": 1,
    7.     "value": "3",
    8.     "order": 1,
    9.     "title":"my third dashboard"
    10.   },
    11.   {
    12.     "id": 2,
    13.     "playlistId": 1,
    14.     "type": "dashboard_by_tag",
    15.     "value": "myTag",
    16.     "order": 2,
    17.     "title":"my other dashboard"
    18.   }
    19. ]

    Get Playlist dashboards

    GET /api/playlists/:id/dashboards

    Example Request:

    1. GET /api/playlists/1/dashboards HTTP/1.1
    2. Accept: application/json
    3. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    3. [
    4.   {
    5.     "id": 3,
    6.     "title": "my third dashboard",
    7.     "order": 1,
    8.   },
    9.   {
    10.     "id": 5,
    11.     "title":"my other dashboard"
    12.     "order": 2,
    14.   }
    15. ]

    POST /api/playlists/

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    3.   {
    4.     "id": 1,
    5.     "name": "my playlist",
    6.     "interval": "5m"
    7.   }

    Update a playlist

    PUT /api/playlists/:id

    Example Request:

    1. PUT /api/playlists/1 HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4.   {
    6.     "interval": "5m",
    7.     "items": [
    8.       {
    9.         "playlistId": 1,
    10.         "type": "dashboard_by_id",
    11.         "value": "3",
    12.         "order": 1,
    13.         "title":"my third dashboard"
    14.       },
    15.       {
    16.         "playlistId": 1,
    17.         "type": "dashboard_by_tag",
    18.         "value": "myTag",
    19.         "order": 2,
    20.         "title":"my other dashboard"
    21.       }
    22.     ]
    23.   }

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    3. {
    4.   "id" : 1,
    5.   "name": "my playlist",
    6.   "interval": "5m",
    7.   "orgId": "my org",
    8.   "items": [
    9.     {
    10.       "id": 1,
    11.       "playlistId": 1,
    12.       "type": "dashboard_by_id",
    13.       "value": "3",
    14.       "order": 1,
    15.       "title":"my third dashboard"
    16.     },
    17.     {
    18.       "id": 2,
    19.       "playlistId": 1,
    20.       "type": "dashboard_by_tag",
    21.       "value": "myTag",
    22.       "order": 2,
    23.       "title":"my other dashboard"
    24.     }
    25.   ]
    26. }

    DELETE /api/playlists/:id

    Example Request:

    Example Response:

    1. HTTP/1.1 200
    2. {}