--- title: "Получить рассылку по ID" method: GET path: "/v1/public/campaigns/{campaignId}" tags: ["Рассылки"] --- # Получить рассылку по ID `GET /v1/public/campaigns/{campaignId}` ## Request - Base URL: `https://api.rusender.ru/api` - URL: `https://api.rusender.ru/api/v1/public/campaigns/{campaignId}` - Auth: HTTP bearer Возвращает рассылку пользователя по ID. Для составных рассылок дополнительно возвращает их структуру: разбивку A/B-теста с вариантами и победителем (abTest), досыл (followUp), ссылку на основную рассылку у части (parent) и агрегированную статистику частей (totalStats). Статистика опционально — по флагу withStats=true. ## Path parameters - `campaignId` integer, required ## Query parameters - `withStats` boolean ## Response `200` Рассылка. - object - `ok` boolean, required: Флаг успешного выполнения. - `data` object, required: Полезная нагрузка успешного ответа. - `id` number, required: Идентификатор рассылки. - `name` string, required: Название рассылки. - `subject` string: Тема письма. - `previewTitle` string: Preview-текст письма. - `type` 'regular' | 'ab_basic' | 'ab_variant' | 'follow_up_basic' | 'follow_up' | 'chunked', required: Тип рассылки. - `status` 'draft' | 'built' | 'scheduled' | 'in_progress' | 'paused' | 'completed' | 'banned' | 'on_hold', required: Статус рассылки. - `statusModerate` 'not_ready_to_moderate' | 'ready_to_moderate' | 'moderating' | 'approved' | 'banned' | 'paused', required: Статус модерации рассылки. - `folderId` object: ID папки, в которой лежит рассылка. null — если не в папке. - `isArchived` boolean, required: Находится ли рассылка в архиве. - `dashboardUrl` string, required: Прямая ссылка на рассылку в дашборде - `attachments` CampaignAttachmentDto[], required: Вложения письма рассылки. - `id` number, required: Идентификатор вложения. - `fileName` string, required: Имя файла вложения. - `size` number, required: Размер файла в байтах. - `templateId` number: ID шаблона, используемого в рассылке. - `senderId` number: ID email-отправителя. - `senderEmail` string: Email адрес отправителя. - `senderName` string: Имя отправителя. - `lists` CampaignListReferenceDto[], required: Списки контактов, на которые идёт рассылка. - `id` number, required: ID списка контактов. - `name` string, required: Название списка контактов. - `utm` CampaignUtmDto - `utm_source` string: Query-параметр utm_source, добавляемый ко всем ссылкам письма (источник трафика, например «newsletter»). - `utm_medium` string: Query-параметр utm_medium, добавляемый ко всем ссылкам письма (канал трафика, например «email»). - `utm_campaign` string: Query-параметр utm_campaign, добавляемый ко всем ссылкам письма (идентификатор кампании). - `scheduledAt` object: Запланированное время старта рассылки (ISO 8601). - `startedAt` object: Фактическое время начала рассылки (ISO 8601). - `finishedAt` object: Время завершения рассылки (ISO 8601). - `createdAt` object: Время создания рассылки (ISO 8601). - `updatedAt` object: Время последнего обновления рассылки (ISO 8601). - `stats` CampaignStatsDto - `total` number, required: Общее количество адресов в рассылке. - `sending` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `delivered` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `open` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `click` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `error` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `unsubscribe` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `complaint` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `abTest` CampaignAbTestDetailsDto - `basicId` number, required: ID базовой A/B-рассылки (уходит на остаток аудитории после теста). - `testPercent` number, required: Доля аудитории, участвующая в тесте, в процентах (1-99). Остальные получают базовую рассылку. - `experimentType` 'subject' | 'template', required: Что тестируется: subject (тема письма) или template (содержимое письма). - `isWinnerSelected` boolean, required: Выбран ли вариант-победитель. - `winnerId` number: ID рассылки-варианта, победившего в тесте. Присутствует только после выбора победителя. - `variants` CampaignAbVariantDto[], required: Варианты A/B-теста. - `id` number, required: ID рассылки-варианта. - `name` string, required: Название рассылки-варианта. - `subject` string: Тема письма варианта. - `previewTitle` string: Текст превью письма варианта. - `status` 'draft' | 'built' | 'scheduled' | 'in_progress' | 'paused' | 'completed' | 'banned' | 'on_hold', required: Статус варианта. - `splitPercent` number, required: Настроенная доля аудитории этого варианта в процентах. Фактическая доля может отличаться на единицы контактов из-за округления. - `isWinner` boolean: Победил ли этот вариант. Присутствует только после выбора победителя. - `stats` CampaignStatsDto - `total` number, required: Общее количество адресов в рассылке. - `sending` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `delivered` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `open` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `click` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `error` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `unsubscribe` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `complaint` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `followUp` CampaignFollowUpDto - `id` number, required: ID рассылки-досыла. - `name` string, required: Название рассылки-досыла. - `subject` string: Тема письма досыла. - `previewTitle` string: Текст превью письма досыла. - `status` 'draft' | 'built' | 'scheduled' | 'in_progress' | 'paused' | 'completed' | 'banned' | 'on_hold', required: Статус досыла. - `offsetHours` number, required: Задержка досыла относительно базовой рассылки в часах. - `stats` CampaignStatsDto - `total` number, required: Общее количество адресов в рассылке. - `sending` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `delivered` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `open` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `click` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `error` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `unsubscribe` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `complaint` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `parent` CampaignParentDto - `id` number, required: ID основной рассылки. - `type` 'regular' | 'ab_basic' | 'ab_variant' | 'follow_up_basic' | 'follow_up' | 'chunked', required: Тип основной рассылки: ab_basic или follow_up_basic. - `name` string, required: Название основной рассылки. - `subject` string: Тема письма основной рассылки. - `previewTitle` string: Текст превью письма основной рассылки. - `status` 'draft' | 'built' | 'scheduled' | 'in_progress' | 'paused' | 'completed' | 'banned' | 'on_hold', required: Статус основной рассылки. - `stats` CampaignStatsDto - `total` number, required: Общее количество адресов в рассылке. - `sending` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `delivered` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `open` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `click` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `error` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `unsubscribe` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `complaint` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `totalStats` CampaignStatsDto - `total` number, required: Общее количество адресов в рассылке. - `sending` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `delivered` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `open` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `click` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `error` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `unsubscribe` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `complaint` CampaignStatMetricDto, required - `count` number, required: Абсолютное количество. - `rate` number, required: Значение в процентах. - `meta` PublicApiResponseMetaDto, required - `requestId` string, required: Итоговый идентификатор запроса, использованный сервером. - `timestamp` string, required: Время формирования ответа в формате ISO-8601. - `pagination` PublicApiPaginationMetaDto - `page` number, required: Текущая страница. - `limit` number, required: Количество элементов на странице. - `totalItems` number, required: Общее количество элементов. - `totalPages` number, required: Общее количество страниц. ## Other responses - `400`: Некорректный запрос. - `401`: Требуется валидный токен Public API. - `403`: Для вызова endpoint не хватает требуемого scope. - `404`: Запрошенный ресурс не найден. - `422`: Запрос синтаксически корректен, но не может быть обработан. - `429`: Превышен rate limit для текущего API key. - `500`: Внутренняя ошибка сервера. --- [API](https://skmtc.dev/rusender/apis/public-api.md) · [All operations](https://skmtc.dev/rusender/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rusender/apis/public-api/revisions/8e86bca789ea?raw)