Report Service

Report Service

On this Page:

 


GetCampaignReport 

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetCampaignReport?BeginDate=01.01.2016&EndDate=02.01.2016

ECOMM: https://api.relateddigital.com/reste/api/report/GetCampaignReport?BeginDate=01.01.2016&EndDate=02.01.2016

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetCampaignReport?BeginDate=01.01.2016&EndDate=02.01.2016

LIVEM: https://api.relateddigital.com/restm/api/report/GetCampaignReport?BeginDate=01.01.2016&EndDate=02.01.2016

Http verb

GET

Parameters

BeginDate(string): The start date of time gap to get reports. (Format: dd.MM.yyyy)

EndDate(string): The end date of time gap to get reports. (Format: dd.MM.yyyy)

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

Sample Body

 

Sample Response

{

  "Campaigns": [

    {

      "Name": "",

      "Subject": "",

      "CustomerTitle": "",

      "CreationDate": "31.07.2015 18:17:25",

      "DeliveryStart": "05.01.2016 11:04:10",

      "DeliveryFinish": "05.01.2016 11:06:20",

      "CampaignId": "",

      "TotalSent": "1",

      "TotalRead": "1",

      "HardBounce": "0",

      "SoftBounce": "0",

      "Other": "0",

      "UniqueRead": "1",

      "UniqueClick": "0",

      "TotalClick": "0",

      "ReadRatio": "100,00",

      "ClickRatio": "0,00",

      "HotmailJunkCount": "0",

      "YahooJunkCount": "0",

      "Lists": "",

      "Status": null,

      "Classification": []

    }

  ],

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,99



GetCampaignDetailedMemberReport 

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetCampaignDetailedMemberReport?CampaignId=1&ReportType=1

ECOMM: https://api.relateddigital.com/reste/api/report/GetCampaignDetailedMemberReport?CampaignId=1&ReportType=1

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetCampaignDetailedMemberReport?CampaignId=1&ReportType=1

LIVEM: https://api.relateddigital.com/restm/api/report/GetCampaignDetailedMemberReport?CampaignId=1&ReportType=1

Http verb

GET

Parameters

CampaignId(string): id of campaign.

ReportType(int):

  Read = 1,

  Clicked = 2,

  Unsubscribed = 3,

  MarkedSpam = 4,

  Bounced = 5

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

Sample Body

 

Sample Response

{

  "Members": [

    "345678987654"  ( MemberID)

  ],

  "Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,76, 99 ,106

 

GetListContent

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetListContent

ECOMM: https://api.relateddigital.com/reste/api/report/GetListContent

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetListContent

LIVEM: https://api.relateddigital.com/restm/api/report/GetListContent

Http verb

POST

Parameters

 

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

GroupName(string): list group name,

ListName(string): list name under groupName.

ListInsertionBeginDate(string):

ListInsertionFinishDate(string):

Map(string):

ZipPassword(string):

NotificationEmail(string):

FtpDetails(FtpInfo):

{

ServerIp(string):

Port(int):

Username(string):

Password(string):

ChangeDir(string):

Secure(bool):

Key(string):

}

 

Sample Body

 {

  "GroupName": "Genel",

  "ListName": "E-Bülten",

  "ListInsertionBeginDate": "20150611 19:29:02",

  "ListInsertionFinishDate": "20170611 19:29:02",

  "Map": "COLUMN1=Adınız",

  "ZipPassword": "ZipPassword",

  "NotificationEmail": "testml@euromsg.com",

  "FtpDetails":

 

{

  "ServerIp": "ServerIP",

  "Port": 0,

  "Username": "Username",

  "Password": "Password",

  "ChangeDir": "ChangeDir",

  "Secure": true,

  "Key": "Key"

}

}

 

Sample Response

{

  "ConversationId": "B47188A576D045F1B5DFDA6E551466FA",

  "Success": true,

  "Errors": [],

  "DetailedMessage": "",

  "TransactionId": "3D6427135C344F0789B77D7C4FF5778F"

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

 

 

GetCampaignReportWithCampId

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetCampaignReportWithCampId?CampId=F543F6FC509942BB9A722DE8A5FB0C89

ECOMM: https://api.relateddigital.com/reste/api/report/GetCampaignReportWithCampId?CampId=F543F6FC509942BB9A722DE8A5FB0C89

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetCampaignReportWithCampId?CampId=F543F6FC509942BB9A722DE8A5FB0C89

LIVEM: https://api.relateddigital.com/restm/api/report/GetCampaignReportWithCampId?CampId=F543F6FC509942BB9A722DE8A5FB0C89

Http verb

GET

Parameters

CampId (string): Id of campaign.

 

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

 

 

Sample Body

 

 

Sample Response

{

  "Campaign": {

    "Name": "test",

    "Subject": "test",

    "CustomerTitle": "Euro Message IT",

    "CreationDate": "10.10.2016 11:11:07",

    "DeliveryStart": "1.01.1900 00:00:00",

    "DeliveryFinish": "",

    "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89",

    "TotalSent": "0",

    "TotalRead": "0",

    "HardBounce": "0",

    "SoftBounce": "0",

    "Other": "0",

    "UniqueRead": "0",

    "UniqueClick": "0",

    "TotalClick": "0",

    "ReadRatio": "0,00",

    "ClickRatio": "0,00",

    "HotmailJunkCount": "0",

    "YahooJunkCount": "0",

    "Lists": "",

    "Status": "OFF",

    "FromAddress": "mert.gumus@euromsg.net",

    "Classification": []

  },

  "Success": true,

  "Errors": [],

  "DetailedMessage": "",

  "TransactionId": "3AF593203D844D76BA267ED72BD56782"

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

 

 

GetEmailCampaignLinks

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetEmailCampaignLinks?CampaignId=4741F11578F9460581931F571958B979

ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailCampaignLinks?CampaignId=4741F11578F9460581931F571958B979

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailCampaignLinks?CampaignId=4741F11578F9460581931F571958B979

LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailCampaignLinks?CampaignId=4741F11578F9460581931F571958B979

Http verb

GET

Parameters

CampaignId (string): Id of campaign.

 

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

 

Sample Body

 

Sample Response

{

  "Links": [

    {

      "LinkID": "1BE3B616C73E4A31911D2EF6F8C0800E",

      "LinkName": "",

      "Link": "http://test.com",

      "LinkType": "T",

      "TotalClickCount": 1,

      "UniqueClickCount": 1

    }

  ],

  "Success": true,

  "Errors": [],

  "DetailedMessage": "",

  "TransactionId": "DDE83BF1DA9848D2A32457F95FDF2F86"

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

 

 

GetEmailCampaignDeliveryStatusReportViaFtp

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetEmailCampaignDeliveryStatusReportViaFtp

ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailCampaignDeliveryStatusReportViaFtp

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailCampaignDeliveryStatusReportViaFtp

LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailCampaignDeliveryStatusReportViaFtp

Http verb

POST

Parameters

 

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

CampaignId(string):

Map(string):

ZipPassword(string):

NotificationEmail(string):

FtpDetails(FtpInfo):

{

ServerIp(string):

Port(int):

Username(string):

Password(string):

ChangeDir(string):

Secure(bool):

Key(string):

}

 

Sample Body

  {

  "CampaignId": "F543F6FC509942BB9A722DE8A5FB0C89",

  "Map": "COLUMN1=Adınız",

  "ZipPassword": "ZipPassword",

  "NotificationEmail": "testml@euromsg.com",

  "FtpDetails":

 

{

  "ServerIp": "ServerIP",

  "Port": 0,

  "Username": "Username",

  "Password": "Password",

  "ChangeDir": "ChangeDir",

  "Secure": true,

  "Key": "Key"

}

}

 

Sample Response

{

  "ConversationId": "AB2DC9A16BEE453480F2EA3D30E2D6EC",

  "Success": true,

  "Errors": [],

  "DetailedMessage": "",

  "TransactionId": "DCA0127D81454B38A33362E27CF1BB48"

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

 


GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp

URL

LIVE: https://api.relateddigital.com/resta/api/report/GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp

ECOMM: https://api.relateddigital.com/reste/api/report/GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp

LIVEB: https://api.relateddigital.com/liveb_rest/api/report/GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp

LIVEM: https://api.relateddigital.com/restm/api/report/GetEmailCampaignDeliveryStatusReportBetweenTwoDatesViaFtp

Http verb

POST

Parameters

 

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

CampaignId(string):

Map(string):

ZipPassword(string):

NotificationEmail(string):

BeginDate(string):

EndDate(string):

FtpDetails(FtpInfo):

{

Copyright 2020 Related Digital