---
title: "Retrieve item field statistics"
method: GET
path: "/v1/items_fields_stats"
tags: ["Item statistics"]
---

# Retrieve item field statistics

`GET /v1/items_fields_stats`

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `catalog(r)`.

Retrieve a list of statistics for all fields (such as `brand` or `size`).

## Query parameters

- `key` string, required — The key of the index to use.
- `section` string — The section of the index to use. Defaults to `Products`.
- `filters` ItemFieldFilters
  - `name` string — The item field name on which stats are computed
- `num_results_per_page` integer — The number of results per page to return.
- `page` integer — The page of results to return.
- `offset` integer — The number of results to skip from the beginning. Cannot be used together with `page`.
- `sort_by` 'name' | 'percentage_presence' — The item field name to sort results by.
- `sort_order` 'ascending' | 'descending'

## Response `200`

OK

- ItemFieldStatsListGetResponse
  - `items_fields_stats` ItemFieldStatsResponse[], required
    - `name` string, required — The item field name on which stats are computed
    - `percentage_presence` number — Percentage presence
    - `type` 'number' | 'string' | 'array' | 'object' | 'boolean' | 'mixed'
    - `example_items` string[]
    - `created_at` string, date-time, required — Item field stats creation date and time
    - `updated_at` string, date-time — Item field stats last update date and time
  - `total_count` integer, required — Number of item field stats

## Other responses

- `400` — Validation Error
- `401` — Credentials are not passed or action is forbidden.
- `403` — The supplied token does not have the required permissions.
- `404` — Not Found
- `429` — Rate limit breached

---

[API](https://skmtc.dev/constructor/apis/autocomplete.md) · [All operations](https://skmtc.dev/constructor/apis/autocomplete/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/constructor/autocomplete/revisions/2d33330633b6/schema)
