For more information on using API

GET http://webapi.mymarketing.co.il/api/campaignreports/{id}/complaints?Groupid={Groupid}&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
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

complaints

Complaints = Contacts who reported the email as spam.

integer
complaints_rate

Complaints Rate = Complaints / Delivered.

decimal number
campaign_complaints

List of campaign complaints

Collection of ApiCampaignComplaints

Response Formats

application/json, text/json

Sample:
{
  "complaints": 1,
  "complaints_rate": 2.1,
  "campaign_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">
  <campaign_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>
  </campaign_complaints>
  <complaints>1</complaints>
  <complaints_rate>2.1</complaints_rate>
</ApiCampaignComplaintsList>