deal-pipelines: Deal pipelines endpoint (raw and tidy)

In lockedata/hubspot: Work with Hubspot data

Description

Get raw and tidy results from the deal pipelines endpoint.

Usage

hs_deal_pipelines_raw(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  include_inactive = "EXCLUDE_DELETED"
)

hs_deal_pipelines_tidy(
  deal_pipelines = hs_deal_pipelines_raw(),
  view = c("properties", "stages")
)

Arguments

token_path	Path to OAuth 2.0 token. See hubspot_token_create().
apikey	API key to work with Hubspot (only used if token_path is NULL). See hubspot_key_set().
include_inactive	Should inactive entities be returned
deal_pipelines	A list of pipelines from hs_deal_pipelines_raw
view	A view (see Details)

Details

Inactive pipelines are defined as deleted pipelines.

Different view values and associated output.

• "properties": tibble of pipeline IDs and property values

• "stages": tibble of pipeline IDs and stages

Value

List with deal pipeline data (hs_deal_pipelines_raw())

A tibble with associated entities (hs_deal_pipelines_tidy())

Examples

deal_pipelines <- hs_deal_pipelines_raw()
properties <- hs_deal_pipelines_tidy(
  deal_pipelines,
  view = "properties"
)
stages <- hs_deal_pipelines_tidy(
  deal_pipelines,
  view = "stages"
)

lockedata/hubspot documentation built on March 1, 2020, 8:54 p.m.