/3.0/profile/data

Personalized search history (3.0)

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

Profile

Getting a collection of objects

The answer returns:

history of search queries of the user;
history of selected objects from the results of autocomplete;
history of selected objects from the search results.

query Parameters

key required	string Unique key of API user.
locale	string Examples: locale=ar_AE - Arabic for the UAE locale=ru_RU - Russian for Russia The locale from which the search is performed and the results are given. List of available locales: `az_AZ` — Azerbaijani (Azerbaijan); `ru_AZ` — Russian (Azerbaijan); `hy_AM` — Armenian (Armenia); `ru_AM` — Russian (Armenia); `ar_BH` — Arabic (Bahrain); `en_BH` — English (Bahrain); `ru_BY` — Russian (Belarus); `ka_GE` — Georgian (Georgia); `ru_GE` — Russian (Georgia); `en_EG` — English (Egypt); `ar_EG` — Arabic (Egypt); `it_IT` — Italian (Italy); `en_IQ` — English (Iraq); `ar_IQ` — Arabic (Iraq); `kk_KZ` — Kazakh (Kazakhstan); `ru_KZ` — Russian (Kazakhstan); `en_QA` — English (Qatar); `ar_QA` — Arabic (Qatar); `en_CY` — English (Cyprus); `es_CL` — Spanish (Cyprus); `ky_KG` — Kyrgyz (Kyrgyzstan); `ru_KG` — Russian (Kyrgyzstan); `en_CN` — English (China); `zh_CN` — Chinese (China); `ru_CN` — Russian (China); `en_KW` — English (Kuwait); `ar_KW` — Arabic (Kuwait); `en_MA` — English (Morocco); `ar_MA` — Arabic (Morocco); `en_AE` — English (UAE); `ar_AE` — Arabic (UAE); `en_OM` — English (Oman); `ar_OM` — Arabic (Oman); `en_RU` — English (Russia); `ar_RU` — Arabic (Russia); `es_RU` — Spanish (Russia); `it_RU` — Italian (Russia); `ru_RU` — Russian (Russia); `uk_RU` — Ukrainian (Russia); `cs_RU` — Czech (Russia); `en_SA` — English (Saudi Arabia); `ar_SA` — Arabic (Saudi Arabia); `ru_TJ` — Russian (Tajikistan); `tg_TJ` — Tajik (Tajikistan); `ru_UZ` — Russian (Uzbekistan); `uz_UZ` — Uzbek (Uzbekistan); `ru_UA` — Russian (Ukraine); `uk_UA` — Ukrainian (Ukraine); `cs_CZ` — Czech (Czech Republic).
user_id	string non-empty The BSS ID of the user. Not required in case of passing auth_id and access_token.
auth_id	string non-empty The authorized user ID. Not required if user_id has been passed.
access_token	string non-empty Access token from the Auth service if the user is logged in. Not required in case of passing user_id.

Responses

Response Schema: application/json

required	object
required	object (ObjMeta) Response metadata

Response samples

Content type

application/json

