Get insights for campaign JSON

post

https://api.delivr.to/campaign/insights

Get notable insights based on a provided campaign JSON (using response from /campaign/{campaignId})

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

as_attachments

boolean

Whether payloads were sent as attachments

as_links

boolean

required

Whether payloads were sent as links

delay

string

required

The delay between each email in seconds

status

string

required

The status of the campaign, e.g. 'Completed'

prefix

string

required

The prefix added to each email subject

requested_start_time

string

required

The epoch time for the campaign to start

campaign_id

string

required

The ID of the campaign

campaign_name

string

required

The name provided for the campaign

recipient

string

required

The recipient email address for the campaign

template_id

string

required

The ID of the template on which the campaign is based

template_name

string

required

The name of the template on which the campaign is based

requester_id

string

required

The ID of the user that requested the campaign

provider

string

required

The mail provider used to send the campaign emails

email_results

boolean

required

Whether the results of this campaign were emailed to the requestor

expiry

string

required

The lifetime of any links generated for the campaign, in minutes

requester_email

string

required

The primary email address of the user that requested the campaign

ownership

string

required

Whether the requesting user ran the campaign, or has access to it by virtue of their team membership

deletable

boolean

required

Whether the user has the required privileges to delete the campaign results

repeat_days

integer

required

The number of days between each repeated campaign, '-1' if not repeated

repeat_for

integer

required

The number of times to repeat the campaign, '-1' if no limit set

parent_campaign_id

string

The original campaign from which this campaign was initiated

campaign_results

array of strings

The number of emails that were sent, delivered and blocked (and/or deleted) respectively

campaign_results

integrations

object

required

Details of the integrations enabled and relevant to the campaign.

emails

array of objects

required

Details of each email that was sent in the campaign

emails*

stats

object

required

Pre-calculated statistics to highlight important trends in the campaign's results

Response

200Successful response for scheduling a campaign