Skip to content
Registry StackDocsDocumentation preview
Search

List dataset aggregates

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

Lists dataset-scoped analytical aggregates defined for social_registry.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
dataset_id
required
string

Dataset identifier

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
data
required
Array<object>
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
links
required
Array<object>
object
href
required
string
rel
required
string
type
string
key
additional properties
any
Example
{
  "data": [
    {
      "aggregate_id": "households_by_region",
      "default_group_by": [
        "region"
      ],
      "description": "Household count by region",
      "dimensions": [
        {
          "field": "region",
          "id": "region",
          "label": "Region"
        }
      ],
      "disclosure_control": {
        "method": [
          "k-anonymity"
        ],
        "min_cell_size": 2,
        "query_budget": {
          "scope": "none",
          "tracked": false
        },
        "suppressed_observations": null,
        "suppression": "omit"
      },
      "links": [],
      "measures": [
        {
          "aggregation_method": "count",
          "column": "id",
          "id": "household_count",
          "label": "Households",
          "unit_measure": "households"
        }
      ],
      "source_entity": "household",
      "temporal_field": null,
      "title": "Households by region"
    }
  ],
  "links": []
}

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://id.registrystack.org/problems/registry-relay/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://id.registrystack.org/problems/registry-relay/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://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}