---
title: "Aggregate dataset coverage snapshot"
method: GET
path: "/api/v1/dashboard/coverage"
tags: ["Dashboard"]
---

# Aggregate dataset coverage snapshot

`GET /api/v1/dashboard/coverage`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/dashboard/coverage`
- Auth: HTTP bearer

Aggregate snapshot of the served corpus: entity / filing totals, filings by source, supported taxonomies, fiscal-year range, and entity counts for the countries covered in full. Useful to calibrate questions (e.g. don't expect FY2010 data if coverage starts in 2018).

Aggregate counts only. A Free key is enough; cached server-side (~1h).

## Response `200`

Dataset coverage snapshot.

- ApiResponseDatasetCoverage
  - `success` boolean, required
  - `data` DatasetCoverage: Aggregate snapshot of the served dataset. Pure aggregate counts (entities/filings/sources/ countries + fiscal-year range): no per-entity provenance, no mapping.
    - `version` string
    - `total_entities` integer, required
    - `covered_entities` integer, nullable
    - `total_filings` integer, required
    - `sources` CoverageSource[]
      - `source` string, required
      - `filing_count` integer, required
    - `taxonomies` string[]
    - `fiscal_year_range` FiscalYearRange
      - `min` integer, nullable
      - `max` integer, nullable
    - `coverage_by_country` CoverageCountry[]
      - `country` string, required
      - `entity_count` integer, required
    - `notes` string[]
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

---

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