Получить информацию о связях профиля

Описание

Запрос отдаёт информацию о связях профиля из базы данных А, свойствах связей и значениях свойств.

URL-адрес

Метод: POST.

https://example.com/api/v1.1/relations/get_counter

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
rel_id	int	3	Да	ID связи
profile_id		"abcdefghijklmnqrstuvwxyz"	Да	Профиль из базы данных А для поиска
Поиск профиля подписчика
email	string	"john@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю	Email-адрес
phone	string	"+79000000000"	"matching":"phone"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название кастомного поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение кастомного поля для поиска. подсказка Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
resource_id	int	24	Нет	Идентификатор ресурса для поиска по email и phone

Пример запроса

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "rel_id": 1,
    "profile_id": "67ef9942dc993311c9a067f5"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <rel_id>1</rel_id>
  <profile_id>67ef9942dc993311c9a067f5</profile_id>
</xml>

Пример ответа

JSON

{
    "data": {
        "profile_id": "67ef9942dc993311c9a067f5",
        "profile_xxh": "2e6325012644fdf9",
        "props": {
            "donate": {
                "top": [
                    {
                        "profile_id": "67dd005523ea81dd52f98195",
                        "value": 1,
                        "email_b": "67dd005523ea81dd52f98195@localhost"
                    }
                ],
                "sum": 344
            },
            "user_like": {
                "top": [],
                "sum": 3
            }
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <profile_id>67ef9942dc993311c9a067f5</profile_id>
        <profile_xxh>2e6325012644fdf9</profile_xxh>
        <props>
            <donate>
                <sum>344</sum>
                <top>
                    <email_b>67dd005523ea81dd52f98195@localhost</email_b>
                    <profile_id>67dd005523ea81dd52f98195</profile_id>
                    <value>1</value>
                </top>
            </donate>
            <user_like>
                <sum>3</sum>
                <top/>
            </user_like>
        </props>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
data	object	Информация о связях профиля
data.profile_id	string	Идентификатор профиля
data.profile_xxh	string	Хешированый идентификатор профиля
data.props	object	Свойства связей

Свойства связей: числовые {#Getprofilerelationsinfo-Relationproperties:numeric}

Параметр	Тип	Описание
top	object	Топ свойства (связанные профили и значения)
sum	int/float	Сумма числового свойства