Pipedrive API

Getting access, Developing, Testing

Back to Pipedrive

Get deals summary

Returns a summary of all the deals.

Input

type: object properties: parameters: type: object properties: status: type: string enum: - open - won - lost description: >- Only fetch deals with a specific status. open = Open, won = Won, lost = Lost filter_id: type: integer description: >- <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. user_id: type: integer description: >- Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. stage_id: type: integer description: Only deals within the given stage will be returned

Output

title: getDealsSummaryResponse200 type: object properties: success: type: boolean description: If the response is successful or not data: type: object description: The summary of deals properties: values_total: type: object description: The total values of the deals grouped by deal currency properties: value: type: number description: The total value of deals in the deal currency group count: type: integer description: The number of deals in the deal currency group value_converted: type: number description: >- The total value of deals converted into the company default currency value_formatted: type: string description: The total value of deals formatted with deal currency. E.g. €50 value_converted_formatted: type: string description: The value_converted formatted with deal currency. E.g. US$50.10 weighted_values_total: type: object description: >- The total weighted values of the deals grouped by deal currency. The weighted value is calculated as probability times deal value. properties: value: type: number description: The total weighted value of the deals in the deal currency group count: type: integer description: The number of deals in the deal currency group value_formatted: type: string description: >- The total weighted value of the deals formatted with deal currency. E.g. €50 total_count: type: integer description: The total number of deals total_currency_converted_value: type: number description: The total value of deals converted into the company default currency total_weighted_currency_converted_value: type: number description: >- The total weighted value of deals converted into the company default currency total_currency_converted_value_formatted: type: string description: >- The total converted value of deals formatted with the company default currency. E.g. US$5,100.96 total_weighted_currency_converted_value_formatted: type: string description: >- The total weighted value of deals formatted with the company default currency. E.g. US$5,100.96