GOAT documentation
Embedded analytics on Google Cloud
GOAT documentation
GOAT puts dashboards inside your product. Your data stays in your own Google Cloud project, and each of your customers sees only their own rows.
- New here? Start with What GOAT is and the Quickstart.
- Building dashboards, embedding them or running GOAT? Pick your guide from the sidebar.
- Want to know how it works on Google Cloud? See Under the hood.
Get started
4 pages
Build dashboards
13 pages
- Build dashboardsThe path from data to a published dashboard.
- Connect and upload dataCreate a dataset from BigQuery, Cloud Storage, a file, or your application.
- Push data from your applicationA dataset your application fills by sending rows to GOAT.
- After a dataset is createdFollow a load, reload, add data, and find your way around a dataset's page.
- Prepare columnsHide, classify, and group a dataset's columns.
- CollectionsGroup dashboards with the datasets they use.
- Build a dashboardLay out charts, text, filters, and other elements on the canvas.
- Create chartsThe ways to add a chart, and the Chart Builder.
- Chart actionsWhat viewers can do when they click a chart.
- Chart typesEach chart type, when to use it, and what it needs.
- Dashboard filtersLet viewers narrow what the charts show.
- ThemesChoose and edit the colors and type a dashboard wears.
- Publish and sharePublish a dashboard, choose which customers can see it, and get the snippet to embed it.
Embed in your product
8 pages
- Embed in your productWhat your application does, and what GOAT does.
- Embed a dashboardPut a published dashboard on a page of your application.
- Viewer tokensHow your backend asks GOAT for a token for each viewer.
- Tenants and accessRegister your customers and decide what each one sees.
- Grant access to dashboardsGive one tenant access to a dashboard, keep one out, or give access by attribute.
- Embed optionsThemes, initial filters, and turning actions off.
- Content Security PolicyWhat your page's security policy must allow.
- Get an operator tokenHow to get a sign-in token for a one-time call to the tenant API.
Run GOAT
7 pages
- Run GOATWhat an install is and who looks after it.
- Install GOATPut GOAT into your Google Cloud project.
- Operators and sign-inWho can sign in to build, and how.
- API keysThe keys your backend uses to call GOAT.
- Give GOAT access to your dataLet GOAT read the BigQuery data and files you choose.
- CostsWhat an install costs to run, and the limits that cap it.
- UpgradesTaking a new release.
Reference
5 pages
- APIThe GOAT API, endpoint by endpoint.
- Embed SDKThe embed script's elements, options, and methods.
- Install settingsThe install settings an admin can change, and where.
- ErrorsEach error code a developer can meet, what it means, and what to do.
- LimitsToken lifetimes, request ceilings, cost caps, and sizes, and which ones an install can change.
Help for your users
1 page
Under the hood
7 pages
- Under the hoodHow GOAT works on Google Cloud, for readers who want the detail.
- Architecture on Google CloudThe services an install runs and what each one does.
- How queries run and what they costFrom a chart on screen to a BigQuery job and its bill.
- How data loadsWhat happens when a dataset loads or reloads.
- PerformanceCaching, limits, and how to keep dashboards fast.
- Security modelHow GOAT keeps each customer to their own rows.
- Tenant-author tokensThe second kind of embed token, for your customers' own authors, and what keeps it in bounds.
Releases
What changed in each release.