AmoIncomingLeads: Incoming Leads

In grkhr/amocrm: AmoCRM API client

Description

Function to get incoming leads.

Usage

AmoIncomingLeads(
  email = NULL,
  apikey = NULL,
  domain = NULL,
  auth_list = NULL,
  limit = 500,
  categories = NULL,
  order_by_key = NULL,
  order_by_value = NULL,
  pipeline_id = NULL
)

Arguments

email	Email
apikey	Your api key from settings in interface
domain	Your domain in AmoCRM (xxx in xxx.amocrm.ru)
auth_list	List with auth data, you can build from AmoAuthList
limit	Batch limit, sometimes AmoCRM's API doesn't work properly, you can reduce the value and have a chance to load your data
categories	Filter. Categories. Vector or single value of "sip", "mail", "forms" or "chats".
order_by_key	Filter. Key of ordering. For example "created_at".
order_by_value	Filter. "asc" or "desc". Works if order_by_key is set.
pipeline_id	Filter. You can pass single id and get imcoming leads only from this pipeline. You can get ids from AmoPipelinesStatuses().

Value

Dataframe in output.

References

Please READ this: Function documentation in Russian on GitHub

Also nice to read: AmoCRM official documentation

Examples

## Not run: 
# get all
incleads <- AmoIncomingLeads(auth_list = auth_list)

# filtered
incleads <- AmoIncomingLeads(auth_list = auth_list,
                             categories = c('sip','mail'),
                             order_by_key = 'created_at',
                             order_by_value = 'desc')

## End(Not run)

grkhr/amocrm documentation built on May 24, 2021, 5:24 a.m.