Get Polls

get

https://polls.fanscore.com/v2/polls

Returns a paged, filtered and localised list of polls. Authentication is optional: when a fan bearer token is supplied, the option that fan voted for is flagged as selected on each poll.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

clientId

string

Only return polls belonging to this client (tenant).

page

integer

Defaults to 0

Zero-based index of the page to return.

size

integer

Defaults to 100

Number of items to return per page.

sort

string

Defaults to -validTo

Field to sort by. Prefix with - for descending order. Unknown fields fall back to the default.

from

date-time

Only return polls valid from this instant onwards.

date-time

Only return polls valid up to this instant.

collection

string

enum

Defaults to list

Shape of the returned collection. list returns a flat array; map returns an object keyed by poll type.

Allowed:

source

string

Only return polls from this data provider.

sourceId

string

Only return polls linked to this source (fixture) identifier.

sport

string

Only return polls for this sport.

type

array of objects

Only return polls of these types.

type

Allowed:

tags

competitionId

integer

Only return polls for this competition.

round

integer

Only return polls for this competition round.

active

boolean

When true, return only polls that are currently open for voting; when false, only those that are not.

teamId

string

Only return man-of-the-match polls involving this team.

exclusive

boolean

When true, restrict man-of-the-match polls to the side matching teamId only.

linkedIds

string

Filter by linked external identifiers, formatted as sourceSystem:id1,id2;otherSystem:id3.

linkedIdsOperator

string

enum

Defaults to OR

Whether polls must match all supplied linked identifiers (AND) or any of them (OR).

Allowed:

language

string

Preferred language, given as a BCP-47 code such as en, used to localise poll copy and images.

fallbackLanguages

array of strings

Ordered list of language codes to fall back to when the preferred language has no translation.

fallbackLanguages

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Polls matching the supplied filters

400Bad Request - the request body or query parameters are invalid

401Unauthorized - the bearer token is missing, expired or invalid

500Internal Server Error