v1
latestOpenAPI 3.0.12026-08-0621301.7 MBGet archived deals timeline
Returns 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.
Query parameters
The date when the first interval starts. Format: YYYY-MM-DD.
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>
The number of given intervals, starting from start_date, to fetch. E.g. 3 (months).
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.
Response
Get open and won deals, grouped by the defined interval of time