Graph API Version

Video Poll

Reading

Feature Permissions

NameDescription
Live Video APIThis feature permission may be required.

Embedded video poll

Example

Graph API Explorer
GET /v5.0/{video-poll-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{video-poll-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{video-poll-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{video-poll-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{video-poll-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The poll ID

question
string

The poll question text

show_results
bool

True if this is a Live poll and voting is open and the results show after voting

status
enum {closed, voting_open, results_open}

Live poll status

Edges

EdgeDescription

Options available on this poll

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can make a POST request to polls edge from the following paths:
When posting to this edge, a VideoPoll will be created.

Parameters

ParameterDescription
correct_option
int64

Number of the correct option (in order, starting from 1)

options
array<string>

Text options for users to select in order

Required
question
string

Question text

Required
show_results
boolean

True to show the results after voting, otherwise false

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
option_ids: List [
numeric string
],
}

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can update a VideoPoll by making a POST request to /{video_poll_id}.

Parameters

ParameterDescription
action
enum {ATTACH_TO_VIDEO, CLOSE, SHOW_VOTING, SHOW_RESULTS, DELETE_POLL}

Change state for the poll

Required
show_results
boolean

True if the viewer sees results after voting, false if they do not

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Deleting

You can't perform this operation on this endpoint.