For more information on using API

GET https://webapi.mymarketing.co.il/api/Pushcampaignreport/{id}/Delivered?SendType={SendType}&SearchTerm={SearchTerm}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Getting the delivered report (contacts the campaign was delivered to) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" and "to date". (defauly is the last 3 months)

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Push campaign id. Required. Can be found using the endpoint "Get Push campaigns."

string

Required

send_type

integer
search_term

string
from_date

date
to_date

date
page

integer

Range: inclusive between 1 and 2147483647

limit

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiPushCampaignContactsList

Name

Description

Type

Additional information

totalitems

integer
count

integer
campaignreportcrmuserslist

Collection of ApiPushCampaignContacts

Response Formats

application/json, text/json

Sample: 
{
  "totalitems": 2,
  "count": 2,
  "campaignreportcrmuserslist": [
    {
      "crmuserid": 1,
      "firstname": "sample string 2",
      "lastname": "sample string 3",
      "mobilenumber": "sample string 4",
      "email": "sample string 5",
      "devices": 6
    },
    {
      "crmuserid": 1,
      "firstname": "sample string 2",
      "lastname": "sample string 3",
      "mobilenumber": "sample string 4",
      "email": "sample string 5",
      "devices": 6
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiPushCampaignContactsList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>2</TotalItems>
  <Count>2</Count>
  <campaignContacts>
    <ApiPushCampaignContacts>
      <CrmUserId>1</CrmUserId>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <MobileNumber>sample string 4</MobileNumber>
      <Email>sample string 5</Email>
      <Devices>6</Devices>
    </ApiPushCampaignContacts>
    <ApiPushCampaignContacts>
      <CrmUserId>1</CrmUserId>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <MobileNumber>sample string 4</MobileNumber>
      <Email>sample string 5</Email>
      <Devices>6</Devices>
    </ApiPushCampaignContacts>
  </campaignContacts>
</ApiPushCampaignContactsList>