Type: Package
Title: Access the 'Windsor.ai' API
Version: 0.1.2
Description: Collect multichannel marketing data from sources such as Google analytics, Facebook Ads, and many others using the 'Windsor.ai' API https://www.windsor.ai/api-fields/.
License: MIT + file LICENSE
URL: https://github.com/windsor-ai/windsoraiR/
BugReports: https://github.com/windsor-ai/windsoraiR/
Depends: R (≥ 2.10)
Imports: jsonlite (≥ 1.7.2)
VignetteBuilder: knitr
Encoding: UTF-8
Language: en-US
RoxygenNote: 7.1.1
Suggests: knitr, rmarkdown, dplyr, ggplot2, tidyr, curl
LazyData: true
NeedsCompilation: no
Packaged: 2021-05-06 12:51:59 UTC; novica
Author: Novica Nakov [aut, cre], Windsor.ai [cph]
Maintainer: Novica Nakov <nnovica@gmail.com>
Repository: CRAN
Date/Publication: 2021-05-10 11:20:02 UTC

Sample data from the Windsor API.

Description

A dataset containing sample gooole and facebook ads data fetched from windsor.ai API. See more at: https://www.windsor.ai/api-fields/

Usage

my_data

Format

A data frame with 1677 rows and 6 variables:

data.campaign

name of the campaign

data.clicks

number of clicks

data.spend

spend data

data.medium

the type of referals

data.source

source of the data (google, facebook, etc.)

googlesheets

googlesheets id

Source

https://www.windsor.ai/


Windsor fetch A function to fetch data from the Windsor.ai API

Description

Windsor fetch A function to fetch data from the Windsor.ai API

Usage

windsor_fetch(
  api_key,
  connector = "all",
  date_preset = "last_7d",
  fields = c("source", "campaign", "clicks", "medium", "sessions", "spend")
)

Arguments

api_key

Your api key to access Windsor.ai API

connector

A connector for the data source. The connector "all" connector blends data from all sources See https://www.windsor.ai/api-fields/ for details.

date_preset

the period for which data is fetched from the API. See https://www.windsor.ai/api-fields/ for details

fields

The fields fetched from the API for a given connector See https://www.windsor.ai/api-fields/ for details.

Value

A data frame containing the desired data.

Examples

## Not run: 
windsor_fetch <- (api_key = "your api key",
connector = "all",
date_preset = "last_7d",
fields = c("source", "campaign", "clicks",
           "medium", "sessions", "spend"))

## End(Not run)