GET /groups/{id}/default-tabs

Description

Retrieve a list of default tabs (now called dashboards) for a specific group.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs

Parameters

tab_id (string) — show only dashboards that belong to a specific group
tab_name (string) — show dashboard name
description — information about the dashboard
can_edit — true/false
visibility — library, dashboard,permanent
index — tab position
id — default tab ID

Example Request

GET https://app.klipfolio.com/api/1.0/groups/bdd7b4d0a729704164ab4b38e788de21/default-tabs

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "tabs": [
      {
        "tab_id": "fc67d8f1646b3333e1641e1085a5e555",
        "tab_name": "Group Sales",
        "description": null,
        "can_edit": false,
        "visibility": "permanent",
        "index": 1,
        "id": "caadadb4b08f36973c4446e459b14deb"
      }
    ]
  }
}

GET /groups/{id}/default-tabs/{id}

Description

Retrieve the details for a specific group default tab.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs/{id}

Parameters

tab_id (string) — show only dashboards that belong to a specific group
tab_name (string) — show dashboard name
description — information about the dashboard
can_edit — true/false
visibility — library, dashboard,permanent
index — tab position
id — default tab ID
klips_shared
total_klips

Example Request

https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb
##Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "id": "caadadb4b08f36973c4446e459b14deb",
    "tab_id": "fc67d8f1646b2306e1641e1085a5e704",
    "tab_name": "Group Sales",
    "description": null,
    "can_edit": false,
    "visibility": "permanent",
    "index": 1,
    "klips_shared": 1,
    "total_klips": 2
  }
}

POST /groups/{id}/default-tabs

Description

Add a new default dashboard to a specified group.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs

Parameters

None.

Example Request

https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs -d "{'tab_id':'fc67d8f1646b2306e1641e1085a5e704','can_edit':true,'visibility':'dashboard','index':1}"

Example Response

{
  "meta": {
    "success": true,
    "status": 201,
    "location": "/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb"
  },
  "data": {}
}

PUT /groups/{id}/default-tabs/{id}

Description

Update an existing default dashboard for a specified group.

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/groups/{id}

Parameters

name, description, visibility, index

Example Request

PUT https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb -d "{'tab_id':'fc67d8f1646b2306e1641e1085a5e704',description:'Finance dashboard'}"

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {}
}

DELETE /groups/{id}/default-tabs/{id}

Description

Delete the specified group default dashboard.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/groups/{id}/default-tabs/{id}

Parameters

None.

Example Request

DELETE https://app.klipfolio.com/api/1.0/groups/dbb7b4d0a729704164ab4b38e799de11/default-tabs/caadadb4b08f36973c4446e459b14deb
##Example Response

{
"meta": {
      "status": 200,
      "success": true
  }
}