Type Alias AreaAnalyticsCollectionProperties

Metadata for the area analytics result collection.

type AreaAnalyticsCollectionProperties = {
    endDate: Date;
    frcs: number[];
    heatmap: boolean;
    metrics: AreaAnalyticsMetricKey[];
    ranges: Partial<Record<AreaAnalyticsMetricKey, AreaAnalyticsMetricRange>>;
    startDate: Date;
}

Properties

endDate: Date

End of the analysis period.

frcs: number[]

Functional road classes included in the analysis (0–8).

heatmap: boolean

Whether tile-level heatmap data is included.

Traffic metrics included in the report.

Data-driven min/max value ranges computed from all tile entries. Only metrics present in the tile data will have a range entry.

startDate: Date

Start of the analysis period.