Перейти к основному содержимому

/3.0/dashboard/geo/items

API docs by Redocly

Дашборд (3.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Дашборд

Получение геообъектов для дашборда

Метод получения объектов для Dashboard-Detector.
Логику работы метода и формулы для использования коэффициентов можно посмотреть в документации.

query Parameters
key
required
string

Уникальный ключ пользователя API.

geometry
required
string
Example: geometry=POLYGON((82.91259527206421 55.0614369017519,82.90572881698608 55.05902823221974,82.91521310806274 55.05580825372468))

Произвольная геометрия в формате WKT.

zoom_level
required
integer [ 1 .. 19 ]

Текущий уровень масштабирования для предварительного отсечения множества объектов.
В случае если zoom_level >= 12, то можно получить следующие типы:
• adm_div.region, adm_div.district_area, adm_div.city, project и adm_div.settlement.
В случае если zoom_level < 12, то можно получить следующие типы:
• adm_div.region, adm_div.district_area, adm_div.city и project.

k_area
required
number <float>

Коэффициент влияния площади пересечения объектов.
Принимает значения от 0 до 1. Сумма значений перечисленных коэффициентов равна 1.

k_distance
required
number <float>

Коэффициент влияния дистанции от центра viewpoint до объекта.
Принимает значения от 0 до 1. Сумма значений перечисленных коэффициентов равна 1.

k_branches
required
number <float>

Коэффициент влияния количества филиалов.
Принимает значения от 0 до 1. Сумма значений перечисленных коэффициентов равна 1.

k_from_region
required
number <float>

Коэффициент влияния региона на определение объекта.
Принимает значения от 0 до 1. Сумма значений перечисленных коэффициентов равна 1.

min_percent_intersection_of_screen
required
number
Default: 5

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

distance_to_field
string
Default: "centroid"

Способ подсчета дистанции.
Возможные значения:

  • centroid — до центра объекта;
  • simp_geometry — до границы объекта;
  • board — алиас simp_geometry.

limit
integer >= 1
Default: 1

Максимальное количество результатов в выдаче.

Responses

Response Schema: application/json
required
object (ObjMeta)

Метаданные ответа

required
object

Основной результат

Response samples

Content type
application/json
{
  • "meta": {
    • "issue_date": "string",
    • "code": 200,
    • "api_version": "dev"
    },
  • "result": {
    • "total": 1,
    • "items": [
      ],
    • "overlap_region_id": "string",
    • "overlap_region_alias": "string"
    }
}