Получение данных по нескольким профилям
Описание
Получение данных по нескольким профилям.
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 | Нет | Лимит количества записей. По умолчанию - 1000. |
query | JSON обект | "query": { | Нет | Уточнение поиска профилей по параметрам в виде запроса к базе данных в формате JSON. Запрос формируется согласно документации к MongoDB. |
fields | Array of string | "fields": [ | Нет | Содержит поля для фильтрации отображаемых данных о профиле. |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"db_id": 1,
"from_id": "65117f62736a0e15d273fae9",
"limit": 1,
"query": {
"$or": [
{
"_lname": "Doe"
},
{
"_city": "Moscow"
}
]
},
"fields": [
"_id",
"_lname",
"_fname",
"_city",
"subscriptions"
]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<db_id>1</db_id>
<from_id>65117f62736a0e15d273fae9</from_id>>
<limit>1</limit>
<fields>_id</fields>
<fields>_lname</fields>
<fields>_fname</fields>
<fields>_city</fields>
<fields>subscriptions</fields>
</xml>
Пример ответа
- JSON
- XML
{
"data": [
{
"_city": "Moscow",
"_fname": "Anna",
"_lname": "Murphy",
"id": "65117f62736a0e15d273faee",
"subscriptions": [
{
"resource_id": 5,
"channel": "email",
"email_data": {
"email": "example@example.edu",
"domain": "example.edu",
"domain_group": "other",
"md5": "7dbeb0466131e377e58988a97196d18e"
},
"priority": 0,
"status": "unsubscribed",
"reg_info": {
"date": "2024-01-09T12:12:18.172Z"
},
"hash_id": "e70dbabe",
"is_delete": false
},
{
"resource_id": 26,
"channel": "push",
"push_data": {
"subscription_id": "example@example.edu",
"provider": "Firefox"
},
"priority": 0,
"status": "subscribed",
"reg_info": {
"date": "2024-04-18T12:30:44.592Z"
},
"hash_id": "e70dbabe",
"is_delete": false
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": "65117f62736a0e15d273faf4"
}
<xml>
<data>
<_city>Toronto</_city>
<_fname>Juan</_fname>
<_lname>Wallace</_lname>
<id>65117f62736a0e15d273fae9</id>
<subscriptions>
<channel>email</channel>
<email_data>
<domain>@example.edu</domain>
<domain_group>other</domain_group>
<email>example@example.edu</email>
<md5>18450b1edfef75279fc4f4f60c78d97e</md5>
</email_data>
<hash_id>a0cc2672</hash_id>
<is_delete>false</is_delete>
<priority>0</priority>
<reg_info>
<date>2024-01-09T12:12:18.172Z</date>
</reg_info>
<resource_id>5</resource_id>
<status>hardbounced</status>
</subscriptions>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
<next_from_id>65117f62736a0e15d273faea</next_from_id>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
next_from_id | string | Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории. |
data | array of objects | Массив полученных данных по профилям |