knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

RLeadfeeder

R-CMD-check

The goal of RLeadfeeder is to let you work with Leadfeeder API.

Installation

remotes::install_github("henrywangnl/RLeadfeeder")

Authentication

Leadfeeder API expects an API token to be included in all requests sent to the server.

You can generate your unique authentication token at Leadfeeder API settings.

library(RLeadfeeder)

## Set your Leadfeeder API token
set_token(token = "YOUR_API_TOKEN")

## Check your Leadfeeder API token
get_token()

Get accounts

Retrieve all accounts that you have access to.

get_accounts()

Get feeds

Get all the feeds for an Account.

get_feeds(account_id = "12345")

Get leads

Retrieve a list of leads in an Account on a specific time interval. The total number of results is limited to the first 10000 leads.

get_leads(
  account_id = "12345", 
  start_date = "2020-11-01", 
  end_date = "2020-11-30"
)

Get visits

Retrieve a list of Visits for all Leads from a specific time interval.

get_visits(
   account_id = "12345", 
   start_date = "2020-11-01", 
   end_date = "2020-11-30"
)


henrywangnl/RLeadfeeder documentation built on Jan. 1, 2021, 3:17 a.m.