Туннели (Tunnels)

Список туннелей

Наше API позволяет получить список всех туннелей компании.
Пример GET запроса:

Request

GET https://api.leeloo.ai/api/v1/tunnels?limit=20&offset=0

limit - ограничение количества результатов;
offset - сколько результатов пропустить.

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

Response

{
    "data": [
        {
            "id": "59fc290d5dd2de001702ca54",
            "name": "Tunnel_7",
            "createdAt": "2017-11-03T08:30:05.297Z",
            "updatedAt": "2017-11-03T08:30:05.297Z"
        },
        {
            "id": "59f2e20497d8fe000a1d1b6a",
            "name": "Tunnel_6",
            "createdAt": "2017-10-27T07:36:36.944Z",
            "updatedAt": "2017-10-27T07:36:36.944Z"
        },
        {
            "id": "59ef306799a2b4000ac8e346",
            "name": "Tunnel_5",
            "createdAt": "2017-10-24T12:21:59.354Z",
            "updatedAt": "2017-10-24T12:21:59.354Z"
        }
    ],
    "meta": {
        "limit": 3,
        "offset": 0,
        "filteredCount": 3,
        "totalCount": 14
    },
    "status": 1
}

id - идентификатор туннеля;
name - название туннеля;
createdAt - время создания туннеля.

meta:

limit - лимит, установленный в запросе (по усмолчанию 20);
offset - установленный в запросе отступ (по умолчанию 0);
filteredCount - количество результатов в ответе;
totalCount - общее количество результатов, что ответствуют фильтру.

Информация о туннеле

Позволяет получить подробную информацию о конкретном туннеле.

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

Request

GET https://api.leeloo.ai/api/v1/tunnels/59ef2942e9c511004428e20a?include=leadgentools

59ef2942e9c511004428e20a - id туннеля;
include - позволяет включить дополнительные даные в ответ:
- leadgentools - список ЛГТ, принадлежащих туннелю.

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

Response

{
    "data": {
        "id": "59ef2942e9c511004428e20a",
        "name": "Tunnel_2",
        "createdAt": "2017-10-24T11:51:30.370Z",
        "updatedAt": "2017-10-24T11:51:36.882Z",
        "links": {
            "leadgentools": [
                {
                    "type": "LINK",
                    "id": "59ef2957613ddb00145f878e"
                }
            ]
        }
    },
    "linked": {
        "leadgentools": [
            {
                "type": "LINK",
                "id": "59ef2957613ddb00145f878e",
                "name": "LGT_Name_1"
            }
        ]
    },
    "status": 1
}

id - идентификатор туннеля;
name - название туннеля;
createdAt - время создания туннеля.
links - связи туннеля;
linked - данные запрошены через include:
- leadgentools - ЛГТ туннеля;
  - type - тип ЛГТ;
  - id - идентификатор ЛГТ;
  - name - название ЛГТ.

Статистика по всем туннелям

Позволяет получить статистику по всем туннелям.

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

Request

https://api.leeloo.ai/api/v1/tunnels/stats

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

Response

{
    "data": {
        "subscribers": 573,
        "uniqSubscribers": 50,
        "orders": 142,
        "sales": 57,
        "uniqSales": 8,
        "visits": 17356,
        "uniqVisits": 5180,
        "shows": 163,
        "uniqShows": 49,
        "totalSale": 16.415231843749964,
        "totalExpenses": 781200.17
    },
    "status": 1
}

Информация со страницы аналитики:

subscribers - все подписки;
uniqSubscribes - уникальные подписки;
orders - количество заказов;
sales - количество продаж;
uniqSales - уникальные продажи;
visits - общее количество просмотров;
uniqVisits - количество уникальных просмотров;
shows - общее количество кликов;
uniqShows - количество уникальных кликов;
totalSale - валовый доход;
totalExpenses - расход.

Статистика по одному туннелю

Позволяет получить статистику по одному туннелю.

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

Request

https://api.leeloo.ai/api/v1/tunnels/59ef2942e9c511004428e20a/stats

59ef2942e9c511004428e20a - id туннеля;

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

Response

{
    "data": {
        "subscribers": 6,
        "uniqSubscribers": 1,
        "orders": 0,
        "sales": 0,
        "uniqSales": 0,
        "visits": 6,
        "uniqVisits": 1,
        "shows": 6,
        "uniqShows": 1,
        "totalSale": 0,
        "totalExpenses": 0
    },
    "status": 1
}

Информация со страницы аналитики:

subscribers - все подписки;
uniqSubscribes - уникальные подписки;
orders - количество заказов;
sales - количество продаж;
uniqSales - уникальные продажи;
visits - общее количество просмотров;
uniqVisits - количество уникальных просмотров;
shows - общее количество кликов;
uniqShows - количество уникальных кликов;
totalSale - валовый доход;
totalExpenses - расход.