Get deals summary
GET {{baseUrl}}/deals/summary?status=<string>&filter_id=<integer>&user_id=<integer>&stage_id=<integer>
Returns a summary of all the deals.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
status | string | Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. | |
filter_id | string | <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. | |
user_id | string | Only deals matching the given user will be returned. user_id will not be considered if you use filter_id . | |
stage_id | string | Only deals within the given stage will be returned |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":{"values_total":{"EUR":{"value":10,"count":2,"value_converted":11.1,"value_formatted":"€10","value_converted_formatted":"US$11.10"},"USD":{"value":30,"count":3,"value_converted":30,"value_formatted":"US$30","value_converted_formatted":"US$3"}},"weighted_values_total":{"EUR":{"value":10,"count":2,"value_formatted":"€10"},"USD":{"value":30,"count":3,"value_formatted":"US$30"}},"total_count":5,"total_currency_converted_value":41.1,"total_weighted_currency_converted_value":41.1,"total_currency_converted_value_formatted":"US$41.1","total_weighted_currency_converted_value_formatted":"US$41.1"}}