API для работы с клиентами¶

[
    {
        "id": "111",
        "name": "Валера",
        "phone": "78888888888",
        "email": "email1@mail.com",
        "company": "company1",
        "birth_date": "1980-01-01",
        "fields":
        {
            "segment": "1"
        }
    },
    {
        "id": "222",
        "name": "Ваcилий",
        "phone": "79999999999,89999999999,87777777777",
        "email": "email2@mail.com",
        "company": "company2",
        "birth_date": "1990-01-01",
        "fields":
        {
            "segment": "2"
        }
    }
]

{
    "status": "success"
}

{
    "filters": [
        [
            "phone",
            "=",
            "79880002233"
        ]
    ],
    "limit": 100,
    "offset": 0
}

{
    "clients": [
        {
            "id": 7,
            "first_visit_date": null,
            "external_id": "105",
            "name": "Имя клиента",
            "phone": "79880002233",
            "email": "test@roistat.test",
            "first_order_date": null,
            "last_order_date": null,
            "order_count": 0,
            "revenue": 0,
            "profit": 0,
            "birth_date": null,
            "company": "",
            "comment": null,
            "client_url": "http://example.crm.com/contacts/105",
            "first_visit_marker": null,
            "first_visit_marker_alias": "",
            "first_visit_marker_icon": "https://cloud.roistat.com/img/arrow-right.png",
            "first_visit_marker_alias_level_1": ""
        },
        {
            "id": 6,
            "first_visit_date": null,
            "external_id": "106",
            "name": "Иван",
            "phone": "79880002233",
            "email": "test@roistat.test",
            "first_order_date": null,
            "last_order_date": null,
            "order_count": 0,
            "revenue": 0,
            "profit": 0,
            "birth_date": null,
            "company": "",
            "comment": null,
            "client_url": "http://example.crm.com/contacts/106",
            "first_visit_marker": null,
            "first_visit_marker_alias": "",
            "first_visit_marker_icon": "https://cloud.roistat.com/img/arrow-right.png",
            "first_visit_marker_alias_level_1": ""
        }
    ],
    "total": 2,
    "status": "success"
}

{
    "feed": [
        {
            "type": "visit",
            "visitId": "41028",
            "creationDate": "2021-11-10T14:05:12+0000",
            "sourceId": "instagram_stories",
            "device": {
                "os": "Mac 10.15 ",
                "os_icon": "https://cloud.roistat.com/img/os/macosx.png",
                "agent": "Chrome 90.0 browser Blink",
                "agent_icon": "https://cloud.roistat.com/img/browsers/chrome.png",
                "is_mobile": false
            },
            "sourceTitle": "instagram → stories",
            "sourceIcon": "https://cloud.roistat.com/img/instagram.png"
        },
        {
            "type": "order",
            "id": "order_41028",
            "name": "order_41028",
            "status": "0",
            "statusType": "progress",
            "statusTitle": "Новый",
            "revenue": 0,
            "formattedRevenue": "0 ₽",
            "cost": 0,
            "formattedCost": "0 ₽",
            "fields": {
                "status_name": "Ожидает оплаты",
                "Менеджер": "Соколова Мария",
                "roistat": 41028
            },
            "creationDate": "2021-11-10T14:28:59+0000",
            "updateDate": null
        },
        {
            "type": "event",
            "metaId": "5",
            "creationDate": "2021-11-10T14:08:08+0000",
            "name": "Переход на страницу корзины"
        },
        {
            "type": "lead_hunter_appearance",
            "date": "2021-11-08T16:53:16+0000",
            "page": "cozy.kitchen.ru/catalog/accessories"
        },
        {
            "type": "lead_hunter_caught",
            "date": "2021-11-08T16:55:16+0000",
            "page": "cozy.kitchen.ru/catalog/accessories"
            "name": "Мария"
            "field": "71234567890"
            "status": "1"
        },
        {
            "order_id": "order_41028",
            "order_title": "order_41028",
            "type": "orderStatusChange",
            "status": "1",
            "statusType": "progress",
            "statusTitle": "В работе",
            "date": "2021-11-11T06:28:59+0000"
        },
        {
            "order_id": "order_41028",
            "order_title": "order_41028",
            "type": "orderStatusChange",
            "status": "2",
            "statusType": "progress",
            "statusTitle": "Ожидает оплаты",
            "date": "2021-11-11T07:28:59+0000"
        },
        {
            "order_id": "order_41028",
            "order_title": "order_41028",
            "type": "orderCostChange",
            "cost": 1000,
            "formattedCost": "1000 ₽",
            "date": "2021-11-11T07:28:59+0000"
        },
        {
            "order_id": "order_41028",
            "order_title": "order_41028",
            "type": "orderPriceChange",
            "price": 1000,
            "formattedPrice": "1000 ₽",
            "date": "2021-11-11T07:28:59+0000"
        }
    ],
    "status": "success"
}

{
    "metric_ids": ["sent"],
    "campaign_ids": [2]
}

{
    "data": [
        {
            "contact": "ivanov_aleksandr@example.com",
            "metrics": {
                "sent": 1
            }
        },
        {
            "contact": "petrov_sergey@example.com",
            "metrics": {
                "sent": 1
            }
        },
        {
            "contact": "ivanov_daniil@example.com",
            "metrics": {
                "sent": 1
            }
        }

    ],
    "count": 3,
    "total_count": 3,
    "status": "success"
}

{
    "filters": [
        [
            "id",
            "=",
            "1"
        ],
        [
            "title",
            "=",
            "Скидки"
        ],
        [
            "status_id",
            "=",
            "sent"
        ]
    ],
    "limit": 100,
    "offset": 0
}

{
    "data": [
        {
            "id": 2,
            "title": "Скидки",
            "status_id": "sent",
            "engine_id": "unione",
            "status": {
                "id": "sent",
                "title": "Отправлено",
                "description": null
            },
            "contact_from": "test@domain.com",
            "name_from": "Test",
            "segment_ids": [
                6
            ],
            "segments": [
                {
                    "id": 6,
                    "title": "Гугл-форма | Товары для кухни"
                }
            ],
            "client_ids": [],
            "timetable": {
                "date": "2021-08-17",
                "time": "14:00:00",
                "timezone": "Europe\/Moscow",
                "is_deferred": false
            },
            "attachments_ids": null,
            "attachments": null,
            "template": "Test",
            "template_id": "1",
            "template_metadata": null,
            "metrics": {
                "sent": 42,
                "delivered": 36,
                "opened": 28,
                "click": 5,
                "unsubscribe": 2,
                "spam": 2,
                "unique_contact_count": 42
            },
            "price": 9,
            "is_enough_money_for_sending": false,
            "contact_count": 45,
            "recipient_count": 45,
            "creation_date": "2022-03-19T20:31:09+0000",
            "update_date": "2022-03-19T20:31:09+0000",
            "send_date": "2022-04-18T20:31:09+0000",
            "service": null,
            "send_error_descriptions": []
        }
    ],
    "count": 1,
    "total_count": 1,
    "status": "success"
}