/3.0/dashboard/geo/items

• Dashboard
  • getGetting map objects for the dashboard

API docs by Redocly

Dashboard (3.0)

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

Dashboard

Getting map objects for the dashboard

The way of obtaining objects for Dashboard-Detector.
You can find out how it works and see the formulas for the use of the factors in the documentation.

query Parameters

key required	string Unique key of API user.
geometry required	string Example: geometry=POLYGON((82.91259527206421 55.0614369017519,82.90572881698608 55.05902823221974,82.91521310806274 55.05580825372468)) An arbitrary geometry in WKT format.
zoom_level required	integer [ 1 .. 19 ] The current zoom level for pre-cutting of the multiple objects. If zoom_level >= 12, you can get the following types: • adm_div.region, adm_div.district_area, adm_div.city, project, and adm_div.settlement. If zoom_level < 12, you can get the following types: • adm_div.region, adm_div.district_area, adm_div.city, and project.
k_area required	number <float> Influence factor of the area of object intersection. Takes the values from 0 to 1. The sum of the values of the listed factors is equal to 1.
k_distance required	number <float> Influence factor of the distance from the center of viewpoint to the object. Takes the values from 0 to 1. The sum of the values of the listed factors is equal to 1.
k_branches required	number <float> Influence factor of the number of branches. Takes the values from 0 to 1. The sum of the values of the listed factors is equal to 1.
k_from_region required	number <float> Influence factor of the region to the object determination. Takes the values from 0 to 1. The sum of the values of the listed factors is equal to 1.
min_percent_intersection_of_screen required	number Default: 5 A value at which the objects that have the relation of their area to the area of the passed geometry less or equal should be cut out.
distance_to_field	string Default: "centroid" The method of calculating the distance. Possible values: centroid — to the center of the object; simp_geometry — to the object border; board — alias of simp_geometry.
limit	integer >= 1 Default: 1 The maximum number of results in the list.

Responses

Response Schema: application/json

required	object (ObjMeta) Response metadata
required	object Main result

https://catalog.api.2gis.com/3.0/dashboard/geo/items

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "meta": {

  • "code": 200,
  • "api_version": "dev",
  • "issue_date": "string"

  },
• "result": {

  • "items": [

    • {

      • "id": "123456",
      • "type": "adm_div.region",
      • "region_id": "123456",
      • "segment_id": "123456",
      • "overlap_region_id": "123456",
      • "allow_change_domain": true,
      • "region_alias": "string",
      • "name": "Novosibirsk",
      • "overlap_region_alias": "string",
      • "country_code": "ru",
      • "adm_div": [

        • {

          • "id": "123456",
          • "type": "city",
          • "flags": {

            • "has_avg_bill": { },
            • "is_default": true,
            • "has_model": { },
            • "photos": true,
            • "is_region_center": true,
            • "is_district_area_center": true,
            • "temporary_closed_parameters": [

              • {

                • "type": "string",
                • "name": "string",
                • "value": "string"

                }

              ],
            • "badges": [

              • {

                • "type": "string",
                • "text": "string",
                • "collection_uid": "string"

                }

              ],
            • "temporary_closed": "string"

            },
          • "city_alias": "novosibirsk",
          • "detailed_subtype": "poselok",
          • "caption": "string",
          • "name": "Ust-Kamenogorsk",
          • "is_default": true

          }

        ],
      • "segment_alias": "string"

      }

    ],
  • "overlap_region_id": "string",
  • "overlap_region_alias": "string",
  • "total": 1

  }

}