provider Deals GET /deals/timeline
@utdk/pipedrive /deals/timeline
Get deals timeline
Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
start_date query required
The date when the first interval starts. Format: YYYY-MM-DD.
string
interval query required
The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
enum: day, week, month, quarter
amount query required
The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
integer
field_key query required
The date field key which deals will be retrieved from
string
user_id query
If supplied, only deals matching the given user will be returned
integer
pipeline_id query
If supplied, only deals matching the given pipeline will be returned
integer
filter_id query
If supplied, only deals matching the given filter will be returned
integer
exclude_deals query
Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
enum: 0, 1
totals_convert_currency query
The 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 the user's default currency is used.
string

Try it

Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getdealstimeline
GET/deals/timeline
Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.

required

The date when the first interval starts. Format: YYYY-MM-DD.

required

The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>

required

The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).

required

The date field key which deals will be retrieved from

If supplied, only deals matching the given user will be returned

If supplied, only deals matching the given pipeline will be returned

If supplied, only deals matching the given filter will be returned

Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.

The 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 the user's default currency is used.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import pipedrive from '@utdk/pipedrive';

await pipedrive.getdealstimeline()