Dashboard subscriptions

Follow

You can give a named user group access to a particular dashboard.

Get dashboard subscriptions

  • GET /dashboard_subscriptions will return all dashboard subscriptions.
[
  {
    "id": 605816632,
    "dashboard_id": 123,
    "named_user_group_id": 345,
    "updated_at": "2012-03-23T13:55:43-05:00",
    "created_at": "2012-03-23T13:55:43-05:00"
  },
  {
    "id": 605816632,
    "dashboard_id": 143,
    "named_user_group_id": 345,
    "updated_at": "2012-03-23T13:55:43-05:00",
    "created_at": "2012-03-23T13:55:43-05:00"
  }
]

Get dashboard subscription

  • GET /dashboard_subscriptions/1 will return the specified dashboard subscription.
{
  "id": 605816632,
  "dashboard_id": 123,
  "named_user_group_id": 345,
  "updated_at": "2012-03-23T13:55:43-05:00",
  "created_at": "2012-03-23T13:55:43-05:00"
}

Create dashboard subscription

  • POST /dashboard_subscriptions will create a new dashboard subscription from the parameters passed.
{
  "dashboard_id": 123,
  "named_user_group_id": 435
}

This will return 200 Created, with the current JSON representation of the dashboard subscription if the creation was a success. See the Get dashboard subscription endpoint for more info.

Update dashboard subscription

  • PUT /dashboard_subscriptions/1 will update the dashboard subscription from the parameters passed.
{
  "dashboard_id": 123,
  "named_user_group_id": 435
}

Delete dashboard subscription

  • DELETE /dashboard_subscriptions will delete the dashboard subscription specified and return 204 No Content if that was successful.
Have more questions? Submit a request

6 Comments

  • 0

    One typo in here -- The POST call returns status code 200 on success, rather than 201.

  • 0

    Thanks, Aleem. Article is updated.

  • 0

    Hello,

    Does the "Delete dashboard subscription" remove all subscriptions for all users & dashboards ?

    How can I remove a subscription for 1 user on 1 dashboard ?

  • 0

    Hello

    Any news about my last question ?

  • 0

    Hello,

    The Delete dashboard subscription deletes only the subscriptions for the selected dashboards

    Thanks.

  • 0

    I ask the question because this document does not show the parameters to pass in the request. So this doc should be improved

Please sign in to leave a comment.
Powered by Zendesk