Skip to content
Registry StackDocsLatest
Search

Get aggregate structure

GET
/v1/datasets/{dataset_id}/aggregates/{aggregate_id}/structure
curl --request GET \
  --url https://data.example.test/v1/datasets/example/aggregates/example/structure \
  --header 'Authorization: Bearer <token>'

Returns descriptive structure for one aggregate: group-by dimensions, measures, disclosure-control policy, optional temporal field, and links.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
aggregate_id
required
string

Aggregate identifier

dataset_id
required
string

Dataset identifier

Responses

Section titled “Responses”

200

Section titled “200”

Aggregate structure descriptor.

Media typeapplication/json
object
aggregate_id
required
string
default_group_by
Array<string>
description
required
string
dimensions
required
Array<object>
object
codelist
string | null format: uri
field
required
string
id
required
string
label
required
string
disclosure_control
object
method
required
Array<string>
min_cell_size
required
integer
>= 1
query_budget
required
object
scope
required
string
tracked
required
boolean
key
additional properties
any
suppressed_observations
required
integer | null
suppression
required
string
Allowed values: omit mask null
key
additional properties
any
edr_collection_id
string | null
links
Array<object>
object
href
required
string
rel
required
string
type
string
key
additional properties
any
measures
required
Array<object>
object
aggregation_method
required
string
column
required
string
decimals
integer | null
definition_uri
string | null format: uri
frequency
string | null
id
required
string
label
required
string
unit_measure
required
string
unit_multiplier
number | null
min_cell_size
integer
>= 1
source_entity
string
temporal_field
string | null
title
required
string
Example
{
  "disclosure_control": {
    "suppression": "omit"
  }
}

401

Section titled “401”

Missing or invalid bearer credential.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

403

Section titled “403”

Authenticated principal lacks the scope required for this operation.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

404

Section titled “404”

Aggregate definition not found for this dataset.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

default

Section titled “default”

Problem Details error response.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}