Sign in

v1

latestOpenAPI 3.1.02026-08-066484183.6 MB
Reports

Get deal reports

Retrieve aggregated deal report data grouped by configurable dimensions.

get/api/v2/reports/deal_reports

Query parameters

sortstring[]

Sort deal report

group'company' | 'contact' | 'created_at' | 'creator' | 'custom_fields' | 'date' | 'deal' | 'deal_status' | 'deal_value_source' | 'designated_approver' | 'last_activity_at' | 'lost_reason' | 'month' | 'organization' | 'pipeline' | 'previous_deal_status' | 'primary_contact' | 'project' | 'quarter' | 'responsible' | 'revenue_distribution_base' | 'revenue_distribution_end_on' | 'revenue_distribution_start_on' | 'sales_closed_at' | 'sales_closed_on' | 'sales_status_id' | 'stage_status_id' | 'stage_updated_at' | 'subsidiary' | 'tracking_type_id' | 'week' | 'year'

Group deal report

OR

Filters

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}

Headers

X-Organization-Idstring required

Organization ID

Response

Collection deal report