--- title: "Get deals timeline" method: GET path: "/deals/timeline" tags: ["Deals"] --- # Get 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`. ## Query parameters - `start_date` string, date, required - `interval` 'day' | 'week' | 'month' | 'quarter', required - `amount` integer, required - `field_key` string, required - `user_id` integer - `pipeline_id` integer - `filter_id` integer - `exclude_deals` 0 | 1 - `totals_convert_currency` string ## Response `200` Get open and won deals, grouped by the defined interval of time - object - `success` boolean — If the response is successful or not - `data` object — Open and won deals grouped into periods by defined interval, amount and date-type dealField (`field_key`) - `period_start` string — The start date and time of the period - `period_end` string — The end date and time of the period - `deals` object[] - `id` integer — The ID of the deal - `creator_user_id` integer — The ID of the deal creator - `user_id` integer — The ID of the user - `person_id` integer — The ID of the person associated with the deal - `org_id` integer — The ID of the organization associated with the deal - `stage_id` integer — The ID of the deal stage - `title` string — The title of the deal - `value` number — The value of the deal - `currency` string — The currency associated with the deal - `add_time` string — The creation date and time of the deal - `update_time` string — The last updated date and time of the deal - `stage_change_time` string — The last updated date and time of the deal stage - `active` boolean — Whether the deal is active or not - `deleted` boolean — Whether the deal is deleted or not - `is_archived` boolean — Whether the deal is archived or not - `status` string — The status of the deal - `probability` number, nullable — The success probability percentage of the deal - `next_activity_date` string — The date of the next activity associated with the deal - `next_activity_time` string — The time of the next activity associated with the deal - `next_activity_id` integer, nullable — The ID of the next activity associated with the deal - `last_activity_id` integer, nullable — The ID of the last activity associated with the deal - `last_activity_date` string, nullable — The date of the last activity associated with the deal - `lost_reason` string, nullable — The reason for losing the deal - `visible_to` string — The visibility of the deal - `close_time` string, nullable — The date and time of closing the deal - `pipeline_id` integer — The ID of the pipeline associated with the deal - `won_time` string — The date and time of changing the deal status as won - `first_won_time` string — The date and time of the first time changing the deal status as won - `lost_time` string — The date and time of changing the deal status as lost - `products_count` integer — The number of products associated with the deal - `files_count` integer — The number of files associated with the deal - `notes_count` integer — The number of notes associated with the deal - `followers_count` integer — The number of followers associated with the deal - `email_messages_count` integer — The number of emails associated with the deal - `activities_count` integer — The number of activities associated with the deal - `done_activities_count` integer — The number of completed activities associated with the deal - `undone_activities_count` integer — The number of incomplete activities associated with the deal - `participants_count` integer — The number of participants associated with the deal - `expected_close_date` string, date — The expected close date of the deal - `last_incoming_mail_time` string — The date and time of the last incoming email associated with the deal - `last_outgoing_mail_time` string — The date and time of the last outgoing email associated with the deal - `label` string — The label or multiple labels assigned to the deal - `stage_order_nr` integer — The order number of the deal stage associated with the deal - `person_name` string — The name of the person associated with the deal - `org_name` string — The name of the organization associated with the deal - `next_activity_subject` string — The subject of the next activity associated with the deal - `next_activity_type` string — The type of the next activity associated with the deal - `next_activity_duration` string — The duration of the next activity associated with the deal - `next_activity_note` string — The note of the next activity associated with the deal - `formatted_value` string — The deal value formatted with selected currency. E.g. US$500 - `weighted_value` number — Probability times deal value. Probability can either be deal probability or if not set, then stage probability. - `formatted_weighted_value` string — The weighted_value formatted with selected currency. E.g. US$500 - `weighted_value_currency` string — The currency associated with the deal - `rotten_time` string, nullable — The date and time of changing the deal status as rotten - `owner_name` string — The name of the deal owner - `cc_email` string — The BCC email of the deal - `org_hidden` boolean — If the organization that is associated with the deal is hidden or not - `person_hidden` boolean — If the person that is associated with the deal is hidden or not - `origin` string — The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. - `origin_id` string, nullable — The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. - `channel` integer, nullable — The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your Company settings. - `channel_id` string, nullable — The optional ID to further distinguish the Marketing channel. - `arr` number, nullable — Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal - `mrr` number, nullable — Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal - `acv` number, nullable — Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal - `arr_currency` string, nullable — Only available in Growth and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null - `mrr_currency` string, nullable — Only available in Growth and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null - `acv_currency` string, nullable — Only available in Growth and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null - `totals` object — The total values of deals for the given period - `count` integer — The number of deals for the given period - `values` object — The total values of deals grouped by deal currency - `weighted_values` object — The total weighted values of deals for the given period grouped by deal currency. The weighted value of a deal is calculated as probability times deal value. - `open_count` integer — The number of open deals for the given period - `open_values` object — The total values of open deals for the given period grouped by deal currency - `weighted_open_values` object — The total weighted values of open deals for the given period grouped by deal currency. The weighted value of a deal is calculated as probability times deal value. - `won_count` integer — The number of won deals for the given period - `won_values` object — The total values of won deals for the given period grouped by deal currency --- [API](https://skmtc.net/pipedrive/apis/pipedrive-api-v1.md) · [All operations](https://skmtc.net/pipedrive/apis/pipedrive-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedrive/pipedrive-api-v1/revisions/bf863a979545/schema)