PresetPeriod
Le champ PresetPeriod vous permet de filtrer les réponses d’API selon une liste de périodes prédéfinies. Ce champ peut vous être utile si vous souhaitez appliquer des périodes courantes, comme les sept derniers jours ou le mois en cours. Pour utiliser des périodes personnalisées, utilisez plutôt les paramètres Start et End.
Options disponibles
Voici la liste des options disponibles, catégorisées par type :
Périodes en cours
CurrentDayCurrentWeekCurrentMonthCurrentQuarterCurrentYear
Périodes passées
PreviousDayPreviousWeekPreviousMonthPreviousQuarterPreviousYear
Périodes les plus récentes
En heures :
Last2HoursLast6HoursLast12HoursLast24HoursLast48Hours
En jours :
Last7DaysLast30DaysLast60DaysLast90DaysLast365Days
En mois :
Last3MonthsLast6MonthsLast12MonthsLast24Months
Utiliser le champ PresetPeriod
Pour utiliser le champ PresetPeriod dans une requête d’API, intégrez-le comme un paramètre de requête :
GET https://api.uptrends.com/v4/Statistics/Monitor/ef42495b-26cb-4a2f-8cfc-c933f9716d22?PresetPeriod=PreviousYear
Les périodes passées et les plus récentes incluent uniquement les périodes complètes. Les périodes qui ne sont pas terminées sont exclues.
Exemples
Si vous utilisez la valeur PresetPeriod=Last7Days et que vous envoyez la requête le lundi 20 janvier 2025 à 8h00, vous recevrez les données allant du mardi 13 janvier au dimanche 19 janvier (soit sept journées complètes). Le lundi 20 janvier n’est pas inclus car cette journée n’est pas complète.
De même, si vous utilisez la valeur PresetPeriod=Last12Months et que vous envoyez la requête le 25 janvier 2025, vous obtiendrez les résultats allant de décembre 2023 à décembre 2024, car le mois de janvier n’est pas encore terminé.