by-poll-option resource endpoint

URL: /conversations/<id>/responses/@by-poll-option/<id>.<format>

Supported Methods

GET	Retrieve a list of responses in this conversation that match a given poll option identifier.

Query String Arguments

start-index

Index of the first item to return. The first item in the list has index 1.

max-results

Maximum number of items to return in the list response.

start-token

The value of the moreResultsToken property of a previous response, to retrieve more items from the same query.

Resource Type

This endpoint returns an object of type Stream<ConversationResponse>.

entries (array<ConversationResponse>)

The items within the selected range.

estimatedTotalResults (integer)

An estimate of the total number of items in the whole stream of which this object is a chunk. null if a count cannot be determined at all, or if an exact count is returned in totalResults.

moreResultsToken (string)

An opaque token that can be used as the start-token parameter of a followup request to retrieve additional results. null if there are no more results to retrieve, but the presence of this token does not guarantee that the response to a followup request will actually contain results.

totalResults (integer)

The total number of items in the whole stream of which this object is a chunk. null if an exact count cannot be determined.

Client Library Methods for PHP

Retrieve a list of responses in this conversation that match a given poll option identifier.

$tp->conversations->getResponsesByPollOption(array(

    # Required Parameters
    "id" => $id,
    "pollOptionId" => $pollOptionId,

    # Optional Parameters
    "limit" => $limit,
    "offset" => $offset,
    "startToken" => $startToken,

))