{"result": {"last_objects": [{"id": "141265769336625",
"type": "string",
"ads": {"text": "Only here, only now",
"article": "<strong>Advertising article</strong><br/>Buy our elephants.",
"link": {"text": "Sale, find out more",
"value": "http://krutaya-kompanya.ru/sale?ref=2gis"
},
"options": {"erid": ["string"
],
"fmcg": [{"ads_id": "123456",
"hash": "string",
"images": [{"url": null
}
],
"org_id": "123456",
"actions": [{"type": null,
"value": null,
"name": null,
"platforms": [ ],
"caption": null
}
],
"text_warning": "string",
"logo": [{"bg_img_url": null,
"text_color": null,
"use_default_value": null,
"img_url": null,
"bg_color": null
}
],
"erid": ["string"
],
"goods_preview": [{"image_url": null
}
],
"text": "string",
"cta_list": true,
"branch_id": "123456",
"videos": [{"resources_description_url": null
}
]
}
],
"map_buy_here_owner": [{"map_icon": {"svg": "string"
},
"map_label": {"text": "string"
},
"ads_id": "123456",
"erid": ["string"
],
"legal_name": "string"
}
],
"images": [{"url": "string"
}
],
"logo": {"bg_img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"text_color": "#000000",
"use_default_value": true,
"img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"bg_color": "#FFFFFF"
},
"actions": [{"type": "string",
"value": "string",
"name": "string",
"platforms": ["string"
],
"caption": "string"
}
],
"buy_here_owner": [{"position": 1,
"owned_rubric_id": "123456",
"control_title": "string",
"erid": ["string"
],
"legal_name": "string"
}
],
"fmcg_owner": [{"legal_name": "string",
"ads_id": "123456",
"control_title": "string",
"erid": ["string"
]
}
],
"poi": {"legal_name": "string",
"erid": ["string"
],
"is_premium": true
},
"review": true,
"3d": true,
"organization_stories": {"discount": {"max_percent": 0,
"is_prime": true
}
},
"color": "#2B5C91",
"videos": [{"resources_description_url": "string"
}
],
"suggestor": {"erid": ["string"
],
"logo": {"img_url": "http://example.com"
},
"microcomment": {"text": "string"
},
"microcomment_warning": {"text": "string"
},
"ads_id": "123456",
"legal_name": "string"
},
"marker_logo": {"url": "string"
},
"buy_here": [{"ads_id": "123456",
"cta_list": true,
"title": "string",
"erid": ["string"
],
"videos": [{"resources_description_url": null
}
],
"owned_rubric_id": "123456",
"images": [{"url": null
}
],
"branch_id": "123456",
"ads_texts": {"text": "string",
"text_warning": "string"
},
"custom_title": "string",
"org_id": "123456",
"logo": {"bg_img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"text_color": "#000000",
"use_default_value": true,
"img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"bg_color": "#FFFFFF"
},
"is_primary": true,
"actions": [{"type": null,
"value": null,
"name": null,
"platforms": [ ],
"caption": null
}
],
"hash": "string"
}
],
"discount": true,
"legal_name": "string",
"branded_advertiser": true
},
"is_social": true,
"text_warning": "Smoking is bad for your health",
"article_warning": "Smoking is bad for your health",
"warning": "Smoking is bad for your health"
},
"human_readable_class_id": "personal_poi_food_service",
"address": {"building_id": "20498230958",
"postcode": "630007",
"building_code": "string",
"building_name": "Sun City",
"landmark_name": "Zaryadye (a park in Moscow)",
"makani": "27116 87099",
"components": [{"type": "street_number",
"fias_code": "dcb1bc1b-2324-449a-8b68-03e49ba1f541",
"okato": "35",
"oktmo": "35",
"street_id": "123456",
"street": "Krasnyy Prospekt",
"number": "21/2, bld 7"
}
],
"reg_bc_url": "string"
},
"name": "the Sunny cafe",
"point": "54.991984,82.901886",
"subtype": "string",
"routes": [{"id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
"directions": [{"id": "123456",
"type": "forward",
"platforms": [{"id": null,
"station_id": null,
"name": null,
"place_name": null,
"transitions": null,
"geometry": null,
"is_current": null
}
],
"name": "To Tolmachevsky Shopping center",
"description": "string",
"geometry": {"hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
"selection": "POINT(83.306820839303 54.6230101954005)",
"style": "37001",
"immersion": [{ }
],
"centroid": "POINT(83.306820839303 54.6230101954005)"
}
}
],
"direction_ids": ["string"
],
"subtype": "string",
"color": "#D10000",
"comment": "Dzerzhinskaya line",
"name": "Klyuch-Kamyshenskoe plateau",
"route_logo": "string",
"direction_type": "string",
"from_name": "Klyuch-Kamyshenskoe plateau",
"to_name": "Tyulenin street"
}
],
"name_ex": {"short_name": "Sunny",
"primary": "Sunny",
"extension": "cafe",
"legal_name": "LLC Sunny",
"addition": "string",
"description": "Warehouse"
},
"adm_div": [{"id": "123456",
"type": "city",
"caption": "string",
"name": "Ust-Kamenogorsk",
"is_default": true,
"flags": {"is_district_area_center": true,
"has_avg_bill": { },
"photos": true,
"has_model": { },
"temporary_closed": "string",
"is_default": true,
"is_region_center": true,
"temporary_closed_parameters": [{"type": "string",
"value": "string",
"name": "string"
}
],
"badges": [{"type": "string",
"text": "string",
"collection_uid": "string"
}
]
},
"city_alias": "novosibirsk",
"detailed_subtype": "poselok"
}
],
"class_id": 0,
"count": 1,
"geometry": {"centroid": "POINT(83.306820839303 54.6230101954005)",
"hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
"selection": "POINT(83.306820839303 54.6230101954005)",
"style": "37001"
},
"timestamp": 1461831300
}
],
"history_objects": [{"id": "141265769336625",
"type": "history",
"timestamp": 1461831300,
"count": 1,
"objectType": "building"
}
],
"home_work_objects": [{"id": "141265769336625",
"type": "supposed_work",
"count": 1,
"objectType": "building",
"timestamp": 1461831300
}
],
"suggester_picked_objects": [{"id": "141265769336625",
"type": "string",
"product": 10,
"ads": {"text": "Only here, only now",
"article": "<strong>Advertising article</strong><br/>Buy our elephants.",
"link": {"text": "Sale, find out more",
"value": "http://krutaya-kompanya.ru/sale?ref=2gis"
},
"options": {"erid": ["string"
],
"fmcg": [{"ads_id": "123456",
"hash": "string",
"images": [{"url": null
}
],
"org_id": "123456",
"actions": [{"type": null,
"value": null,
"name": null,
"platforms": [ ],
"caption": null
}
],
"text_warning": "string",
"logo": [{"bg_img_url": null,
"text_color": null,
"use_default_value": null,
"img_url": null,
"bg_color": null
}
],
"erid": ["string"
],
"goods_preview": [{"image_url": null
}
],
"text": "string",
"cta_list": true,
"branch_id": "123456",
"videos": [{"resources_description_url": null
}
]
}
],
"map_buy_here_owner": [{"map_icon": {"svg": "string"
},
"map_label": {"text": "string"
},
"ads_id": "123456",
"erid": ["string"
],
"legal_name": "string"
}
],
"images": [{"url": "string"
}
],
"logo": {"bg_img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"text_color": "#000000",
"use_default_value": true,
"img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"bg_color": "#FFFFFF"
},
"actions": [{"type": "string",
"value": "string",
"name": "string",
"platforms": ["string"
],
"caption": "string"
}
],
"buy_here_owner": [{"position": 1,
"owned_rubric_id": "123456",
"control_title": "string",
"erid": ["string"
],
"legal_name": "string"
}
],
"fmcg_owner": [{"legal_name": "string",
"ads_id": "123456",
"control_title": "string",
"erid": ["string"
]
}
],
"poi": {"legal_name": "string",
"erid": ["string"
],
"is_premium": true
},
"review": true,
"3d": true,
"organization_stories": {"discount": {"max_percent": 0,
"is_prime": true
}
},
"color": "#2B5C91",
"videos": [{"resources_description_url": "string"
}
],
"suggestor": {"erid": ["string"
],
"logo": {"img_url": "http://example.com"
},
"microcomment": {"text": "string"
},
"microcomment_warning": {"text": "string"
},
"ads_id": "123456",
"legal_name": "string"
},
"marker_logo": {"url": "string"
},
"buy_here": [{"ads_id": "123456",
"cta_list": true,
"title": "string",
"erid": ["string"
],
"videos": [{"resources_description_url": null
}
],
"owned_rubric_id": "123456",
"images": [{"url": null
}
],
"branch_id": "123456",
"ads_texts": {"text": "string",
"text_warning": "string"
},
"custom_title": "string",
"org_id": "123456",
"logo": {"bg_img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"text_color": "#000000",
"use_default_value": true,
"img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
"bg_color": "#FFFFFF"
},
"is_primary": true,
"actions": [{"type": null,
"value": null,
"name": null,
"platforms": [ ],
"caption": null
}
],
"hash": "string"
}
],
"discount": true,
"legal_name": "string",
"branded_advertiser": true
},
"is_social": true,
"text_warning": "Smoking is bad for your health",
"article_warning": "Smoking is bad for your health",
"warning": "Smoking is bad for your health"
},
"name": "the Sunny cafe",
"address": {"building_id": "20498230958",
"postcode": "630007",
"building_code": "string",
"building_name": "Sun City",
"landmark_name": "Zaryadye (a park in Moscow)",
"makani": "27116 87099",
"components": [{"type": "street_number",
"fias_code": "dcb1bc1b-2324-449a-8b68-03e49ba1f541",
"okato": "35",
"oktmo": "35",
"street_id": "123456",
"street": "Krasnyy Prospekt",
"number": "21/2, bld 7"
}
],
"reg_bc_url": "string"
},
"name_ex": {"short_name": "Sunny",
"primary": "Sunny",
"extension": "cafe",
"legal_name": "LLC Sunny",
"addition": "string",
"description": "Warehouse"
},
"human_readable_class_id": "personal_poi_food_service",
"adm_div": [{"id": "123456",
"type": "city",
"caption": "string",
"name": "Ust-Kamenogorsk",
"is_default": true,
"flags": {"is_district_area_center": true,
"has_avg_bill": { },
"photos": true,
"has_model": { },
"temporary_closed": "string",
"is_default": true,
"is_region_center": true,
"temporary_closed_parameters": [{"type": "string",
"value": "string",
"name": "string"
}
],
"badges": [{"type": "string",
"text": "string",
"collection_uid": "string"
}
]
},
"city_alias": "novosibirsk",
"detailed_subtype": "poselok"
}
],
"class_id": 0,
"geometry": {"centroid": "POINT(83.306820839303 54.6230101954005)",
"hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
"selection": "POINT(83.306820839303 54.6230101954005)",
"style": "37001"
},
"subtype": "string",
"routes": [{"id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
"directions": [{"id": "123456",
"type": "forward",
"platforms": [{"id": null,
"station_id": null,
"name": null,
"place_name": null,
"transitions": null,
"geometry": null,
"is_current": null
}
],
"name": "To Tolmachevsky Shopping center",
"description": "string",
"geometry": {"hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
"selection": "POINT(83.306820839303 54.6230101954005)",
"style": "37001",
"immersion": [{ }
],
"centroid": "POINT(83.306820839303 54.6230101954005)"
}
}
],
"direction_ids": ["string"
],
"subtype": "string",
"color": "#D10000",
"comment": "Dzerzhinskaya line",
"name": "Klyuch-Kamyshenskoe plateau",
"route_logo": "string",
"direction_type": "string",
"from_name": "Klyuch-Kamyshenskoe plateau",
"to_name": "Tyulenin street"
}
],
"point": "54.991984,82.901886",
"timestamp": "1461831300"
}
],
"owned_branches": ["string"
],
"poi_personalized_priorities": [{"id": "141265769336625",
"personalizedPriority": 1
}
],
"searches": [{"timestamp": "1461831300",
"text": "string",
"product": 0
}
]
},
"meta": {"code": 200,
"api_version": "dev",
"issue_date": "string"
}
}