Événements les plus populaires
Chaque fois qu'un utilisateur de l'application Amienscope ouvre le détail d'un événement, son nombre de visites est incrémenté.
Il vous est possible de récupérer un listing des événements les plus populaires, c'est-à-dire ceux qui ont été le plus visités par les utilisateurs de l'application Amienscope.
Le listing sera ordonné sur le champ visit_count
de chaque élément (que l'on peut voir dans les champs de retour), en ordre décroissant.
Requête sur l'API
https://api.amienscope.fr/get/popular
Valeurs de retour
Cette requête effectue une requête classique de listing d'une catégorie, par conséquent les champs retournés sont les mêmes que dans un listing catégoriel. Voir le détail sur la page Liste d'événements d'une catégorie.
Pagination et limitation du listing : offset et limit
Par défaut, en l'absence de paramètres de pagination, les listings sont limités à 20 événements à partir du premier.
Dans le cadre d'une navigation par pagination, il vous est possible d'ajouter des paramètres offet et limit à l'URL de la requête afin d'obtenir des listings paginés.
Requête sur l'API
GET https://api.amienscope.fr/get/popular/<offset>,<limit>
Les paramètres offset et limit doivent être des entiers, et obligatoirement passés à l'URL sous le format « offset,limit ».
Par exemple, pour obtenir une liste de 10 événements les plus populaires, à partir du 20ème élément, la requête effectuée sera la suivante :
https://api.amienscope.fr/get/popular/20,10
Annexe : ajouter/supprimer un favori
Suivant les possibilités de votre application, il vous est possible de mentionner une mise en favori (ou sa suppression) d'un événement côté utilisateur.
device_uuid
, qui sera utilisée pour indexer le favori. Retrouvez ce sujet dans le Guide de démarrage.Ajouter un événement en Favori
GET https://api.amienscope.fr/favorite/add/<event_id>
Le paramètre event_id est l'ID d'événement préalablement obtenu par une requête de listing ou de détail.
En cas de succès, l'API renverra simplement la mention "ok"
. Dans le cas contraire, une erreur
sera retournée par l'API (cf. Erreurs).
Enlever un événement des Favoris
GET https://api.amienscope.fr/favorite/remove/<event_id>
Le paramètre event_id est l'ID d'événement préalablement obtenu par une requête de listing ou de détail.
En cas de succès, l'API renverra simplement la mention "ok"
. Dans le cas contraire, une erreur
sera retournée par l'API (cf. Erreurs).
Voir aussi
- /get/categories
- Catégories d'événements utilisées dans l'API
- /get/audiences
- Liste des publics visés utilisés par les événements
- /get/organisers
- Organisateurs d'événements connus de l'API
- /get/events/<id>
- Événements présents dans une catégorie donnée
- /get/from_organiser/<id>
- Événements d'un organisateur donné
- /get/updates/<time>
- Événements mis à jour ou modifiés depuis une date donnée
- /get/event/<id>
- Détail des informations complètes d'un événement spécifique
- /get/highlights
- Événements mis en avant par la collectivité (ou « À la Une »)
- /get/recent
- Événements ajoutés le plus récemment
- /search/<criteria>
- Recherche d'événements par critères spécifiques
- /get/next
- prochains événements à venir, sans distinction de catégorie
- /get/accessibilities
- Liste des formes d'accessibilité disponibles
- /get/from_accessibility
- Liste d'événements correspondant à une forme d'accessibilité