Skip to main content
GET/email-campaign/:id/

Get single email campaign

You can return information about a specific email campaign. These results can be filtered by conditions defined as request parameters.

LookupDescriptionExample usage
__ltLesser than?started_at__lt=2021-05-07-16
__lteLesser than or equal?started_at__lte=2021-05-07-16
__gtGreater than?started_at__gt=2022-05-05
__gteGreater than or equal?started_at__gte=2021-05-05
count_fromA date from when stats should be counted?count_from=2021-05-05-16
count_toA date utill stats should be counted?count_from=2022-05-05-16

Request​

curl -X GET "https://<your_app_subdomain>.user.com/api/public/email-campaign/:id/" \
-H "Authorization: Token <your_64_char_api_key>" \
-H "Accept: */*; version=2"

Response examples​

{
"statistics": {
"real_sender_email": "value",
"recipients": 1,
"scheduled": 1,
"delivered": 1,
"delivered_tracked": 1,
"opened": 1,
"opened_tracked": 1,
"clicked": 0,
"clicked_tracked": 0,
"unsubscribed": 0,
"hardbounce": 0,
"softbounce": 0,
"spambounce": 0,
"unsub_ratio": 0,
"delivered_ratio": 100,
"delivered_tracked_ratio": 100,
"opened_ctr": 100,
"opened_tracked_ctr": 100,
"clicked_ctr": 0,
"clicked_tracked_ctr": 0,
"revenue": null,
"webhook": 0,
"webhooks": [
,3 fields
,3 fields
3 fields
],
"utm_term": null,
"utm_medium": null,
"utm_source": null,
"utm_campaign": null,
"deferred": 0,
"dropped": 0,
"feedbackloop": 0,
"success": 1,
"failed": 0
},
"smtp": "default SMTP: 1.userengagemedium.smtp",
"custom_settings": "-",
"real_sender": "None",
"name": "Your weekly summary",
"type": 1,
"status": 2,
"recipients_count": 1,
"closed": null,
"started_at": "2026-11-17T14:59:57.618303Z",
"finished_at": "2026-11-17T14:59:55.653003Z",
"created_at": "2026-11-17T14:59:55.563462Z",
"updated_at": "2026-11-17T14:59:55.563481Z",
"id": 180,
"eta": "2026-11-17T14:59:55.594223Z",
"description": "",
"category": 1,
"messages": [
189
],
"ab_test_stage": 0,
"ab_test_distribution": 0,
"ab_test_winning_metric": 1,
"ab_test_duration": 0,
"ab_variations": [
{
"id": 763,
"name": "A",
"preview_file": "https://<your_app_subdomain>.user.com/previews/message/70d838ef-785d-486f-b2e3-bd9c3c09033a_CvcA7ov.png",
"message_subject": "Your weekly summary",
"message_id": 189,
"recipients": 1,
"scheduled": 1,
"delivered": 1,
"opened": 1,
"clicked": 0,
"unsubscribed": 0,
"hardbounce": 0,
"softbounce": 0,
"spambounce": 0,
"opened_ctr": 100,
"clicked_ctr": 0,
"utm": 4 fields
}
],
"folder": 1
}

Response fields​

Fields returned in the 200 OK response body.

