Method :POST

URL: https://apiv1.publicators.com/api/Reports/GetCampaignStatisticByCampaignId

Get campaign statistic by ID

Request Information

URI Parameters

None.

Body Parameters

Json format: ReportGetCampaignByIdBindingeModel

Name	Description	Type	Additional information
Auth	Token	AuthorizationTokenBindingModel	Required
ID	Campaign ID	integer	Required
IsReturnUniqueData	(Optional): Return unique emails with the first timestamp that event occurred for each email	boolean	None.
FilterFromCreated	(Optional): Return all records from timestamp created: yyyy/mm/dd hh:mm:ss	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Auth": {
    "Token": "50de187f-c5bf-4aeb-8d16-205c1e2f406a"
  },
  "ID": 1,
  "IsReturnUniqueData": true,
  "FilterFromCreated": "2025/01/17 02:20:11"
}

Response Information

Resource Description

Json format: ReportGetCampaignStatisticViewModel

ReportGetCampaignStatisticViewModel

Name	Description	Type	Additional information
ID	Campaign ID	integer	None.
SentDate	Campaign sent date	date	None.
TotalMailsSent	Total of mails sent	integer	None.
TotalBounces	Total of unique bounces	integer	None.
TotalClicks	Total click	integer	None.
TotalUniqueClicks	Total unique click	integer	None.
TotalForwards	Total forwards	integer	None.
TotalPurchases	Total purchases transactions. Relevent to customers who deploy Publicators wins module.	integer	None.
TotalOpened	Total opened.	integer	None.
TotalUniqueOpened	Total unique opened.	integer	None.
TotalOpenedFromSmartPhone	Total opened from smart phone	integer	None.
TotalUniqueUnsubscribed	Total unique unsubscribed	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "SentDate": "2025/01/17 02:20:11",
  "TotalMailsSent": 3,
  "TotalBounces": 4,
  "TotalClicks": 5,
  "TotalUniqueClicks": 6,
  "TotalForwards": 7,
  "TotalPurchases": 8,
  "TotalOpened": 9,
  "TotalUniqueOpened": 10,
  "TotalOpenedFromSmartPhone": 11,
  "TotalUniqueUnsubscribed": 12
}