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

Описание

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

URL-адрес

Метод: POST.

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
rel_id	int	3	Да	ID связи
<profile>		"profile_id": "c1wefohoi1312"	Да	Профиль из базы данных А для поиска
Поиск профиля подписчика
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": 3,
    "profile_id": "5d63dbdb439e7306b596c5d0"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <rel_id>3</rel_id>
  <profile_id>5d63dbdb439e7306b596c5d0</profile_id>
</xml>

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

JSON

{
    "data": {
        "profile_id": "5c910f6bc484d023b1309bee",
        "profile_xxh": "54ec2d76ac22a964",
        "total": 1,
        "props": {
            "Donate": {
                "total": 1,
                "top": [
                    {
                        "profile_id": "5c910938c484d023b1309bab",
                        "value": 20
                    }
                ],
                "sum": null
            },
            "Like": {
                "total": 1,
                "top": null,
                "sum": 2
            },
            "Subscriber": {
                "total": 1,
                "top": null,
                "sum": null
            }
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <profile_id>5c910f6bc484d023b1309bee</profile_id>
        <profile_xxh>54ec2d76ac22a964</profile_xxh>
        <total>1</total>
        <props>
            <Donate>
                <total>1</total>
                <top>
                    <profile_id>5c910938c484d023b1309bab</profile_id>
                    <value>20</value>
                </top>
                <sum/>
            </Donate>
            <Like>
                <total>1</total>
                <top/>
                <sum>2</sum>
            </Like>
            <Subscriber>
                <total>1</total>
                <top/>
                <sum/>
            </Subscriber>
        </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.total	int	Количество связей c с другими профилями
data.props	object	Свойства связей

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

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

Свойства связей: булевые {#Getprofilerelationsinfo-Relationproperties:boolean}

Параметр	Тип	Описание
total	int	Количество полученных свойств
top	null	не актуально
sum	null	не актуально