For more information on using API

GET http://webapi.mymarketing.co.il/api/pushcampaign/Campaign/{id}

Get Push campaign by id

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Push campaign id

string

Required

Body Parameters

None.

Response Information

Resource Description

ApiPushCampaignInfoCampaign

Name

Description

Type

Additional information

campaign

send_type_name

string
status_name

string
status_date

date
handled_date

date

Response Formats

application/json, text/json

Sample:
{
  "campaign": {
    "CampaignIndexId": "",
    "id": "e38317f8-f41a-47c1-a089-1145017dd710",
    "parentuserid": 2,
    "title": "sample string 3",
    "subtitle": "sample string 4",
    "priority": 0,
    "sound": 0,
    "fromname": "sample string 5",
    "fromnumber": "sample string 6",
    "name": "sample string 7",
    "content": "sample string 8",
    "isdeleted": true,
    "totalsent": 10,
    "totalsucceeded": 11,
    "totalopens": 12,
    "totalfailed": 13,
    "canunsubscribe": true,
    "totalunsubscribed": 15,
    "unsubscribetext": "sample string 16",
    "removalword": "sample string 17",
    "wizardmaxstep": 64,
    "wizardcurrentstep": 64,
    "statustype": 0,
    "sendingprofileid": 18,
    "totalclicks": 19,
    "totaluniqueclicks": 20,
    "islinktracking": true,
    "sendtype": 1,
    "groupids": [
      1,
      2
    ],
    "restricatedgroupids": [
      1,
      2
    ],
    "restricatedcampaignids": [
      "216f9da0-a23e-45c2-9f05-cec2dddf31f2",
      "a9958f7b-d1d1-4fbb-bdc2-a019a50911d9"
    ],
    "restricatedopenedcampaignids": [
      "4b6c3cf8-fe17-4a73-abed-7c1c11b6a247",
      "31bbc4a5-0962-4039-b282-272d193027c9"
    ],
    "links": [
      {
        "id": "91a6b6ed-ae7f-4bd5-a1bb-26be2fdfc017",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      },
      {
        "id": "91a6b6ed-ae7f-4bd5-a1bb-26be2fdfc017",
        "position": 2,
        "url": "sample string 3",
        "dateCreatedUtc": "2016-12-24T14:12:12"
      }
    ],
    "scheduledtimezoneid": 1,
    "scheduleddateutc": "2016-12-24T14:12:12",
    "datesentutc": "2016-12-24T14:12:12",
    "datecreatedutc": "2016-12-24T14:12:12",
    "dateupdatedutc": "2016-12-24T14:12:12",
    "datedeletedutc": "2016-12-24T14:12:12",
    "schemaid": 23,
    "templateid": "sample string 24",
    "imageurl": "sample string 25",
    "devicetokens": {
      "sample string 1": [
        "sample string 1",
        "sample string 2"
      ],
      "sample string 2": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "sendtoallusers": true,
    "sendtoanonymoususersonly": true,
    "deeplink": "sample string 28"
  },
  "send_type_name": "sample string 1",
  "status_name": "sample string 2",
  "status_date": "2016-12-24T14:12:12",
  "handled_date": "2016-12-24T14:12:12"
}

application/xml, text/xml

Sample:
<ApiPushCampaignInfoCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.PushCampaignReport">
  <campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Domain.PushNotification.Campaign">
    <d2p1:CanUnsubscribe>true</d2p1:CanUnsubscribe>
    <d2p1:Content>sample string 8</d2p1:Content>
    <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
    <d2p1:DateDeletedUtc>2016-12-24T14:12:12</d2p1:DateDeletedUtc>
    <d2p1:DateSentUtc>2016-12-24T14:12:12</d2p1:DateSentUtc>
    <d2p1:DateUpdatedUtc>2016-12-24T14:12:12</d2p1:DateUpdatedUtc>
    <d2p1:DeepLink>sample string 28</d2p1:DeepLink>
    <d2p1:DeviceTokens xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    </d2p1:DeviceTokens>
    <d2p1:FromName>sample string 5</d2p1:FromName>
    <d2p1:FromNumber>sample string 6</d2p1:FromNumber>
    <d2p1:GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:GroupIds>
    <d2p1:Id>e38317f8-f41a-47c1-a089-1145017dd710</d2p1:Id>
    <d2p1:ImageUrl>sample string 25</d2p1:ImageUrl>
    <d2p1:IsDeleted>true</d2p1:IsDeleted>
    <d2p1:IsLinkTracking>true</d2p1:IsLinkTracking>
    <d2p1:Links>
      <d2p1:PushCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>91a6b6ed-ae7f-4bd5-a1bb-26be2fdfc017</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:PushCampaignLink>
      <d2p1:PushCampaignLink>
        <d2p1:DateCreatedUtc>2016-12-24T14:12:12</d2p1:DateCreatedUtc>
        <d2p1:Id>91a6b6ed-ae7f-4bd5-a1bb-26be2fdfc017</d2p1:Id>
        <d2p1:Position>2</d2p1:Position>
        <d2p1:Url>sample string 3</d2p1:Url>
      </d2p1:PushCampaignLink>
    </d2p1:Links>
    <d2p1:Name>sample string 7</d2p1:Name>
    <d2p1:ParentUserId>2</d2p1:ParentUserId>
    <d2p1:Priority>None</d2p1:Priority>
    <d2p1:RemovalWord>sample string 17</d2p1:RemovalWord>
    <d2p1:RestricatedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>216f9da0-a23e-45c2-9f05-cec2dddf31f2</d3p1:guid>
      <d3p1:guid>a9958f7b-d1d1-4fbb-bdc2-a019a50911d9</d3p1:guid>
    </d2p1:RestricatedCampaignIds>
    <d2p1:RestricatedGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:RestricatedGroupIds>
    <d2p1:RestricatedOpenedCampaignIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>4b6c3cf8-fe17-4a73-abed-7c1c11b6a247</d3p1:guid>
      <d3p1:guid>31bbc4a5-0962-4039-b282-272d193027c9</d3p1:guid>
    </d2p1:RestricatedOpenedCampaignIds>
    <d2p1:ScheduledDateUtc>2016-12-24T14:12:12</d2p1:ScheduledDateUtc>
    <d2p1:ScheduledTimeZoneId>1</d2p1:ScheduledTimeZoneId>
    <d2p1:SchemaId>23</d2p1:SchemaId>
    <d2p1:SendToAllUsers>true</d2p1:SendToAllUsers>
    <d2p1:SendToAnonymousUsersOnly>true</d2p1:SendToAnonymousUsersOnly>
    <d2p1:SendType>Regular</d2p1:SendType>
    <d2p1:SendingProfileId>18</d2p1:SendingProfileId>
    <d2p1:Sound>Default</d2p1:Sound>
    <d2p1:StatusType>None</d2p1:StatusType>
    <d2p1:Subtitle>sample string 4</d2p1:Subtitle>
    <d2p1:TemplateId>sample string 24</d2p1:TemplateId>
    <d2p1:Title>sample string 3</d2p1:Title>
    <d2p1:TotalClicks>19</d2p1:TotalClicks>
    <d2p1:TotalFailed>13</d2p1:TotalFailed>
    <d2p1:TotalOpens>12</d2p1:TotalOpens>
    <d2p1:TotalSent>10</d2p1:TotalSent>
    <d2p1:TotalSucceeded>11</d2p1:TotalSucceeded>
    <d2p1:TotalUniqueClicks>20</d2p1:TotalUniqueClicks>
    <d2p1:TotalUnsubscribed>15</d2p1:TotalUnsubscribed>
    <d2p1:UnsubscribeText>sample string 16</d2p1:UnsubscribeText>
    <d2p1:WizardCurrentStep>64</d2p1:WizardCurrentStep>
    <d2p1:WizardMaxStep>64</d2p1:WizardMaxStep>
  </campaign>
  <handled_date>2016-12-24T14:12:12</handled_date>
  <send_type_name>sample string 1</send_type_name>
  <status_date>2016-12-24T14:12:12</status_date>
  <status_name>sample string 2</status_name>
</ApiPushCampaignInfoCampaign>