Перейти к содержимому
Разделы: Значения фильтров

Значения и статистика

Значения фильтров

GET/v1.3/filters

Какие жанры, страны, площадки, метки и компании есть в базе и сколько у каждого тайтлов — для выпадающих списков.

Значения для фильтров каталога и число тайтлов у каждого, от большего к меньшему. Отсюда берутся пункты выпадающих списков и подсказки при вводе.

Строка фасета везде одна: value — ровно то, что передаётся в фильтр, подписи label_ru и label_en, число тайтлов count. У меток к ним добавляется kind, у площадок — country и poster_url.

фасетфильтр каталога
genresgenre
countriescountry
regionsregion
kindskind
platformsplatform
tagstag
companiescompanies

В каждом фасете по умолчанию 50 первых значений, а {фасет}_total говорит, сколько их всего. facet оставляет нужные фасеты, limit меняет предел, limit=0 снимает его. q ищет по подписям на обоих языках, а у меток и компаний — по всему словарю, а не только по показанным: q=steampunk находит метку «Стимпанк» по английской подписи, q=A24 — студию A24, q=США — площадки США. Компаний в ответе не больше 5 000 даже с limit=0, полное число — в companies_total.

presets раскрывает пресеты в обычные фильтры — их можно взять за основу и поменять.

Параметры запроса

  • facetcsv

    Какие фасеты вернуть, через запятую. country_decades — число тайтлов каждой страны по десятилетиям — приходит, только если его назвать.

    genrescountrieskindsregionsplatformstagscompaniescountry_decades
    По умолчанию:

    все, кроме country_decades

    Пример: facet=genres,countries
  • qstring

    Оставить значения, в подписи которых есть эта строка, на любом языке: q=net находит Netflix. У меток и компаний ищет по всему словарю.

    Пример: q=net
  • limitinteger

    Сколько значений вернуть в каждом фасете. 0 — без предела.

    По умолчанию:

    50

    Пример: limit=0
  • langru | en

    Оставить в ответе один язык. Без него текстовые поля приходят парами _ru и _en. Подробнее — Языки ответа.

    Пример: lang=en

Поля ответа

  • {фасет}array

    Значения фасета: genres, countries, kinds, regions, platforms, tags, companies.

    Показать 7 полей
    • valuestring

      Что передать в фильтр каталога: drama, us, netflix.

    • label_ru · label_enstring | null

      Подпись на русском и на английском.

    • countinteger

      Сколько тайтлов с этим значением.

    • kindenum

      Только у меток: поджанр, ключевое слово или настроение — набор tag_kinds.

    • country · poster_urlstring | null

      Только у площадок: страна кодом ISO 3166-1 («ABC» — us) и логотип.

  • {фасет}_totalinteger

    Сколько значений в фасете с учётом q, до предела limit.

  • year_rangeobject

    Самый ранний и самый поздний год в базе: min, max.

  • presetsarray

    Пресеты каталога — та же строка, что в наборе presets в /enums (value, label_ru, label_en), и filters: во что пресет раскрывается.

  • country_decadesarray

    Только по запросу: строка как у стран и decades — число тайтлов по десятилетиям, decade и count.

Ошибки

статускодкогда
400invalid_request

Неизвестный фасет в facet — в ответе список допустимых; limit не целое от 0; параметр, которого фасеты не понимают (например, genre), — в ответе список допустимых.

401unauthorized

Нет заголовка X-API-Key, ключ неизвестен или отозван.

429rate_limited

Исчерпан предел в секунду или квота на сутки.

Все коды и что с ними делать — на странице Ошибки.

Esc

Загружаем оглавление…

    ↑ ↓ выбратьEnter открытьEsc закрыть