Skip to main content

Get started

Key concepts

Datasets, tenants, collections, dashboards, publishing, and embedding, in brief.

This page explains the ideas you need before the Quickstart. Each one has its own page later.

The path from data to an embedded dashboard​

Dataset​

A dataset is a table of data GOAT can query. It comes from a BigQuery table or view, files in Cloud Storage, a file you upload, or rows your application sends. GOAT either reads the data where it is (Live connect) or keeps its own copy in your project (Managed copy).

See Connect and upload data.

Tenant and tenant key​

A tenant is one of your customers. A dataset's tenant key is the column that says which tenant each row belongs to.

When someone at a tenant looks at a dashboard, every chart shows only that tenant's rows. They cannot remove or change that limit.

A dataset with no tenant key is shared, and every tenant sees all of its rows. Use a shared dataset only for data that does not belong to a customer.

See Tenants and access.

Collection​

A collection groups dashboards and the datasets they use. It also holds defaults for the dashboards created in it, such as who can see them. A dashboard belongs to one collection; a dataset can be attached to several.

See Collections.

Dashboard and chart​

A dashboard is a canvas you lay out with charts, text, filters, buttons, images, and shapes, organized in tabs if you want them. A chart is a saved visualization of one question about one dataset, such as "sales by region".

See Build a dashboard and Create charts.

Publishing and access​

A dashboard you are building is visible only to people who build in GOAT. Publishing makes the current version available to embed. The dashboard's tenant access level decides whether tenants can reach it.

LevelWhat it means
VisibleYour customers can open it.
CustomizableFor your viewers, the same as Visible.
NoneNo customer can open it.

The first publish gives every tenant access, unless the level is None. To give one tenant access or take it away, your developers call GOAT's API.

See Publish and share.

Embedding and viewer tokens​

To show a dashboard in your product, a developer adds a short snippet from GOAT to a page of your application. When someone opens that page, your application gets a viewer token from GOAT. The token is a short-lived pass that names the tenant, so GOAT knows whose rows to show.

See Embed a dashboard.

Who is who​

PersonWhat they do
AdminSigns in to GOAT, builds, and also manages API keys and who can sign in.
AuthorSigns in to GOAT and builds datasets, collections, and dashboards.
ViewerUses an embedded dashboard inside your product. Never signs in to GOAT.

Admins and authors together are called operators: the people who sign in to GOAT itself.

GOAT documentation

Type to search.