Reference
Install settings
The install settings an admin can change, and where.
An install has two kinds of settings: those an Admin changes while GOAT runs, through the settings API, and those chosen when GOAT is installed. The app has no screen for either at this release.
Settings an Admin changes
Read them with GET /v5/admin/settings, with any operator's sign-in token. Change them with PATCH /v5/admin/settings, with an Admin's. The app does not yet give a way to get that token, and these docs do not yet cover it. See Tenants and access.
PATCH https://analytics.example.com/v5/admin/settings
Authorization: Bearer <an admin's own sign-in token>
If-Match: <the ETag from the GET, if it returned one>
Content-Type: application/json
{ "embedOrigins": ["https://app.example.com"] }
Send only the fields you change. The answer is the settings as stored, with a new ETag.
| Field | Values | Default | What it does |
|---|---|---|---|
tenantProvisioning | "HOOK_ONLY" or "AUTO_ON_MINT" | "HOOK_ONLY" | Whether a token request for an unknown tenant registers it. See Tenants and access. |
publishAutoGrant | "all" or "none" | "all" | Whether a dashboard's first publish, at Visible or Customizable, gives every tenant access. With "none", access is granted only by hand. |
embedOrigins | A list of exact sites, such as "https://app.example.com" | Empty: any site | The sites allowed to show embedded dashboards. A page elsewhere gets 403 ORIGIN_DENIED. [] clears the list. See below. |
rows | { "tenants": true or false, "operatorViewers": true or false } | Both on | Whether your customers' viewers, and operators with the viewer role, can see and download the rows behind charts. Authors always can. |
snapshotRetention | 1 or more | 10 | How many saved versions of each dashboard are kept, beside pinned ones. |
pinnedSnapshotRetention | 0 or more; 0 for the default | 10 | How many pinned versions each dashboard keeps. |
tenantAuthoringEnabled | true or false | true | Whether new tenant-author tokens, for your customers' own authors, are issued, and whether existing ones can author and run queries. Turning it off takes effect within a minute; their filter value lists keep working until the token expires. The embed script cannot use them yet. See Tenant-author tokens. |
defaultSchemeId | A theme's id, or "" to clear | None | Stored, but has no effect at this release. A dashboard with no theme of its own follows the viewer's light or dark mode. See Themes. |
The GET answer also holds originRestriction ("not configured", or how many sites are listed) and mechanisms, which says whether uploads and bucket browsing are available on the install.
Allowed sites
Each entry is a scheme and host, with a port only if it is not the usual one: https://app.example.com, http://localhost:8080. No paths, no wildcards, no trailing slash, and the host in lowercase. Up to 50 entries of up to 64 characters each. Requests with no site, such as from a server, are not affected. A change reaches viewers within a minute.
Errors
| Status and code | What it means |
|---|---|
403 ADMIN_REQUIRED | Only an Admin can change settings. |
422 INVALID | A field's value is not allowed. The message says which. |
409 CONFLICT | The settings changed since your GET. Read them again and resend. |
400 BAD_IF_MATCH | The If-Match header is not a version number. |
Fields GOAT does not know are ignored, so check the spelling of each name.
Settings chosen at install
Whoever installs GOAT sets these. Changing one later means applying the install again.
| Setting | Default | What it sets |
|---|---|---|
Install name (prefix) | goat | Part of every resource's name. |
| Region | us-central1 | Where Firestore, Cloud Run, and BigQuery data live. |
Public address (public_origin) | The Cloud Run address | The one address browsers use for the app and the embed script. |
Extra upload sites (upload_origins) | None | Sites besides the public address allowed to upload files. |
Cost cap per query (query_max_bytes_billed) | 10 GiB | The most a query may bill before it fails. Datasets can set their own. See Costs. |
Instances (min_instances, max_instances) | 1 and 10 | How many copies of the service run. |
Size (cpu, memory) | 1 CPU, 512 MiB | Each instance's size. |
Sign-in providers (sso_providers) | None: password only | Google sign-in, its Workspace domains, and who may sign in with which role. |
Network (ingress_mode) | All traffic | Whether the service also accepts traffic from anywhere, or only through your own load balancer. |
Encryption key (cmek_key) | Google-managed | Your own Cloud KMS key, chosen only at install. |
Billing export (billing_export_table) | None | A billing export table, so cost figures show actual amounts. |