Описание
Получение данных по нескольким профилям.
URL-адрес
Метод: POST
https://example.com/api/v1.1/profiles/list
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
| db_id | int | 20 | Да | Идентификатор базы данных |
| from_id | string | "0014a2feb331ace2.20200124134127" | Нет | Указатель на следующую страницу, берется из предыдущего запроса или передается пустой для первого. |
| limit | int | 3 | Нет | Лимит количества записей. |
| query | JSON объект | "query": {
"$or": [
{
"_lname": "Black"
},
{
"_city": "Bay City"
}
]
| Нет | Уточнение поиска профилей по параметрам в виде запроса к базе данных в формате JSON. Запрос формируется согласно документации к MongoDB. Для получения списка полей в базе используйте запрос "Получить информацию о полях базы данных". |
| fields | Array of string | "fields": [ "_id", "_lname", "_fname", "_city", "subscriptions" ], | Нет | Содержит поля для фильтрации отображаемых данных о профиле. |
Пример запроса
{
"token": "abcdefghijklmnqrstuvwxyz",
"from_id": "",
"limit": 3,
"query": {
"$or": [
{
"_lname": "Black"
},
{
"_city": "Bay City"
}
]
},
"fields": [
"_id",
"_lname",
"_fname",
"_city",
"subscriptions"
],
"db_id": 6
}
Пример ответа
{
"data": [
{
"_fname": "John",
"_lname": "Black",
"id": "6054619030b8bcb40ad7a9db",
"subscriptions": [
{
"channel": "email",
"email_data": {
"domain": "example.org",
"domain_group": "other",
"email": "example_email@example.org",
"md5": "47f85837cc89cbe1818e7449af633750"
},
"hash_id": "37885611",
"is_delete": false,
"priority": 0,
"reg_info": {
"date": "2018-01-19T13:54:05.466Z",
"ip": "192.168.0.1"
},
"resource_id": 46,
"status": "subscribed"
},
]
},
{
"_fname": "Laura",
"_lname": "Black",
"id": "6054619030b8bcb40ad7a9dd",
"subscriptions": [
{
"channel": "sms",
"hash_id": "5d9bf5ff",
"is_delete": false,
"phone_data": {
"md5": "58c9e54c684e475decbc0eff5c05b6b9",
"phone": "+508370045348365"
},
"priority": 0,
"reg_info": {
"date": "2018-01-19T13:54:05.466Z",
"ip": "192.168.0.1"
},
"resource_id": 57,
"status": "subscribed"
}
]
},
{
"_fname": "Bill",
"_lname": "Black",
"id": "6054619030b8bcb40ad7a9f6",
"subscriptions": [
{
"channel": "push",
"hash_id": "d8360fc4",
"is_delete": false,
"priority": 0,
"push_data": {
"provider": "IOSFirebase",
"subscription_id": "1516370045348387"
},
"reg_info": {
"date": "2018-01-19T13:54:05.466Z",
"ip": "192.168.0.1"
},
"resource_id": 48,
"status": "subscribed",
"custom_fields": {
"_browser_name": "Firefox",
"_device_type": "web",
"custom_field_1": "test value"
},
"cats": [
"category_1",
"category_2"
]
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": "6054619030b8bcb40ad7a9ff"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| next_from_id | string | Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории. |
| data | Array of objects | Массив полученных данных по профилям |