---
title: "Query area metrics"
method: POST
path: "/api/analytics/query/area/{areaId}"
tags: ["analytics"]
---

# Query area metrics

`POST /api/analytics/query/area/{areaId}`

## Request

- Base URL: `https://codescene.io` (the document declares no server; this is the origin it was published from)
- URL: `https://codescene.io/api/analytics/query/area/{areaId}`
- Auth: none declared

## Path parameters

- `areaId` integer, required

## Request body

- object
  - `startDate` string, date-time
  - `endDate` string, date-time

## Response `200`

- object
  - `type` 'area', required
  - `areaId` integer, required
  - `name` string, required
  - `metrics` object, required
  - `children` object, required
    - `items` union[], required
      - union
        - object
          - `type` 'area', required
          - `areaId` integer, required
          - `name` string, required
          - `metrics` object, required
        - object
          - `type` 'analytical-unit', required
          - `analyticalUnitId` integer, required
          - `name` string, required
          - `metrics` object, required
          - `archivedAt` string

## Other responses

- `400`
- `401`
- `403`
- `404`

---

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