Skip to main content

Reference

API

The GOAT API, endpoint by endpoint.

The full API reference is not published yet. Until it is, the guides document each call a reader needs, with its request, its answer, and its errors:

TaskCallsPage
Get a viewer tokenPOST /v5/tokens/embedViewer tokens
Register and manage tenants/v5/admin/tenants, /v5/admin/tenants/register, /v5/admin/tenants/syncTenants and access
Grant or deny access to a dashboard/v5/admin/grantsGrant access to dashboards
Change install settingsGET and PATCH /v5/admin/settingsInstall settings
Send rows from your applicationPOST /v5/dataload/datasets/{id}/ingestPush data from your application

How calls are authenticated​

CallsSend
POST /v5/tokens/embed and the push APIAn API key, in the X-Api-Key header. See API keys.
/v5/admin/...A person's own sign-in token, as Authorization: Bearer. An admin's or an author's, as each page says. The app does not yet give a way to get that token, and these docs do not yet cover it.
What the embedded dashboard callsThe viewer token, as Authorization: Bearer. The embed script sends it for you.

Every address starts with your install's address, such as https://analytics.example.com. Errors answer with a JSON body holding a code and a message; see Errors.

GOAT documentation

Type to search.