Перейти к содержанию

Статистика

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/statistics/get-daily?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/statistics/get-daily?key=1234567890qwerty&project=12345
    

Получить основные показатели за период, в который был совершен визит

POST /project/statistics/get-daily

Данным методом API можно воспользоваться для получения основных показателей за период, в который был совершен визит.

Ограничение - 5 запросов в час.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/statistics/get-daily?project=12345

Тело запроса:

{
    "period": "2016-06-01-2016-06-30",
    "time_zone": "Europe/Moscow",
    "channel": "direct4"
}
{
    "StatisticsItems": [
        {
            "dateStart": "2016-06-12 00:00:00",
            "dateEnd": "2016-06-12 23:59:59",
            "visitCount": 789,
            "leadCount": 9,
            "saleCount": 0,
            "revenue": 0,
            "profit": 0,
            "marketingCosts": 32816,
            "salesCosts": 0,
            "cv1": 1.1406844106464,
            "cv2": 0,
            "cpc": 41.592927756653999,
            "cpl": 3646.3133333332999,
            "cpo": 0,
            "averageRevenue": 0,
            "roi": -100
        },
        {
            "dateStart": "2016-06-13 00:00:00",
            "dateEnd": "2016-06-13 23:59:59",
            "visitCount": 858,
            "leadCount": 14,
            "saleCount": 1,
            "revenue": 13560,
            "profit": 11955,
            "marketingCosts": 34675,
            "salesCosts": 1605,
            "cv1": 1.6317016317016,
            "cv2": 7.1428571428570997,
            "cpc": 40.413916083916,
            "cpl": 2476.7957142856999,
            "cpo": 34675.139999999999,
            "averageRevenue": 13560,
            "roi": -65.522850087988004
        },
        {
            "dateStart": "2016-06-14 00:00:00",
            "dateEnd": "2016-06-14 23:59:59",
            "visitCount": 958,
            "leadCount": 12,
            "saleCount": 1,
            "revenue": 13860,
            "profit": 12255,
            "marketingCosts": 40713,
            "salesCosts": 1605,
            "cv1": 1.2526096033403,
            "cv2": 8.3333333333333002,
            "cpc": 42.498538622128997,
            "cpl": 3392.8000000000002,
            "cpo": 40713.599999999999,
            "averageRevenue": 13860,
            "roi": -69.899493044093006
        }
    ],
    "SummaryItem": {
        "dateStart": "2016-06-11 21:00:00",
        "dateEnd": "2016-06-14 20:59:59",
        "visitCount": 2605,
        "leadCount": 35,
        "saleCount": 2,
        "revenue": 27420,
        "profit": 24210,
        "marketingCosts": 108205,
        "salesCosts": 3210,
        "cv1": 1.3435700575816001,
        "cv2": 5.7142857142857002,
        "cpc": 41.537642994241999,
        "cpl": 3091.5874285713999,
        "cpo": 54102.779999999999,
        "averageRevenue": 13710,
        "roi": -77.625918668135
    },
    "AverageItem": {
        "dateStart": "2016-06-11 21:00:00",
        "dateEnd": "2016-06-14 20:59:59",
        "visitCount": 868.33333333332996,
        "leadCount": 11.666666666667,
        "saleCount": 0.66666666666666996,
        "revenue": 9140,
        "profit": 8070,
        "marketingCosts": 36068.519999999997,
        "salesCosts": 1070,
        "cv1": 1.3435700575816001,
        "cv2": 5.7142857142857002,
        "cpc": 41.537642994241999,
        "cpl": 3091.5874285713999,
        "cpo": 54102.779999999999,
        "averageRevenue": 13710,
        "roi": -77.625918668135
    },
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period string временной период (формат: YYYY-MM-DD-YYYY-MM-DD в UTC) да
time_zone string часовой пояс нет
channel string системное название канала и ID канала (без разделительных знаков) нет
Параметр Тип Описание Обязательный
StatisticsItems array[object] статистика по дням нет
dateStart string дата начала периода нет
dateEnd string дата конца периода нет
visitCount integer количество визитов нет
leadCount integer количество лидов нет
saleCount integer количество продаж (когда заказ оплачен) нет
revenue integer выручка нет
profit integer прибыль (выручка - все затраты) нет
marketingCosts integer затраты на маркетинг нет
salesCosts integer себестоимость нет
cv1 integer или number конверсия в лиды нет
cv2 integer или number конверсия в продажи нет
cpc integer или number стоимость за клик нет
cpl integer или number стоимость лида нет
cpo integer или number стоимость заказа нет
averageRevenue integer средний чек нет
roi integer или number возврат инвестиций нет
SummaryItem object общая статистика за период нет
dateStart string нет
dateEnd string нет
visitCount integer нет
leadCount integer нет
saleCount integer нет
revenue integer нет
profit integer нет
marketingCosts integer нет
salesCosts integer нет
cv1 integer или number нет
cv2 integer или number нет
cpc integer или number нет
cpl integer или number нет
cpo integer или number нет
averageRevenue integer нет
roi integer или number нет
AverageItem object средняя статистика за период нет
dateStart string нет
dateEnd string нет
visitCount number нет
leadCount number нет
saleCount number нет
revenue integer нет
profit integer нет
marketingCosts number нет
salesCosts integer нет
cv1 integer или number нет
cv2 integer или number нет
cpc integer или number нет
cpl integer или number нет
cpo integer или number нет
averageRevenue integer нет
roi integer или number нет
status string нет