deals.timeline: Get deals timeline

In Rpipedrive: 'Pipedrive API's' Functions to Improvement and Integration's Systems

Description

Function to Get deals timeline from pipedrive.

Usage

deals.timeline(start_date, interval, amount, field_key, user_id = NULL,
  pipeline_id = NULL, filter_id = NULL, exclude_deals = NULL,
  totals_convert_currency = NULL, api_token = NULL,
  company_domain = "api")

Arguments

start_date	Date where first interval starts. Format: YYYY-MM-DD
interval	Type of interval.day = Day; week = A full week (7 days) starting from start_date; month = A full month (depending on the number of days in given month) starting from start_date; quarter = A full quarter (3 months) starting from start_date This field has the following domains: (day; week; month; quarter)
amount	Number of given intervals, starting from start_date, to fetch. E.g. 3 (months).
field_key	The name of the date field by which to get deals by.
user_id	If supplied, only deals matching the given user will be returned.
pipeline_id	If supplied, only deals matching the given pipeline will be returned.
filter_id	If supplied, only deals matching the given filter will be returned.
exclude_deals	Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. This field has the following domains: (0; 1)
totals_convert_currency	3-letter currency code of any of the supported currencies. When supplied, totals_converted is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to 'default_currency' in which case users default currency is used.
api_token	To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference>
company_domain	How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain>

Value

return an object List()

Examples

deals.timeline(start_date='e.g.',interval='e.g.',amount='e.g.',field_key='e.g.')

Rpipedrive documentation built on May 15, 2019, 1:06 a.m.