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

Рекламные каналы

Узнать полный список рекламных каналов, которые используются в проекте

POST /project/analytics/source/list

С помощью этого метода можно узнать полный список рекламных каналов, которые используются в проекте.

curl 'https://cloud.roistat.com/api/v1/project/analytics/source/list?project=12345' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' 
{
    "data": [
        {
            "source": "yandex",
            "name": "Яндекс",
            "type": "system",
            "level": 1,
            "icon": "http://test.ru/logo.png"
        },
        {
            "source": "yandex_seo",
            "name": "seo",
            "type": "custom",
            "level": 2,
            "icon": null
        }
    ],
    "total": 2,
    "status": "success"
}

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

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

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

Без параметров.

Параметр Тип Описание
data array[object]
source string системное название рекламного канала
name string человекочитаемое название рекламного канала
type string тип рекламного канала: - system - подключаемые каналы; - custom - размеченные вручную.
level integer уровень вложенности канала
icon null или string ссылка на иконку канала
total integer
status string

Выгрузить данные о всех расходах, когда-либо введенных в Аналитике

POST /project/analytics/source/cost/list

С помощью этого метода можно выгрузить данные о всех расходах, когда-либо введенных в Аналитике.

curl 'https://cloud.roistat.com/api/v1/project/analytics/source/cost/list?project=12345' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' 
[
    {
        "id": "123",
        "source": "yandex_seo_test",
        "name": "Yandex -> SEO -> Test",
        "from_date": "2016-07-01",
        "to_date": "2016-07-31",
        "timezone": "Europe/Moscow",
        "marketing_cost": 500
    }
]

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

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

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

Без параметров.

Параметр Тип Описание
id string ID расхода в Roistat
source string Системное название рекламного канала
name string Человекочитаемое название рекламного канала
from_date string Начальная дата перида для данного ввода расхода
to_date string Конечная дата периода для данного ввода расхода
timezone string Название часового пояса
marketing_cost integer Сумма расхода по каналу за период

Внести расходы по рекламному каналу за указанный период

POST /project/analytics/source/cost/add

С помощью данного метода можно внести расходы по рекламному каналу за определенный период.

Об особенностях внесения расходов по каналам можно прочитать в инструкции Ввод расхода.

curl 'https://cloud.roistat.com/api/v1/project/analytics/source/cost/add?project=12345' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data Тело запроса - см. ниже

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

{
    "source": "yandex_seo_test",
    "from_date": "2016-07-01",
    "to_date": "2016-07-31",
    "timezone": "Europe/Moscow",
    "marketing_cost": 500
}
{
    "data": {
        "id": "8",
        "date_from": "2021-05-04T21:00:00.000Z",
        "date_to": "2021-05-05T20:59:59.999Z",
        "timezone": "Europe/Moscow",
        "marker": "",
        "title": "Прямые визиты",
        "comment": null,
        "cost": 500000,
        "create_date": "2021-05-20 10:31:05",
        "update_date": "2021-05-20 10:31:05"
    },
    "status": "success"
}

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

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

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

Параметр Тип Описание Обязательный
source string Системное название (метка) рекламного канала в Roistat и ID канала (без разделительных знаков). - Как узнать ID, читайте в инструкции "Как узнать ID рекламного канала". - Системные названия каналов можно узнать с помощью метода /project/statistics/get-top-channels. да
from_date string Начальная дата периода ввода расходов (вида 2016-07-01) да
to_date string Конечная дата периода ввода расходов (вида 2016-07-31) да
timezone string Название часового пояса нет
marketing_cost integer Сумма расходов да
Параметр Тип Описание
data object
id string ID записи о введенном расходе по каналу
date_from string Начальная дата периода ввода расходов
date_to string Конечная дата периода ввода расходов
timezone string Название часового пояса
marker string Системное название канала
title string Название канала
comment null или string Комментарий
cost integer Сумма расходов по каналу
create_date string Дата ввода суммы расходов
update_date string Дата обновления суммы расходов
status string

Редактировать введенный ранее расход по рекламному каналу

POST /project/analytics/source/cost/update

Данный метод используется для редактирования одного введенного ранее расхода по рекламному каналу.

curl 'https://cloud.roistat.com/api/v1/project/analytics/source/cost/update?project=12345' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data Тело запроса - см. ниже

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

{
    "id": 123,
    "marketing_cost": 500
}
{
    "status": "success"
}

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

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

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

Параметр Тип Описание Обязательный
id integer ID записи о введенном расходе по каналу нет
marketing_cost integer Новая сумма расходов по каналу нет
Параметр Тип Описание
status string

Удалить введенный ранее расход по рекламному каналу

POST /project/analytics/source/cost/delete

Данный метод используется для удаления одного введенного ранее расхода по рекламному каналу.

curl 'https://cloud.roistat.com/api/v1/project/analytics/source/cost/delete?project=12345' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data Тело запроса - см. ниже

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

{
    "id": 12
}
{
    "status": "success"
}

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

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

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

Параметр Тип Описание Обязательный
id integer ID записи о введенном расходе по каналу нет
Параметр Тип Описание
status string