deals: Deals endpoint (raw and tidy)

In lockedata/hubspot: Work with Hubspot data

Description

Get raw and tidy results from the deals endpoint.

Usage

hs_deals_raw(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  properties = hs_deal_properties_tidy(hs_deal_properties_raw(token_path, apikey)),
  property_history = "true",
  associations = "true",
  max_iter = 10,
  max_properties = 100
)

hs_deals_tidy(
  deals = hs_deals_raw(),
  view = c("associations", "properties history", "properties", "stages history")
)

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().
properties	Character vector of properties to request
property_history	Whether version history for properties should be returned
associations	Retrieve links to other entities
max_iter	The API is limited to a certain number of responses by page, use max_iter to limit how many pages of data will get returned
max_properties	Avoid URLs that are too long, limit the number of properties returned, if required.
deals	A deals list object, typically produced by running hs_deals_raw
view	A view (see Details)

Details

Required scope(s) of the OAuth token: contacts.

Different view values and associated output.

• "associations": A tibble with associated entities

• "properties history": A tibble of all field changes over time

• "properties": A tibble containing all properties of deals

• "stages history": A tibble containing all stages a deal has gone through

Value

List with deals data (hs_deals_raw())

A tibble (hs_deals_tidy())

Examples

deals <- hs_deals_raw(
  property_history = "false",
  max_iter = 1,
  max_properties = 10
)

deals_properties <- hs_deals_tidy(
  deals,
  view = "properties"
  )

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