Skip to main content
PUT
https://sandbox.getcollate.io/api
/
v1
/
dashboards
/
{id}
/
followers
PUT /v1/dashboards/{id}/followers
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

dashboard_id = "03fb5cc3-de48-423f-9926-8e192e5de59d"
user_id = "user-uuid-here"

# Add a follower
dashboard = Dashboards.add_followers(dashboard_id, [user_id])
print(f"Followers: {len(dashboard.followers)}")

# Remove a follower
dashboard = Dashboards.remove_followers(dashboard_id, [user_id])

# Add a vote
dashboard = Dashboards.add_vote(dashboard_id, vote_type="votedUp")

# Remove a vote
dashboard = Dashboards.remove_vote(dashboard_id)
{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "",
  "version": 0.1,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset"
  },
  "serviceType": "Superset",
  "deleted": false,
  "followers": [
    {
      "id": "user-uuid-here",
      "type": "user",
      "name": "john.doe"
    }
  ],
  "owners": [],
  "tags": [],
  "domains": []
}

Followers & Votes

Manage followers and votes for dashboard entities.

Followers

Add Follower

PUT /v1/dashboards/{id}/followers
id
string
required
UUID of the dashboard.
id
string
required
UUID of the user to add as a follower (sent as request body string).

Remove Follower

DELETE /v1/dashboards/{id}/followers/{userId}
id
string
required
UUID of the dashboard.
userId
string
required
UUID of the user to remove.

Votes

Add or Update Vote

PUT /v1/dashboards/{id}/vote
id
string
required
UUID of the dashboard.
updatedVoteType
string
required
Vote type: votedUp, votedDown, or unVoted.
PUT /v1/dashboards/{id}/followers
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

dashboard_id = "03fb5cc3-de48-423f-9926-8e192e5de59d"
user_id = "user-uuid-here"

# Add a follower
dashboard = Dashboards.add_followers(dashboard_id, [user_id])
print(f"Followers: {len(dashboard.followers)}")

# Remove a follower
dashboard = Dashboards.remove_followers(dashboard_id, [user_id])

# Add a vote
dashboard = Dashboards.add_vote(dashboard_id, vote_type="votedUp")

# Remove a vote
dashboard = Dashboards.remove_vote(dashboard_id)
{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "",
  "version": 0.1,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset"
  },
  "serviceType": "Superset",
  "deleted": false,
  "followers": [
    {
      "id": "user-uuid-here",
      "type": "user",
      "name": "john.doe"
    }
  ],
  "owners": [],
  "tags": [],
  "domains": []
}

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission
404NOT_FOUNDDashboard or user does not exist