Создать задачу на формирование отчета

POST https://mailganer.com/api/v2/tasks/emails_report

Описание

Метод запускает асинхронную задачу для генерации файла с данными.
Поддерживаются три типа отчетов:

Скачивание списка — параметр site_id
Скачивание сегмента — параметр segment_id
Отчет по рассылке— параметры mailing_id + mailing_report_type
Если JSON пустой - скачиваются все имейлы аккаунта

Запрос должен содержать ровно одну группу параметров, определяющую тип отчета.
Параметры start_date и end_date игнорируются для отчетов по рассылке.

Список параметров запроса

Важно: Параметры site_id, segment_id, mailing_id являются взаимоисключающими.
Запрос, содержащий более одного из них (или ни одного), будет отклонён с ошибкой.

Особенности работы с датами

Если указаны оба параметра start_date и end_date, возвращаются подписчики, созданные в указанном периоде.
Если параметры не указаны – возвращаются все подписчики (без фильтрации по дате создания).
Для отчетов по рассылке (mailing_id) фильтры дат игнорируются – отчет всегда строится по всем получателям рассылки.

Пример запросов

{
    "site_id": 104131,
    "file_type": "csv",
    "start_date": "2026-01-22",
    "end_date": "2026-01-27"
}

{
    "segment_id": 257649,
    "file_type": "xlsx"
}

{
    "mailing_id": 177022020521,
    "mailing_report_type": "general_report_type",
    "file_type": "csv"
}

{
    "mailing_id": 177022020521,
    "mailing_report_type": "clicks",
    "file_type": "xlsx"
}

Список параметров ответа (json)

Пример ответа в случае успеха (json)

{
    "task_id": "c8549c22-21f9-467b-9c74-870c34523432a048b",
    "state": "IN_PROGRESS",
    "task_type": "DOWNLOAD_MAILING_REPORT"
}

Пример ответов в случае ошибки (json)

Некорректная комбинация параметров

{
    "status": "invalid",
    "error": "Request cannot contain parameters from different report types: 'mailing_id' cannot be used with 'segment_id' or 'site_id'."
}

Отсутствует обязательный параметр (например, mailing_id при наличии mailing_report_type)

{
    "status": "invalid",
    "error": {
        "detail": [
            "mailing_id is required for mailing_report_type parameter"
        ]
    }
}

Неверный формат даты

{
    "status": "invalid",
    "error": {
        "detail": [
            "mailing_id is required for mailing_report_type parameter"
        ]
    }
}

Неподдерживаемый формат файла

{
    "status": "invalid",
    "error": {
        "file_type": [
            "\"pdf\" не является корректным значением."
        ]
    }
}

Несуществующий список/сегмент/рассылка

{
    "error": "Site does not exist"
}