fetch_traffic_series-methods: fetch_traffic_series Methods

Description Usage Arguments Examples

Description

fetch_traffic_series Methods

Usage

1
2
3
4
5
6
7
8
fetch_traffic_series(.Object, domain = NULL, platform = "",
  dataseries = "", start_date = "", end_date = "", country_code = "",
  validate_name = TRUE)

## S4 method for signature 'AvenueApiClient'
fetch_traffic_series(.Object, domain = NULL,
  platform = "PC", dataseries = "extension", start_date = "",
  end_date = "", country_code = "US", validate_name = TRUE)

Arguments

.Object

A valid AvenueApiClient connection

domain

character; an length-1 vector of the requested domain name, e.g. "www.google.com"

platform

character; the user's computing platform. Must be one of: 'PC' (desktop browser data), 'mobile' (mobile web browser data), or 'ALL' (mobile + PC).

dataseries

character; currently, the only valid value for this parameter is "extension" (the default). This will be updated as new traffic series are added to the API.

start_date

string; a length-one character vector expressed as 'YYYY-MM-DD' (ISO 8601) representing the start date of the requested series

end_date

string; a length-one character vector expressed as 'YYYY-MM-DD' (ISO 8601) representing the end date of the requested series

country_code

character; the ISO 3166 alpha-2 country_code for which you are requesting traffic data. If left unset, the API returns data for all countries.

validate_name

logical; when TRUE, AvenueAPI checks the supplied domain name against a vector of known/valid names.

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# Get domain traffic data for google.com, US
goog   <- fetch_traffic_series(conection, domain = 'google.com',
                               platform = 'PC',
                               start_date='2014-01-01',
                               country_code = 'US',
                               validate_name = TRUE)

## End(Not run)

sevenpark/AvenueAPI-R documentation built on May 13, 2019, 4:10 a.m.