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.

Servers

https://api.pipedrive.com/v1

Query parameters

Name Type Required Description

filter_id

Integer

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

field_key

String

Yes

The date field key which deals will be retrieved from

start_date

String

Yes

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

interval

String

Yes

The type of the interval

Value	Description
`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`

Possible values:

"month"
"day"
"week"
"quarter"

exclude_deals

Number

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

Possible values:

amount

Integer

Yes

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

pipeline_id

Integer

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

user_id

Integer

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

totals_convert_currency

String

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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.