single_brand_timeline: Single-Brand Timeline File

View source: R/timeline.R

single_brand_timelineR Documentation

Single-Brand Timeline File

Description

This endpoint is actually a file payload with datapoint by data and metric, so its content can be save to a file on disk or worked on directly.

Usage

single_brand_timeline(region, sector, brand_id, start_date, end_date, scoring,
  moving_average, filters = NULL, metrics = NULL,
  endpoint = "timeline/file.csv")

Arguments

region

A string for the region to which the brand belongs.

sector

A number for the sector to which the brand belongs.

brand_id

A number for the brand_id to which the brand belongs.

start_date

A string in the format YYYY-MM-DD.

end_date

A string in the format YYYY-MM-DD.

scoring

A string containing the scoring option to use (default: "total", "aware", "opinion").

moving_average

A number of the moving_average, in days, to be applied.

filters

A string in the format [:demo_filters][:metric_filters].

metrics

A string containing the specific metrics to include if not all of them are wanted. If you want more than one separate them with a /.

endpoint

A string containing the appropriate endpoint.

Value

A tibble of the single-brand datapoint.


beigebrucewayne/brandindexr documentation built on July 19, 2023, 11:23 p.m.