get_flow: get flow

In kianwazzu/cclapi: CCL_API

get flow

Description

This function runs a GET request for the whole length of a given url and flow. CCL is rate-limited to 2000 results, so this function will continue to make requests until the next link is null

Usage

get_flow(flow = NULL, url, key, mutate_flow = TRUE, sum = TRUE)

Arguments

flow	a flow uuid
url	url formatted: "https:://app.communityconnectlabs.com/api/v2/endpoint.json?flow=" url must end in "flow=" can include groups and other queries before "flow="
key	an API token
mutate_flow	TRUE/FALSE if you wish to mutate a flow column. set to false for runs, endpoint
sum	TRUE/FALSE to sum results or not

Value

a dataframe

Examples

#NOT RUN get_flow(flow=uuid12345, url="https://app.communityconnectlabs.com/api/v2/contacts_report.json?flow=",
#key=myAPIkey)

#NOT RUN - With additional query get_flow(flow=uuid12345,url="https://app.communityconnectlabs.com/api/v2/contacts_report.json?group=Opted-Out&flow=",
#key = myAPIkey, sum = TRUE)

kianwazzu/cclapi documentation built on May 31, 2024, 12:30 p.m.