List dashboards

Next
Get
/v1alpha/dashboards

Returns the dashboards the API key can see: organization dashboards, dashboards shared with all users, and private or selected dashboards that the API key's user owns or is included in. A service account key sees only the first two. To see every dashboard in the workspace, use an API key whose role includes the Bypass cases dashboard restriction permission. The Account Owner role includes it.

Security
HTTP
Type bearer
Query parameters
title
string

Return only dashboards whose title contains this text. The match is case-insensitive.

id
string

Return only the dashboard with this ID. The response then includes the dashboard's access entries, if it has any. An ID that does not exist, or that the API key cannot see, returns an empty list.

order_by
string

The criteria by which to sort the results. The only possible value is created_at. By default, organization dashboards are listed first, then the rest by creation time.

order
string

The order in which to sort the results when order_by is set. The possible values are: asc for ascending, and desc for descending. Default is asc.

Default"asc"
page_size
integer (int32)

The maximum number of dashboards to retrieve per page. Default is 100. Maximum is 500. If the number of results exceeds the defined page size, use pagination to retrieve the next page of results.

Default100
page_token
string

The token received from a previous List dashboards request. Provide this to retrieve the next page of results. Send the same filters and sort as the request that returned it.

Responses
200

A successful response.

Expand All
object
dashboards
Array of object (v1alphaDashboard)

The dashboards that match the request.

object

A dashboard in the workspace.

id
string

The unique identifier of the dashboard.

Example0f8fad5b-d9cb-469f-a165-70867728950e
title
string

The dashboard title.

ExampleSOC overview
description
string

The dashboard description.

ExampleOpen cases by severity and assignee
is_org_dashboard
boolean

Whether this is an organization dashboard, shared from the organization to its workspaces.

access_type
string

Who can see the dashboard. The possible values are: all_users for everyone in the workspace, private for only its owner, selected for the users, groups, or workspaces in access_entries, and organization for every workspace in the organization.

Exampleselected
access_entries
Array of object (v1alphaAccessEntry)

The users, groups, and workspaces the dashboard is shared with. For a private dashboard, the owner. Returned only by List dashboards when filtering by id, and by Update dashboard access.

object

Contains a user, group, or workspace that can see a dashboard.

type
string

The kind of entry. The possible values are: user, group, workspace. Only user and group can be set through Update dashboard access.

Exampleuser
value
string

The user's email address, the group ID, or the workspace ID.

Exampledana@example.com
widget_count
integer (int32)

The number of widgets on the dashboard.

Example6
created_at
string (date-time)

The timestamp when the dashboard was created.

created_by
object (apidashboardsv1alphaActor)

Contains the user, API key, workflow, integration, agent, or system that performed an action.

type
string

The kind of actor. The possible values are: user, service_api_key, workflow, integration, agent, system.

Exampleuser
email
string

The user's email address. Set when type is user.

Exampledana@example.com
name
string

The user's full name, the API key name, the workflow name or the integration type, when known.

ExampleDana Levi
id
string

The API key client ID, the workflow ID, the integration ID or the agent ID, when applicable.

updated_at
string (date-time)

The timestamp when the dashboard was last updated. If the dashboard has never been updated, this is its creation time and updated_by is not returned.

updated_by
object (apidashboardsv1alphaActor)

Contains the user, API key, workflow, integration, agent, or system that performed an action.

type
string

The kind of actor. The possible values are: user, service_api_key, workflow, integration, agent, system.

Exampleuser
email
string

The user's email address. Set when type is user.

Exampledana@example.com
name
string

The user's full name, the API key name, the workflow name or the integration type, when known.

ExampleDana Levi
id
string

The API key client ID, the workflow ID, the integration ID or the agent ID, when applicable.

url
string

A link that opens the dashboard in Torq.

Examplehttps://app.torq.io/v3/dashboards/0f8fad5b-d9cb-469f-a165-70867728950e?account=my-account
next_page_token
string

When a token is returned it indicates there is another page of results to retrieve. Pass this token in the page_token parameter in a subsequent List dashboards request to retrieve the next page of results. If this field is not returned, there are no additional pages to retrieve.

401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object