PRproductive
Reports

Get deal reports

Changed on

Retrieve aggregated deal report data grouped by configurable dimensions.

get/api/v2/reports/deal_reports

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/reports/deal_reports
  • Auth
    none declared

Query parameters

OR

Filters

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}
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

Response

Collection deal report

Example response

{
  "data": [
    {
      "id": "r-007",
      "type": "deal_reports",
      "attributes": {
        "total_value": "100000.00",
        "revenue": "75000.00",
        "cost": "45000.00",
        "profit": "30000.00",
        "profit_margin": 0.4,
        "billable_time": 48000,
        "deal_id": 89,
        "currency": "USD"
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • 7dcc2525e812Revision changes
    • info

      added the enum value -applied_scenario_margin to the property items/ of the query request parameter sort

    • info

      added the enum value applied_scenario_margin to the property items/ of the query request parameter sort

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status