statisticsobject
Sending and engagement statistics of the campaign.
statistics.real_sender_emailstring
Address the campaign is sent from: the own SMTP server's sender address, the sending domain as name <domain>, or the campaign's sender address; -- if none is set.
statistics.recipientsinteger
Number of contacts the campaign was sent to.
statistics.scheduledinteger
Number of emails scheduled to be sent.
statistics.deliveredinteger
Number of emails delivered.
statistics.delivered_trackedinteger
Number of delivered emails that had open and click tracking on.
statistics.openedinteger
Number of emails opened.
statistics.opened_trackedinteger
Number of opened emails that had open and click tracking on.
statistics.clickedinteger
Number of emails with at least one link clicked.
statistics.clicked_trackedinteger
Number of clicked emails that had open and click tracking on.
statistics.unsubscribedinteger
Number of contacts who unsubscribed from this campaign.
statistics.hardbounceinteger
Number of hard bounces (the address doesn't exist or permanently rejects mail).
statistics.softbounceinteger
Number of soft bounces (a temporary delivery problem, such as a full mailbox).
statistics.spambounceinteger
Number of emails rejected as spam by the receiving server.
statistics.unsub_ratiointeger
Unsubscribed contacts as a percentage of opened emails, rounded up.
statistics.delivered_ratiointeger
Delivered emails as a percentage of recipients.
statistics.delivered_tracked_ratiointeger
Delivered emails with tracking on as a percentage of all delivered emails, rounded up.
statistics.opened_ctrinteger
Opened emails as a percentage of delivered emails.
statistics.opened_tracked_ctrinteger
Opened emails as a percentage of delivered emails with tracking on, rounded up.
statistics.clicked_ctrinteger
Clicked emails as a percentage of opened emails, rounded up.
statistics.clicked_tracked_ctrinteger
Clicked emails as a percentage of opened emails with tracking on, rounded up.
statistics.revenuenumbernullable
Revenue attributed to the campaign.
statistics.webhookinteger
Number of emails whose delivery failed after sending (bounced, rejected as spam or failed for another reason).
statistics.webhooksarray of objects
Failed deliveries grouped by reason; hardbounce, softbounce and spambounce are always listed, with a count of 0 if none.
statistics.webhooks[].failure_reasonstring
Reason the delivery failed, for example hardbounce, softbounce, spambounce, dropped or feedbackloop.
statistics.webhooks[].countinteger
Number of emails that failed for this reason.
statistics.webhooks[].ratiointeger
Emails that failed for this reason as a percentage of delivered emails, to one decimal place; missing when no email was delivered.
statistics.utm_termstringnullable
utm_term added to the campaign's links.
statistics.utm_mediumstringnullable
utm_medium added to the campaign's links.
statistics.utm_sourcestringnullable
utm_source added to the campaign's links.
statistics.utm_campaignstringnullable
utm_campaign added to the campaign's links.
statistics.deferredinteger
Number of emails the receiving server deferred for a later delivery attempt.
statistics.droppedinteger
Number of emails not sent, for example to banned or unsubscribed addresses.
statistics.feedbackloopinteger
Number of spam complaints reported by recipients.
statistics.successinteger
Number of emails with delivery status 2 (success).
statistics.failedinteger
Number of emails with delivery status 3 (failure): sending failed after all retries.
smtpstring
A SMTP settings used for campaign
custom_settingsstring
Sending domain the campaign uses, as name <domain>, or - if it uses none.
real_senderstring
Sender name of the campaign, or the string None if it has none.
namestring
An email campaign name.
typeinteger
An identifier of email campaign type.
statusinteger
An email campaign status.
recipients_countinteger
Number of contacts the campaign is sent to.
closedbooleannullable
true if the campaign was closed because its sending domain or SMTP server was deleted, which stops it from sending; null otherwise.
started_atstring (date-time)
A date when campaign started.
finished_atstring (date-time)
A date when campaign finished.
created_atstring (date-time)
A creation date of email campaign.
updated_atstring (date-time)
A last update of email campaign
idinteger
A unique identifier for the campaign which is given by User
etastring (date-time)
A datetime when email campaign should start. Will start instantly if not provided
descriptionstring
A description of email campaign.
categoryinteger
An email category.
messagesarray of integer
IDs of the email messages used by the campaign.
ab_test_stageinteger
Stage of the A/B test: 0 not an A/B test, 1 sending to the test group, 2 waiting to send the winning variation, 3 or 4 retrying stage 1 or 2, 5 winning variation sent.
ab_test_distributioninteger
Size of the A/B test group as a percentage of recipients; 0 if the campaign isn't an A/B test.
ab_test_winning_metricinteger
Metric that picks the winning variation: 1 opens or 2 clicks.
ab_test_durationinteger
How long the A/B test runs before the winning variation is sent, in hours.
ab_variationsarray of objects
Message variations of the campaign, each with its own statistics.
ab_variations[].idinteger
A unique identifier for the campaign which is given by User
ab_variations[].namestring
An email campaign name.
ab_variations[].preview_filestring (URL)
URL of a rendered preview of this variation.
ab_variations[].message_subjectstring
Subject line of this variation's message.
ab_variations[].message_idinteger
ID of this variation's email message.
ab_variations[].recipientsinteger
Number of contacts the campaign was sent to.
ab_variations[].scheduledinteger
Number of emails scheduled to be sent.
ab_variations[].deliveredinteger
Number of emails delivered.
ab_variations[].openedinteger
Number of emails opened.
ab_variations[].clickedinteger
Number of emails with at least one link clicked.
ab_variations[].unsubscribedinteger
Number of contacts who unsubscribed from this campaign.
ab_variations[].hardbounceinteger
Number of hard bounces (the address doesn't exist or permanently rejects mail).
ab_variations[].softbounceinteger
Number of soft bounces (a temporary delivery problem, such as a full mailbox).
ab_variations[].spambounceinteger
Number of emails rejected as spam by the receiving server.
ab_variations[].opened_ctrinteger
Opened emails as a percentage of delivered emails.
ab_variations[].clicked_ctrinteger
Clicked emails as a percentage of opened emails, rounded up.
ab_variations[].utmobject
UTM parameters added to this variation's links.
ab_variations[].utm.utm_termstringnullable
utm_term added to the campaign's links.
ab_variations[].utm.utm_mediumstringnullable
utm_medium added to the campaign's links.
ab_variations[].utm.utm_sourcestringnullable
utm_source added to the campaign's links.
ab_variations[].utm.utm_campaignstringnullable
utm_campaign added to the campaign's links.
folderinteger
ID of the folder the campaign is in, or null.
note

Errors that can come from any endpoint (401, 429, 500, 502, 504) are described in HTTP response codes.