GET

Returns the data for a single campaign.

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/campaign/<publicId>?metrics=<true/false>

For more information about <publicId>, see ID Variables.

HTTPS method:

GET

Parameters:

See Campaign API Parameters.

Example XML response:

Note
The" refURL" is a copy of the URL requested.

<Campaign>
  <refURL>
    https://[ServerIP]:[Port]/ccp-webapp/ccp/
    campaign/MyTestCampaign
  </refURL>
  <resultsURL>
    https://[ServerIP]:[Port]/ccp-webapp/ccp/
    campaign/MyTestCampaign/results
  </resultsURL>
  <suggestedTagsURL>
    https://[ServerIP]:[Port]/ccp-webapp/ccp/
    campaign/MyTestCampaign/suggestedtags
  </suggestedTagsURL>
  <publicid>MyTestCampaign</publicid>
  <description>This is my test campaign</description>
  <includeExpr>Cisco Expert Advisor</includeExpr>
  <excludeExpr>ICM</excludeExpr>
  <chatInvitationFeed>
    https://[ServerIP]:[Port]/ccp-webapp/ccp/feed/5000
  </chatInvitationFeed>
  <changeStamp>12345</changeStamp>
  <feeds>
    <feed>
     https://[ServerIP]:[Port]/ccp-webapp/ccp/feed/5000
    </feed>
    <feed>
     https://[ServerIP]:[Port]/ccp-webapp/ccp/feed/5001
    </feed>
  </feeds>
  <filters>
    <filter>
     https://[ServerIP]:[Port]/ccp-webapp/ccp/filter/6000
    </filter>
    <filter>
     https://[ServerIP]:[Port]/ccp-webapp/ccp/filter/6001
    </filter>
  </filters>
  <metrics>
    <socialContactCount>12</socialContactCount>
  </metrics>
</Campaign>

The metrics element contains <socialContactCount>, which is the number of social contacts associated with this campaign .

HTTPS response headers:

 https/1.1 200 OK
  Content-Type: application/xml
  Transfer-Encoding: chunked
  Date: Tue, 12 Jan 2010 16:55:05 GMT