TOtournesol-app
polls

GET /polls/{name}/recommendations/

Changed on

List the recommended entities of a given poll sorted by decreasing total score.

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: http://127.0.0.1:8000/o/token/ scopes: read write groups

Path parameters

namestring required

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

date_ltestring date-time
date_gtestring date-time
searchstring

A search query to filter entities

unsafeboolean

If true, entities considered as unsafe recommendations because of a low score or due to too few contributions will be included.

exclude_compared_entitiesboolean

If true and a user is authenticated, then entities compared by the user will be removed from the response

weightsobject

Weights for criteria in this poll. The default weight is 10 for each criteria.

metadataobject

Filter by one or more metadata.

score_mode'all_equal' | 'default' | 'trusted_only'

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

  • 3bba1a8d6651Revision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 834066e5d795Revision changes
    • warning

      added the new moderation_by_contributors enum value to the ///////////// response property for the response status

    • info

      added the required property // to the response with the status