Create, view, update, and delete published links.
POST /dashboard-published-links/{dashboard_id}
| Description | Creates a new published link |
| Permissions | tab.publish |
| Resource URL | https://app.klipfolio.com/api/1.0/dashboard-published-links/{dashboard_id} |
| Parameters | client_id (string) — gets details for a published link in the specific client’s account, required: false name (string) — name of published link, required: true password (string) — password for viewing published link, required: false description (string) — description of published link, default: null isPublic (boolean) — published link is publicly searchable, default: false theme (string) — default: "light", options: ["light", "dark"] logo (string) — required: false, description: url social (boolean) — show social icons, default: false wantsAdvertising (boolean) — default: false useIpRanges (boolean) — default: false |
Example Request
POST https://app.klipfolio.com/api/1.0/dashboard-published-links/a30969fdee0cad2c3ee0e3587b40df3?client_id=76dad40b231878c6699ff484859addc8
{
"name": "API demo published link",
"description": "Created VIA API",
"theme":"dark",
"social":true
}
Example Response
{
"meta": {
"success": true,
"status": 201
},
"data": {
"id": "d2e5cdcf7f1d6e6e764e3b24e9edd762",
"published_link_name": "API demo published link",
"dashboard_url": "app.klipfolio.com/published/d2e5cdcf7f1d6e6e764e3b24e9edd762/api-demo-published-link",
"visibility": "public_searchable",
"date_created": "2020-03-17T18:40:58Z",
"created_by": {
"user_public_id": "6f97a2bf53a3dabfe3201bed212e7d05",
"user_name": "Mary Grant"
},
"date_last_accessed": null
}
}
GET /dashboard-published-links
| Description | Returns published link details for a single published link or all published links for a specified dashboard |
| Permissions | tab.publish |
| Resource URL | https://app.klipfolio.com/api/1.0/dashboard-published-links/{published-link-id} |
| Parameters | client_id (string) — gets details for a published link in the specific client’s account dashboard_id (string) — gets list of all published links for the specified dashboard |
Example Request
GET https://app.klipfolio.com/api/1.0/dashboard-published-links/d2e5cdcf7f1d6e6e764e3b24e9edd76
Example Response
{
"meta": {
"success": true,
"status": 200
},
"data": {
"id": "d2e5cdcf7f1d6e6e764e3b24e9edd762",
"published_link_name": "API demo published link",
"dashboard_url": "app.klipfolio.com/published/d2e5cdcf7f1d6e6e764e3b24e9edd76/api-demo-published-link",
"visibility": "public_searchable",
"date_created": "2020-03-17T18:40:58Z",
"created_by": {
"user_public_id": "6f97a2bf53a3dabfe3201bed212e7d05",
"user_name": "Mary Grant"
},
"date_last_accessed": null
}
}
Example Request with parameters
GET https://app.klipfolio.com/api/1.0/dashboard-published-links?dashboard_id=a30969fdee0cad2c3ee0e3587b40df32&client_id=76dad40b231878c6699ff484859addc8
Example Response
{
"meta": {
"success": true,
"status": 200
},
"data": {
"published_links": [
{
"id": "c9ea6fd37115503068d64da6318d45dc",
"published_link_name": "API demo published link",
"dashboard_url": "app.klipfolio.com/published/d2e5cdcf7f1d6e6e764e3b24e9edd762/api-demo-published-link",
"visibility": "public_searchable",
"date_created": "2020-03-17T18:48:59Z",
"created_by": {
"user_public_id": "6f97a2bf53a3dabfe3201bed212e7d05",
"user_name": "Test a0e694c7f7704dfc1762bd4c334de348"
},
"date_last_accessed": null
},
{
"id": "d2e5cdcf7f1d6e6e764e3b24e9edd762",
"published_link_name": "Updated API demo published link",
"dashboard_url": "app.klipfolio.com/published/d2e5cdcf7f1d6e6e764e3b24e9edd762/updated",
"visibility": "public_searchable",
"date_created": "2020-03-17T18:40:58Z",
"created_by": {
"user_public_id": "bfe322bf53a3daed212e7d0501b6f97a",
"user_name": "John Pike"
},
"date_last_accessed": null
}
]
}
}
PUT /dashboard-published-links/{published_link_id}
| Description | Updates the properties of a published link |
| Permissions | tab.publish |
| Resource URL | https://app.klipfolio.com/api/1.0/dashboard-published-links/{published-link-id} |
| Parameters | client_id (string) — gets details for a published link in the specific client’s account, required: false name (string) — name of published link, required: false password (string) — password for viewing published link, required: false description (string) — description of published link, default: null isPublic (boolean) — published link is publicly searchable, default: false theme (string) — default: "light", options: ["light", "dark"] logo (string) — required: false, description: url social (boolean) — show social icons, default: false wantsAdvertising (boolean) — default: false useIpRanges (boolean) — default: false |
Example Request
PUT https://app.klipfolio.com/api/1.0/dashboard-published-links/d2e5cdcf7f1d6e6e764e3b24e9edd76
{
"name": "Updated Published Link",
"password": "6&jn0$c8sh&b018573685",
"isPublic": false,
"theme":"light"
}
Example Response
{
"meta": {
"success": true,
"status": 200
},
"data": {
"id": "d2e5cdcf7f1d6e6e764e3b24e9edd762",
"published_link_name": "Updated Published Link",
"dashboard_url": "app.klipfolio.com/published/d2e5cdcf7f1d6e6e764e3b24e9edd762/updated-published-link",
"visibility": "anyone_with_link_and_password",
"date_created": "2020-03-17T18:40:58Z",
"created_by": {
"user_public_id": "6f97a2bf53a3dabfe3201bed212e7d05",
"user_name": "Mary Grant"
},
"date_last_accessed": "2020-03-17T19:40:25Z"
}
}
DELETE /dashboard-published-links/{published_link_id}
This endpoint will permanently delete a published link
| Description | Deletes published link |
| Permissions | tab.publish |
| Resource URL | https://app.klipfolio.com/api/1.0/dashboard-published-links/{dashboard-id} |
| Parameters | client_id (string) — gets details for a published link in the specific client’s account |
Example Request
DELETE https://app.klipfolio.com/api/1.0/dashboard-published-links/d2e5cdcf7f1d6e6e764e3b24e9edd76?client_id=76dad40b231878c6699ff484859addc8
Example Response
{
"meta": {
"success": true,
"status": 200
},
"data": {}
}