POST GET emails/search

Search emails by various criteria.

* required

Parameters

Name	Type	Description
deliveryType	string	All searches are filtered by delivery type Default: manual Allowed Values: manual, automated, transactional
status	array[string]	Status only applies when deliveryType is "manual". Ignored for all other deliveryTypes. Default: sent Allowed Values: draft, scheduled, sent
automatedResults	string	AutomatedResults only applies when deliveryType is "automated". Ignored for all other deliveryTypes. Searching by "summary" will return aggregated results for each automated email. Searching by "detail" will return results for each individual send. Default: summary Allowed Values: summary, detail
userID	integer	ID of system user email belongs to
title	string	Searches title field. Use * as a wildcard.
subject	string	Searches subject field. Use * as a wildcard.
dateSentStart	datetime	Emails sent since this date. Defaults to 6 months ago.
dateSentEnd	datetime	Emails sent before this date. Defaults to current date.
emailIDs	array[integer]	Search by emailID (multiples allowed)
parentEmailID	integer	Search by parentEmailID to return the individual sends of an automated or A/B split email.
transactionalCategory	string	Search by transactionalCategory. Only valid when deliveryType is "transactional".
campaignID	integer	Emails assigned to a specific campaign
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 250
sortField	string	The field to sort results by. Default sorting depends on the "status". Sent emails are sorted by dateSent desc (most recently sent first). Scheduled and Draft are sorted by dateAdded desc (newest first). Allowed Values: emailID, userID, title, subject, dateAdded, dateModified, dateSent
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Response Data

Name

Type

Description

emailID

integer

Unique ID of email

deliveryType

string

How email gets delivered. One of: Manual, Automated, Transactional

status

string

Current status of email delivery. One of: Draft, Sent, Scheduled

templateID

integer

ID of template used by email. Set htmlVersionEditable property to true to provide full HTML Version without using a template

userID

integer

ID of system user email belongs to

subject

string

Subject of email

title

string

Title of email (for internal use)

fromName

string

Name used in From header

fromAddress

string

Email address used in From header

replyToName

string

Name used in Reply-to header

replyToAddress

string

Email address used in Reply-to header

dateAdded

datetime

Date record was added

dateModified

datetime

Date record was modified

dateSent

datetime

Date email was sent

metrics

object

Summary deliverability metrics

bounces	integer	Total number of bounces
clickToViewRate	decimal	Percentage of unique contacts who viewed the email and also clicked (unique views / unique clicks)
clicks	integer	Total number of clicks
complaints	integer	Total number of spam complaints
forwards	integer	Total number of forwards (forward-to-friend)
recipients	integer	Total email recipients
sendingIssues	integer	Total number of sending issues
shares	integer	Total number of shares
uniqueClicks	integer	Unique contacts that clicked a link
uniqueForwards	integer	Unique contacts that forwarded email
uniqueShares	integer	Unique contacts that shared email
uniqueViews	integer	Unique contacts that viewed email
uniqueWebViews	integer	Unique contacts that viewed as a web page
unsubscribes	integer	Total number of unsubscribes
views	integer	Total number of views
webViews	integer	Total number of web views

schedule

object

confirmed	boolean	Is schedule delivery confirmed?
dateScheduled	datetime	Date/time of scheduled delivery

parentEmailID

integer

ID of parent email record

abSplitID

integer

ID of A/B split

Example Calls

Sent in past 30 days

GET

