GET api/campaign

Retrieves of all campaigns for a given account."

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

None.

Response Information

Successful Response:

Resource Description

Collection of Campaign

Name	Description	Type
id	The campaign Id. Used for any action taken on the campaign or its subscritption.	integer
name	The name by which the user knows the campaign	string
status	The current Campaign Status	string
type	The campaign type	string
landingUrl	Default landing Url for ads	string

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 111,
    "name": "My campaign",
    "status": "Active",
    "type": "Search",
    "landingUrl": "https://www.domain.com"
  },
  {
    "id": 112,
    "name": "Another campaign",
    "status": "Active",
    "type": "Display",
    "landingUrl": "https://sub.domain.com"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <Campaign>
    <id>111</id>
    <landingUrl>https://www.domain.com</landingUrl>
    <name>My campaign</name>
    <status>Active</status>
    <type>Search</type>
  </Campaign>
  <Campaign>
    <id>112</id>
    <landingUrl>https://sub.domain.com</landingUrl>
    <name>Another campaign</name>
    <status>Active</status>
    <type>Display</type>
  </Campaign>
</ArrayOfCampaign>