Skip to content

SeriesSaturationVariation

Field Description Type
series Saturation Series data for the requested timeframe and period. array[SeriesSaturationVariationElement]
SeriesSaturationVariationElement
Field Description Type
*value Saturation variation data between actual_period and previous_period. SaturationVariation
*actual_period Date representing the actual period, corresponding to the first day of the period.
day: the day itself.
week: first day of the corresponding week.
month: first day of the corresponding month.
date
*previous_period Date representing the previous period, corresponding to the first day of the period.
day: the day itself.
week: first day of the corresponding week.
month: first day of the corresponding month.
date
SaturationVariation
Field Description Type Examples
*total_offers Total number of offers. Variation
*available_offers Number of available offers. Variation
*saturation Occupancy ratio variation. Variation
Variation
Field Description Type Examples
value Difference between actual value and comparison value. decimal 1.12
variation The explicit variation polarity.
It is null when values are not available in both timeframes.
string POSITIVE
NEUTRAL
NEGATIVE