VEvectorize
Memory

List observation scopes

Changed on

Enumerate the distinct scopes across a bank's observations. Each observation lives under a scope: the exact set of tags it was consolidated with. Returns every distinct scope (tag order normalized) with the number of observations in it; the empty tag list is the global/untagged scope. Use a returned scope with the graph endpoint (tags=<scope> & tags_match=exact) to filter observations to exactly that scope. Paged: total reports every distinct scope in the bank.

get/v1/default/banks/{bank_id}/observations/scopes

Request

Path parameters

bank_idstring required

Query parameters

limitinteger

Maximum number of scopes to return

offsetinteger

Offset for pagination

Headers

authorizationstring nullable

Response

Successful Response

totalinteger required

Total number of distinct scopes in the bank (ignores limit/offset)

limitinteger required

Maximum number of scopes returned in this page

offsetinteger required

Offset this page started at

Example response

{
  "limit": 100,
  "offset": 0,
  "scopes": [
    {
      "count": 12,
      "tags": [
        "user:alice"
      ]
    },
    {
      "count": 4,
      "tags": [
        "user:alice",
        "project:apollo"
      ]
    },
    {
      "count": 2,
      "tags": []
    }
  ],
  "total": 3
}

Changes