---
title: "Get field metadata"
method: GET
path: "/v1/data/demographics/fields/{api_path}"
tags: ["Demographics"]
---

# Get field metadata

`GET /v1/data/demographics/fields/{api_path}`

## Request

- Base URL: `https://api.mapulus.com`
- URL: `https://api.mapulus.com/v1/data/demographics/fields/{api_path}`
- Auth: HTTP bearer

Get detailed metadata for a single field, including related fields.

**Field types:**

- **Count fields** (`unit: "count"`) — raw census counts (e.g. `summary.population.persons`).
  Use directly with `?fields=` on the demographics endpoint.
- **Median fields** (`unit: "years"`, `"dollars_weekly"`, etc.) — pre-computed medians
  from the ABS (e.g. `medians.age`, `medians.personal_income_weekly`).
- **Derived percentage fields** (`unit: "percentage"`, `is_derived: true`) — computed at
  query time as `(numerator / denominator) * 100`. Request with `?fields=derived.pct_indigenous`.
  Returns a value between 0 and 100. 63 static fields covering population, age brackets,
  housing, employment, qualifications, and more.
  Use `GET /v1/data/demographics/derived` to list all available fields with labels.

**Dimensions:**

Fields with `dimensions` like `{"sex": "female", "age_min": 25, "age_max": 34}` are
used by segment queries. Add `&sex=female&age_min=25&age_max=34` to a demographics
request to get a cross-tab breakdown filtered to that segment.

**Mixing field types:**

You can request regular counts, medians, and derived percentages together:
```
?fields=summary.population.persons,medians.age,derived.pct_indigenous
```

## Path parameters

- `api_path` string, required: Full API path (e.g. `summary.population.persons`)

## Response `200`

Field metadata with related fields.

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mapulus/apis/mapulus-api.md) · [All operations](https://skmtc.dev/mapulus/apis/mapulus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mapulus/apis/mapulus-api/revisions/b99766fa053f?raw)