GET api/v1/EmailDispatches?type={type}&status[0]={status[0]}&status[1]={status[1]}&from={from}&to={to}&take={take}

Will return an array of email dispatches

Request Information

URI Parameters

Name	Description	Type	Additional information
type	Limit the returned dispatches to be of specified type	EmailDispatchType	None.
status	Limit the returned dispatches to be ones with the specified status(es)	Collection of EmailDispatchStatus	None.
from	Limit the returned dispatches to be ones planed after from datetime	date	None.
to	Limit the returned dispatches to be ones planed before to datetime	date	None.
take	Limit number of dispatches returned - always taking newest and removing oldest. The default and max value is 1000.	integer	None.

Body Parameters

None.

Response Information

Resource Description

ReadEmailDispatchDto

Name	Description	Type	Additional information
Id	Id of EmailDispatch	integer	None.
Planned	DateTime of the EmailDispatch to be sent out.	date	None.
PlannedUtc		date	None.
EmailCampaignId		integer	None.
EmailCampaignName		string	None.
Subject		string	None.
Preheader		string	None.
Status	Current status of the EmailDispatch	EmailDispatchStatus	None.
Type		EmailDispatchType	None.
Sent		integer	None.
Delivered		integer	None.
Opens		integer	None.
Clicks		integer	None.
DeliveryRatio		decimal number	None.
OpenedRatio		decimal number	None.
ClickRatio		decimal number	None.
BaseSegment		string	None.
InSegments		Collection of string	None.
NotInSegments		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Planned": "2024-09-13T06:31:42.4320798+00:00",
  "PlannedUtc": "2024-09-13T06:31:42.4320798+00:00",
  "EmailCampaignId": 4,
  "EmailCampaignName": "sample string 5",
  "Subject": "sample string 6",
  "Preheader": "sample string 7",
  "Status": "Waiting",
  "Type": "Test",
  "Sent": 8,
  "Delivered": 9,
  "Opens": 10,
  "Clicks": 11,
  "DeliveryRatio": 12.0,
  "OpenedRatio": 13.0,
  "ClickRatio": 14.0,
  "BaseSegment": "sample string 15",
  "InSegments": [
    "sample string 1",
    "sample string 2"
  ],
  "NotInSegments": [
    "sample string 1",
    "sample string 2"
  ]
}