Campaign Results URL Parameters

Parameters are optional unless otherwise noted.

Parameter

Description

Notes

filterStatus

Display contacts whose status matches a status within this field.

String. Defaults to all if the parameter is not specified.

You must specify a value for the parameter if the parameter is included or no contacts are returned. Can be one or more of (case-insensitive):

  • RESERVED
  • HANDLED
  • DRAFT
  • UNREAD
  • DISCARDED
  • QUEUED
  • Multiple status example:

    https://192.168.0.1/ccp-webapp/ccp /

    campaign/ Business_News/results

    ?filterStatus=RESERVED &

    filterStatus=HANDLED

filterTag

Display contacts whose filters matches one or more of the tags in this field.

String. Defaults to all tags if not specified. Example:

https://192.168.0.1/ccp-webapp/ccp

/campaign/Business_News/results

?filterTag=tag1

&filterTag=tag2

includePostWithPostId

Specifies whether or not to display contacts with ID equal to postId.

This option is ignored if postId is not specified. If includePostWithPostId is not specified or is specified and is set to false, the contact with ID equal to postId is not included in the campaign results. If includePostWithPostId is specified and is set to true, the contact with ID equal to postId is included in the campaign results.

postId

The identifier of the userid that made the post.

String. If provided, results are displayed starting after the provided postId. It cannot be used if timestamp or startIndex is specified.

timestamp

A given time and date.

Integer. Displays results older than this timestamp.

Defaults to the time of request if not provided. If startIndex is not specified, then timestamp assumes startIndex = 0.

resultsPerPage

The maximum number of results to be returned.

Integer.

Default is 50 and maximum is 200.

startIndex

The number of results to skip based on the timestamp.

Integer. Used for pagination.

Assuming resultsPerPage is set at the default of 50, you could create a "page 2" link by using the timestamp provided in the href of the feed/link rel="self" and a startIndex of 50. Page 3 would use the same timestamp and a startIndex of 100, and so on.

  • If timestamp is provided and startIndex is not provided, then the results are displayed up to the "resultsPerPage" with a creation date older than "timestamp", starting at index 0.
  • If timestamp is not provided and startIndex is provided, then the results are displayed up to the "resultsPerPage" with a creation date older than "now" starting at startIndex.
  • If postId is provided, then the contact identified by the postId is used as the basis for the search. The social contact for the provided postId does not appear in the results.