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

Медиаплан

Авторизация

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

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

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

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

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

    https://cloud.roistat.com/api/v1/project/mediaplan/target/list?key=1234567890qwerty&project=12345
    

Получить данные по всем медиапланам за определенный месяц

POST /project/mediaplan/target/list

Позволяет получить данные по всем медиапланам за определенный месяц.

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

POST https://cloud.roistat.com/api/v1/project/mediaplan/target/list?project=12345

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

{
    "date_from": "2021-11-01",
    "date_to": "2021-11-30"
}
{
    "data": [
        {
            "id": "25",
            "channel": "email",
            "metrics": [
                {
                    "name": "leads",
                    "value": 1
                },
                {
                    "name": "marketing_cost",
                    "value": 2
                },
                {
                    "name": "cpl",
                    "value": 2
                }
            ],
            "date_from": "2021-11-01",
            "date_to": "2021-11-30"
        },
        {
            "id": "16",
            "channel": "facebook5",
            "metrics": [
                {
                    "name": "leads",
                    "value": 53
                },
                {
                    "name": "marketing_cost",
                    "value": 10000
                },
                {
                    "name": "cpl",
                    "value": 188.68000000000001
                }
            ],
            "date_from": "2021-11-01",
            "date_to": "2021-11-30"
        },
        {
            "id": "18",
            "channel": "seo",
            "metrics": [
                {
                    "name": "leads",
                    "value": 16
                },
                {
                    "name": "marketing_cost",
                    "value": 10000
                },
                {
                    "name": "cpl",
                    "value": 625
                }
            ],
            "date_from": "2021-11-01",
            "date_to": "2021-11-30"
        }
    ],
    "total": 3,
    "status": "success"
}

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

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

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

Параметр Тип Описание Обязательный
date_from string Первый день месяца, за который нужно получить данные, в формате YYYY-MM-DD. Нельзя указывать прочие дни месяца. да
date_to string Последний день месяца, за который нужно получить данные, в формате YYYY-MM-DD. Нельзя указывать прочие дни месяца. да
Параметр Тип Описание Обязательный
data array[object] нет
id string ID медиаплана нет
channel string Название канала нет
metrics array[object] нет
>> name string Метрики "leads" (заявки), "marketing_cost" (расходы) и "cpl" нет
>> value integer Значение метрики нет
date_from string Первый день месяца, за который учитываются данные нет
date_to string Последний день месяца, за который учитываются данные нет
total integer Количество медиапланов за выбранный месяц нет
status string нет

Удалить данные по определенному медиаплану

POST /project/mediaplan/target/delete

Позволяет удалить данные по определенному медиаплану.

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

POST https://cloud.roistat.com/api/v1/project/mediaplan/target/delete?project=12345

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

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

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

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

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

Параметр Тип Описание Обязательный
id string ID медиаплана, который можно узнать с помощью метода /project/mediaplan/target/list да
Параметр Тип Описание Обязательный
status string нет

Создать медиаплан

POST /project/mediaplan/target/create

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

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

POST https://cloud.roistat.com/api/v1/project/mediaplan/target/create?project=12345

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

{
    "channel": "unisender",
    "date_from": "2021-11-01",
    "date_to": "2021-11-30",
    "metrics": [
        {
            "name": "leads",
            "value": 25
        },
        {
            "name": "marketing_cost",
            "value": 350
        },
        {
            "name": "cpl",
            "value": 14
        }
    ]
}
{
    "status": "success"
}

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

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

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

Параметр Тип Описание Обязательный
channel string Название канала в Roistat да
date_from string Первый день месяца, за который нужно получить данные, в формате YYYY-MM-DD. Нельзя указывать прочие дни месяца. да
date_to string Последний день месяца, за который нужно получить данные, в формате YYYY-MM-DD. Нельзя указывать прочие дни месяца. да
metrics array[object] В массиве передаются метрики "leads" (заявки), "marketing_cost" (расходы), "cpl" и их значения. да
name string В качестве значения укажите "leads" (заявки), "marketing_cost" (расходы) или "cpl" нет
value integer Значение метрики, указанной в name нет
Параметр Тип Описание Обязательный
status string нет

Обновить данные по указанному медиаплану

POST /project/mediaplan/target/update

Позволяет обновить данные по указанному медиаплану.

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

POST https://cloud.roistat.com/api/v1/project/mediaplan/target/update?project=12345

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

{
    "id": "26",
    "channel": "yamarket3",
    "date_from": "2021-11-01",
    "date_to": "2021-11-30",
    "metrics": [
        {
            "name": "leads",
            "value": 8
        },
        {
            "name": "marketing_cost",
            "value": 600
        },
        {
            "name": "cpl",
            "value": 75
        }
    ]
}
{
    "status": "success"
}

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

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

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

Параметр Тип Описание Обязательный
id string ID медиаплана, который можно узнать с помощью метода /project/mediaplan/target/list да
channel string Название канала в Roistat да
date_from string Первый день месяца, за который учитываются данные, в формате YYYY-MM-DD. Нельзя указывать прочие дни месяца. да
date_to string Последний день месяца, за который учитываются данные, в формате YYYY-MM-DD. Нельзя указывать прочие дни месяца. да
metrics array[object] В массиве передаются метрики "leads" (заявки), "marketing_cost" (расходы), "cpl" и их значения. да
name string В качестве значения укажите "leads" (заявки), "marketing_cost" (расходы) или "cpl" нет
value integer Значение метрики, указанной в name нет
Параметр Тип Описание Обязательный
status string нет