PRproductive
Reports

Get proposal reports

Changed on

Returns a paginated list of proposal report records, suitable for building custom proposal analytics.

get/api/v2/reports/proposal_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/proposal_reports
  • Auth
    none declared

Query parameters

OR

Filter proposal reports by specific criteria. Accepts a filter object with field-value pairs.

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

Sort proposal report results by one or more fields. Prefix a field name with a minus sign for descending order.

group'company' | 'created_at' | 'creator' | 'currency' | 'date_signed' | 'deal' | 'link_status' | 'organization' | 'proposal' | 'responsible' | 'sent_at' | 'signed' | 'status' | 'status_changed_at' | 'subsidiary' | 'updated_at'

Group proposal report results by one or more fields.

Response

A paginated collection of proposal report resources.

Example response

{
  "data": [
    {
      "id": "r-024",
      "type": "proposal_reports",
      "attributes": {
        "total": "45000.00",
        "status": "sent",
        "deal_id": 89,
        "company_id": 65111,
        "currency": "USD"
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • 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

  • f11a8740641aRevision changes
    • breaking

      the /// response's property type changed from number to string for status

    • breaking

      the /// response's property type changed from integer to boolean for status

    • breaking

      the /// response's property type changed from string to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.