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

ReportGetCampaignByIdBindingeModel
NameDescriptionTypeAdditional 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": "548c1c83-ebb5-4cc9-8a4c-da2a63506eb8"
  },
  "ID": 1,
  "IsReturnUniqueData": true,
  "FilterFromCreated": "2018/01/19 13:34:01"
}

Response Information

Resource Description

Json format: ReportGetCampaignStatisticViewModel

ReportGetCampaignStatisticViewModel
NameDescriptionTypeAdditional 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": "2018/01/19 13:34:01",
  "TotalMailsSent": 3,
  "TotalBounces": 4,
  "TotalClicks": 5,
  "TotalUniqueClicks": 6,
  "TotalForwards": 7,
  "TotalPurchases": 8,
  "TotalOpened": 9,
  "TotalUniqueOpened": 10,
  "TotalOpenedFromSmartPhone": 11,
  "TotalUniqueUnsubscribed": 12
}