Dashboards

List dashboards

Get a list of dashboards, optionally filtered by service it belongs to. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after query params.

get/v1/dashboards

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dashboards
  • Auth: HTTP bearer

Query parameters

fieldsstring
Example:owners,charts,followers,tags,usageSummary,extension,dataModels,domains,dataProducts,sourceHash

Fields requested in the returned resource

servicestring
Example:superset

Filter dashboards by service name

limitinteger

Limit the number dashboards returned. (1 to 1000000, default = 10)

beforestring

Returns list of dashboards before this cursor

afterstring

Returns list of dashboards after this cursor

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

List of dashboards

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.