For more information on using API

GET http://webapi.mymarketing.co.il/api/campaignreports/{id}/complaints?Groupid={Groupid}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Get a Campaign Complaints

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id

integer

Required

group_id

Filter by Group id

integer
from_date

The first date the contacts you want were created

date
to_date

The last date the contacts you want were created.(Default values is 3 last months)

date
page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results.

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiCampaignComplaintsList

Name

Description

Type

Additional information

total_complaints

total_complaints = Total number of contacts who reported the email as spam for the entrire campaign.

integer
total_complaint_rate

total_complaint_rate = Total Complaints / Total Delivered contacts for the entrire campaign.

decimal number
selected_complaints

selected_complaints = List of campaign complaints for the search crietria

Collection of ApiCampaignComplaints

Response Formats

application/json, text/json

Sample: 
{
  "total_complaints": 1,
  "total_complaint_rate": 2.1,
  "selected_complaints": [
    {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3"
    },
    {
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiCampaignComplaintsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <selected_complaints>
    <ApiCampaignComplaints>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
    </ApiCampaignComplaints>
    <ApiCampaignComplaints>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
    </ApiCampaignComplaints>
  </selected_complaints>
  <total_complaint_rate>2.1</total_complaint_rate>
  <total_complaints>1</total_complaints>
</ApiCampaignComplaintsList>