Guides

Tab Klip Instances

A tab (now called dashboard) may have more than one Klip instance associated with it. A Klip instance is a copy of a Klip in a user’s tab.

GET /tabs/{id}/klip-instances

DescriptionGet a list of the Klip instances associated with the tab.
Permissionsdashboard.tab
Resource URLhttps://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances
Parameterstab id={id}

Example Request

GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances

Example Response

{
 "data": {
  "klip_instances":
 [{
   "id":"04462abd3a38372173645f3b50128596",   
   "klip_id":"b2f4179cdc4f5a022a80310fe93b1022",
   "name":"Visits and Goals"
 }]
  },
 "meta": {
     "status": 200,
     "success": true
 }
}

PUT /tabs/{id}/klip-instances

DescriptionAdd a Klip to a tab. The Klip id is used instead of the Klip instance id.
Note: If region and position are not included, they default to 1 and 0 respectively.
Permissionsdashboard.tab
Resource URLhttps://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances
FieldsKlips

Example Request

PUT https://app.klipfolio.com/api/1.0/tabs/ca74a78906543be66b2z9c123e76b1bc/klip-instances -d {'klips': [{'klip_id': 'd012d123b56123d1234ef12c8f12c123', 'region': 0, 'position': 1}]}

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "klip_instances": [
      {
        "id": "12a123c123ef12333cbf7d3d864f674",
        "klip_id": "d012d123b56123d1234ef12c8f12c123",
        "name": "Klipfolio API, Client Dynamic, filter Active"
      }
    ]
  }
}

DELETE /tabs/{id}/klip-instances/

DescriptionDelete a Klip that is on a tab.
Permissionsdashboard.tab
Resource URLhttps://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances/
ParametersNone.

Example Request

DELETE https://app.klipfolio.com/api/1.0/tabs/ca12b12345678ie91b2o9c123e89b7bc/klip-instances/c5t8i9abc4ca99613a1bd1bf5c123ce4

Example Response

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