Gamma API

Dashboards and widgets

Build your own charts, numbers and lists from the platform's metrics, and arrange them on your home page, a project, an organization or the admin panel.

A dashboard is a page of widgets: a number, a chart, a table or a list, each worked out live from the data you are allowed to see. Every dashboard starts with a set of widgets chosen for it, and whoever may change it can add, edit, resize, move and remove them without writing anything.

Where the dashboards are

DashboardWhereWho sees itWho changes it
Daily focusThe first tab of your home pageYouYou
Project DashboardA project's Monitoring → DashboardWhoever manages the projectThe same
Issues → ChartsA project's Issues → ChartsWhoever may read the project's issuesWhoever manages the project
InsightsAn organization's InsightsOrganization owners, security admins and adminsThe same
Admin dashboardAdmin → DashboardPlatform adminsThe same

Each one is shared by everyone who sees it, except Daily focus, which is yours alone. If you can see a dashboard but not change it, the Add widget button, the ⋯ menu and the drag handles are not there.

What a widget shows

A widget reads one metric, such as Open issues, Storage used or Sign-ups, and you decide how to cut it:

  • Calculation: count, sum, average, minimum, maximum, distinct (each person or record once) or percent (each group's share of the total). A metric offers only the calculations that make sense for it.
  • Grouping: up to two dimensions, for example by project, by status, or over time, then by assignee.
  • Period and granularity: the last 7, 30 or 90 days, 12 months, 5 years, everything, or dates of your own; grouped by day, week, month, quarter or year.
  • Filters: up to five, for example only one project or only overdue items.
  • Sort and top N: largest first, A to Z, or only the largest ten.
  • Chart type and size (see below), and an optional title. Without a title the widget names itself from its metric and grouping, for example Project changes · Person, in each reader's language.

Metrics come in two kinds:

  • Now: the state as it is, such as Open issues or Storage used. These cannot be drawn over time, because a count of what exists today says nothing about last month.
  • Over time: something with a date, such as Issues created, Sign-ups or Storage growth.

History starts when it was first recorded

Storage growth is read from a daily snapshot and Active users from a record of the days people use the app. Both start on the day they were first recorded, and the widget says Data from that date. Nothing earlier is estimated.

Add or change a widget

Choose Add widget, or ⋯ → Edit on a widget.
Pick a Metric. They are grouped by area: projects, users, security and infrastructure. Each has a short description of what it counts.
Choose the calculation, the grouping, the period and any filters. The preview in the panel updates as you change them.
Pick the chart type. Only the types that fit your grouping are offered, and the panel switches to a fitting one by itself when you change the grouping.
Optionally give it a Title, a Width and a Height, then Save.

If something does not fit, for example a period too long for daily points, the panel says why and Save stays off until you fix it.

Chart types

TypeFits
NumberNo grouping: one figure
Line, AreaOver time, optionally split by a second dimension
BarOne grouping: over time or by a category
Stacked barTwo groupings, the second stacked: by category, or over time then a category
Pie, DonutOne grouping that is not time
TableAnything
ListThe rows of a list metric (below)

Groups past the eighth are drawn as Other where adding them up makes sense. Issue statuses keep the colours the project gave them.

Combine several metrics

Add metric puts up to three more metrics on the same widget, each with its own calculation, filters and legend name:

  • Several numbers on one card: any metrics, each in its own unit, for example users next to megabytes.
  • Several series over time: a line, area or bar grouped by time alone, with every metric in the same unit, for example sign-ups and deleted accounts.
  • A table of either.

Pie, donut, stacked bar and list cannot be combined.

Lists

Some metrics are lists of things rather than numbers: Assigned to me, Waiting on others, My recent activity and Projects. A list widget shows their rows with fixed columns, sorted by the column you choose, a page at a time with Show more. Selecting a row opens the issue, form or project.

Arrange a dashboard

  • Size: each widget takes a third, half, two thirds or the full width of a row on a wide screen, and is short, normal or tall. Set it in the widget's panel or with ⋯ → Size. On a phone every widget takes the full width.
  • Move: drag a widget by its title onto another one, or onto empty space in a row. Or focus its handle (⠿) and press Alt+↑ / Alt+↓, or use ⋯ → Move up / Move down on a touch screen. A widget dropped where it does not fit goes to the next row: the dashboard is an order, not a free canvas.

Dashboard filters and the period switch

Some dashboards have filters and a Day · Month · Year switch at the top.

  • Each widget's own (the default) shows every widget with its own period.
  • Day, Month or Year shows every widget over the last 30 days, 12 months or 5 years instead, without changing what is saved.
  • A dashboard filter, such as the organization on the admin dashboard or the project on Daily focus, applies to every widget that can be filtered that way. The others ignore it.

What you see is what you may see

Every number, list, label and colour is worked out only from the records you are allowed to see. If your permission profile is set to Own company only, a widget counts only your company's issues and forms, plus those assigned to you; if your profile does not let you read forms, form metrics are not offered to you at all. Two people looking at the same widget can therefore see different numbers.

Daily focus

Your home page opens on Daily focus, your own dashboard across every project you can open. Above it, the line under the greeting sums up what waits on you today, for example 3 overdue · 5 due within 7 days · 2 forms to approve. Select a part to see Daily focus filtered to it. The Filters button narrows the whole dashboard by project, due date and type.

It starts with what is assigned to you by due date, the list of those items, what waits on others because of you, and your recent activity.

Metrics

MetricKindWhere it is offered
Project changesOver timeDaily focus, project, organization, admin
Open issuesNowDaily focus, project, organization, admin
IssuesNowProject, Issues → Charts, organization, admin
Issues createdOver timeProject, Issues → Charts, organization, admin
Issues dueOver time, dates ahead includedProject, Issues → Charts, organization, admin
Issue completionNowProject, organization, admin
FormsNowDaily focus, project, organization, admin
Model versions uploaded, Templates publishedOver timeProject, organization, admin
Storage used, Files storedNowProject, organization, admin
Storage growthOver time, from daily snapshotsProject, organization, admin
Failed jobsOver timeProject, organization, admin
Jobs waitingNowProject, organization, admin
Active usersOver time, recorded per dayProject, organization, admin
MembersNowProject, organization, admin
Members joinedOver timeOrganization, admin
Users, Pending invitationsNowOrganization, admin
Account hygiene, Compromised passwordsNowOrganization, admin
Security eventsOver timeOrganization, admin
Sign-ups, Deleted accounts, Net user growthOver timeAdmin
Workers online, Failed notificationsNowAdmin
Assigned to me, Waiting on others, My recent activity, My work by due dateList or nowDaily focus
ProjectsListOrganization, admin

Issue metrics need Issues at View or above in the project, and form metrics Forms at View or above. Issues → Charts offers only the issue metrics.

Good to know

  • Times are cut in UTC: a "day" runs from midnight to midnight UTC.
  • Active users counts the people who made any request in the app that day; API keys do not count.
  • Compromised passwords counts accounts whose password was found in a known data breach when they signed in, until they change it. Only the first five characters of the password's hash ever leave the platform for that check, and nobody can see whose password it was.
  • Charts are drawn in your Chart colours, set under your account: colour-blind safe by default, high contrast, or the classic colours.

On this page