How can we help?

New post
2

API method to download a dashboard.

Avatar
Carlos Ríos
None
Follow

It would be great the availability of a new API RESful methos which allow us to download a dashboard with its klips.

I imagine something like this:

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

Request:

GET https://app.klipfolio.com/api/1/tabs_download/012345679012345978abcd

Response:

{
 "data": {
       "id": "012345679012345978abcd",
       "image":"http://temp.klipfolio.com/some_random_hash.png",
       "pdf": "http://temp.klipfolio.com/some_random_hash.pdf"
}, "meta": { "status": 200, "success": true } }

 

What do you think?

 

Best regards.

Date Votes

14 comments

  • 1
    Avatar
    Senduren Sivakumar

    I was looking for exactly this.

    Any idea if it's possible?

     

    Sen

  • 1
    Avatar
    Nikta Kanuka

    Thanks Carlos and Sen!

    Could you both tell me a bit more about how you would use this functionality? I'd like to put together a use-case to pass on to the Product Management team. Thanks!

    Nikta

  • 0
    Avatar
    Carlos Ríos

    Nikta,

    Sometimes I want to store the current dashboard state for historical purposes, so in the future can I compare both images, the current state versus a previous one.

    Does it count as use-case?

     

    Also I would be great if this feature is callable by the opsgenie-sdk python package.

     

    Best regards!

  • 0
    Avatar
    Nikta Kanuka

    Thanks Carlos, yes, that does help, but it almost seems like this should be something that is built into the dashboard, do you agree?

    Having the ability to dynamically chose date ranges for Klips on a dashboard is something we often discuss here, so I'm wondering if that kind of functionality would get the job done for you. Imagine seeing the Klip as it is now, and then selecting a custom date range to compare the metric.

    This spares the user having to run API queries, taking 'snapshots' of Klips, and makes the whole dashboard experience more interactive.

    Curious to hear your thoughts. Thanks again for chiming in here! 

     

  • 0
    Avatar
    Senduren Sivakumar

    Hi Nikita, 

     

    I'd like to be able to pull up a snapshot of a dashboard (or even klip) on demand. 

    Example:
    A slackbot that would embed the latest metrics in the thread. To achieve this I would need to download an image of the dashboard programmatically, rather than scheduled email. 

    This could also be achieved with permanent urls to download images/pdfs instead of APIs but APIs would probably be the better option.

     

    Thanks!

     

    Sen

  • 0
    Avatar
    Nikta Kanuka

    Thanks Sen,

    The slackbot example is neat and would be a great way of expanding how teams collaborate around KPIs (and a nice extension to our existing Slack integration).

    I'll pass it along to the product team, thanks!

    Nikta

  • 0
    Avatar
    Senduren Sivakumar

    Thanks Nikta - Have a great weekend!

  • 0
    Avatar
    Scott Lawrence

    Great contributions and outlines of use cases here!  This is great to help us better understand the how and why of new feature requests.

    Senduren, it sounds like you may have a slightly different need than Carlos.  Can you help us better understand what you are trying to achieve?  

    It sounds like you want a way to more easily get the current state of a Klip into Salck for collaboration.  Reading your example, it sounds like you are looking for a mechanism to start from within Slack and essentially ask for the current state of a specific Klip (or dashboard) to be pulled into the channel/thread you are on.  Am I understanding your use case?  (It sounded like you were not looking for a scheduled push of a Klip into a channel or thread - or did I misunderstand?)

    Can you provide an example of how you would use this?  (I am trying to capture an understanding of the business or user scenario behind your feature request.)

     

    Thanks again,

    Scott.

  • 0
    Avatar
    Senduren Sivakumar

    Hi Scott, 

     

    Here is an example of what I'd like to do:

    I'd like to hit a klipfolio endpoint Ex. klipfolio.com/api/snapshot/<klip or dashboard id>?format=png

    The response would be a link to a static img (or pdf) of the dashboard when that endpoint was hit or it could return the image in the payload.

     

    Then in slack I could set up a trigger for the api call and have it embed the image.

     

    Thanks, 

     

    Sen

  • 0
    Avatar
    Fang Yang

    We have exactly the same needs to generate Klip images (png or jpg) so we can use those static images elsewhere, for example, via Slack or Zapier integration. From UI, Klipfolio does have download functionality, which just needs to be wrapped up into an api call 😄

    👍👍👍

    Fang

  • 0
    Avatar
    Fang Yang

    any updates? Or is this on the prod roadmap?

  • 0
    Avatar
    Thomas Kern

    updates? It would be great, to make an image/pdf through an API endpoint.

  • 0
    Avatar
    Senduren Sivakumar

    Hi Klipfolio Team, 

    I was wondering if you could let me know if this is a planned/roadmapped feature, or if I should look elsewhere. We have some business requirements for this feature so I just want to understand limitations etc.

     

    Thanks again, 

     

    Sen

  • 0
    Avatar
    Damage Monitor

    Hello Klipfolio Team,

     

    This is a very good idea... Are you going to implement it?

     

    Best regards

Please sign in to leave a comment.