engagements: WIP - Get all engagements (raw and tidy)

In lockedata/hubspot: Work with Hubspot data

Description

Get all of the engagements in a portal. Returns a paginated set of engagements. from the Get all engagements endpoint.

Usage

hs_engagements_raw(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  max_iter = 10
)

hs_engagements_tidy(engagements = hs_engagements_raw(), view = "id")

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().
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
engagements	An engagements object, typically produced by running hs_engagements_raw()
view	A view (see Details)

Details

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

view = "id" returns a list of all engagements, type, created and modified dates listed by ID.

view = "contacts" also returns associated contacts, one contact ID per row

view = "companies" also returns associated companies, one company ID per row

view = "deals" also returns associated deals, one deal ID per row

Value

A list (hs_engagements_raw())

A tibble with associated entities (hs_engagements_tidy())

Examples

engagements <- hs_engagements_raw()
hs_engagements_tidy(engagements)

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