/emails/search?status=sent&dateSentStart=2024-03-21

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emails/search?status=sent&dateSentStart=2024-03-21 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":20,"totalPages":1,"totalRecords":3,"prev":""},"records":[{"subject":"API Test","dateAdded":"2013-10-02 21:37:00","fromName":"emfluence","schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2014-02-22 03:54:19","dateSent":"2014-02-22 03:54:19","status":"Sent","emailID":123,"parentEmailID":"","templateID":123,"metrics":{"views":2,"forwards":0,"uniqueViews":2,"webViews":0,"recipients":6,"bounces":0,"uniqueClicks":1,"uniqueForwards":0,"shares":0,"clicks":1,"complaints":0,"unsubscribes":0,"uniqueWebViews":0,"uniqueShares":0},"fromAddress":"support@example.com","replyToName":"","replyToAddress":"","userID":123,"title":"API Test"},{"subject":"Latest News","dateAdded":"2013-02-06 16:51:00","fromName":"emfluence","schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2014-02-22 03:54:18","dateSent":"2014-02-22 03:54:18","status":"Sent","emailID":123,"parentEmailID":"","templateID":123,"metrics":{"views":240,"forwards":0,"uniqueViews":203,"webViews":9,"recipients":1000,"bounces":6,"uniqueClicks":84,"uniqueForwards":0,"shares":0,"clicks":119,"complaints":1,"unsubscribes":1,"uniqueWebViews":8,"uniqueShares":0},"fromAddress":"test@example.com","replyToName":"","replyToAddress":"","userID":123,"title":"Latest News"},{"subject":"Special Offer","dateAdded":"2014-02-11 19:42:58","fromName":"emfluence","schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2014-02-11 19:42:59","dateSent":"2014-02-11 19:42:59","status":"Sent","emailID":123,"parentEmailID":"","templateID":123,"metrics":{"views":301,"forwards":0,"uniqueViews":283,"webViews":28,"recipients":500,"bounces":13,"uniqueClicks":114,"uniqueForwards":0,"shares":0,"clicks":196,"complaints":1,"unsubscribes":3,"uniqueWebViews":24,"uniqueShares":0},"fromAddress":"sales@example.com","replyToName":"","replyToAddress":"","userID":123,"title":"Special Offer"}]},"code":0,"requestID":"E674D8AD-D7BD-43A9-B7E83281B7A5F845"}

Scheduled sends

GET

/emails/search?status=scheduled

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emails/search?status=scheduled \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":20,"totalPages":1,"totalRecords":1,"prev":""},"records":[{"subject":"API Test","dateAdded":"2013-10-02 21:37:00","fromName":"emfluence","schedule":{"dateScheduled":"2015-01-22 16:16:00","confirmed":1},"dateModified":"2014-02-22 03:54:19","dateSent":"","status":"Scheduled","emailID":123,"parentEmailID":"","templateID":123,"metrics":{"views":0,"forwards":0,"uniqueViews":0,"webViews":0,"recipients":0,"bounces":0,"uniqueClicks":0,"uniqueForwards":0,"shares":0,"clicks":0,"complaints":0,"unsubscribes":0,"uniqueWebViews":0,"uniqueShares":0},"fromAddress":"support@example.com","replyToName":"","replyToAddress":"","userID":123,"title":"API Test"}]},"code":0,"requestID":"F49FBF4C-1DA5-4FBE-B6A8171B8C03BF2F"}

Automated Emails - Summary

Returns aggregated results for each automated email. See previous examples for sample response data.

GET

/emails/search?deliveryType=automated&automatedResults=summary

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emails/search?deliveryType=automated&automatedResults=summary \
	-H "Authorization: Bearer {{accessToken}}"

Automated Emails - Detail

Returns individual results for each automated email send. See previous examples for sample response data.

GET

/emails/search?deliveryType=automated&automatedResults=detail

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emails/search?deliveryType=automated&automatedResults=detail \
	-H "Authorization: Bearer {{accessToken}}"

API Console

The console uses production data, so BE CAREFUL!

GET

emails/search

Param	Type	Description
deliveryType	string	All searches are filtered by delivery type Default: manual Allowed Values: manual, automated, transactional
status	array[string]	Status only applies when deliveryType is "manual". Ignored for all other deliveryTypes. Default: sent Allowed Values: draft, scheduled, sent
automatedResults	string	AutomatedResults only applies when deliveryType is "automated". Ignored for all other deliveryTypes. Searching by "summary" will return aggregated results for each automated email. Searching by "detail" will return results for each individual send. Default: summary Allowed Values: summary, detail
userID	integer	ID of system user email belongs to
title	string	Searches title field. Use * as a wildcard.
subject	string	Searches subject field. Use * as a wildcard.
dateSentStart	datetime	Emails sent since this date. Defaults to 6 months ago.
dateSentEnd	datetime	Emails sent before this date. Defaults to current date.
emailIDs	array[integer]	Search by emailID (multiples allowed)
parentEmailID	integer	Search by parentEmailID to return the individual sends of an automated or A/B split email.
transactionalCategory	string	Search by transactionalCategory. Only valid when deliveryType is "transactional".
campaignID	integer	Emails assigned to a specific campaign
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 250
sortField	string	The field to sort results by. Default sorting depends on the "status". Sent emails are sorted by dateSent desc (most recently sent first). Scheduled and Draft are sorted by dateAdded desc (newest first). Allowed Values: emailID, userID, title, subject, dateAdded, dateModified, dateSent
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *