API reference

Errors

The error shape and what each status code means.

Error shape#

Every non-2xx response has the same shape. The message names the problem.

Error response

{
  "error": "unknown metric 'total_spnd' — define it first (metric-definitions)"
}

Status	Meaning
`401`	Missing or invalid token
`403`	Valid token, wrong scope: another tenant or workspace, or a write with a workspace token
`404`	No such resource (profile, segment, identifier)
`409`	Already exists, and this resource is create-only (metric claims, segments, workspaces)
`422`	The body failed validation; the message says exactly why
`503`	A backing store is temporarily unavailable; retry