telraamStats (version 1.1.2)

retrieve_sensor: Retrieves data associated with a sensor from the Telraam API

Description

Retrieves data associated with a sensor from the Telraam API. The data is retrieved for a specified time period between start_date and end_date (inclusive).

Usage

retrieve_sensor(segment_name, start_date, end_date, key = get_telraam_token())

Value

Dataframe from Telraam API, enriched with enrich_traffic() function.

Arguments

segment_name

Character. Name of the segment, as specified in config.

start_date

Date. Start date "aaaa-mm-jj", must be of the date type.

end_date

Date. End date "aaaa-mm-jj", must be of the date type.

key

the API key (set by the set_telraam_token() function)

Examples

if (FALSE)  # This function requires a valid API key
period <- as.Date(c('2022-01-01', '2022-12-31'))
retrieve_sensor('RteVitre-06', period[1], period[2])