Skip to main content
GET
List dashboard views
Required scope: dashboards:read Use this to look up a view’s id. For example, find the view named “Weekly exec”, then pass its id to Get a dashboard view or Duplicate a dashboard view.
  • Each entry has only id, name, and order. Fetch the configuration with Get a dashboard view.
  • type defaults to view, the KPI dashboard. Pass attribution_view or pnl_view to list those dashboards instead. Any other value returns 400.
  • Every view of that type comes back in one response. There’s no pagination.
  • The list isn’t sorted. Sort by order yourself if you need a stable order.
  • Only views on the pixel in the x-pixel-id header are listed.

Authorizations

x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

x-pixel-id
string
header
required

The pixel id the request targets.

Query Parameters

type
enum<string>

Which dashboard's views to list. Defaults to view. Type of dashboard view.

  • view: the regular KPI dashboard.
  • attribution_view: the attribution dashboard.
  • pnl_view: the P&L dashboard.
Available options:
view,
attribution_view,
pnl_view

Response

List of view summaries.

dashboardViews
object[]
required

Every view of the requested type, unsorted.