Reports

Get company reports

Changed on

Retrieve aggregated company report data grouped by configurable dimensions.

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

Query parameters

OR

Filters

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

Sort company report

group'company' | 'contact_address' | 'contact_city' | 'contact_country' | 'contact_email' | 'contact_phone' | 'contact_state' | 'contact_website' | 'contact_zipcode' | 'created_at' | 'custom_fields' | 'last_activity_at' | 'month' | 'organization' | 'parent_company' | 'quarter' | 'status' | 'subsidiary' | 'week' | 'year'

Group company report

Response

Collection company report

Example response

{
  "data": [
    {
      "id": "r-006",
      "type": "company_reports",
      "attributes": {
        "revenue": "250000.00",
        "invoiced": "175000.00",
        "payments": "140000.00",
        "outstanding": "35000.00",
        "billable_time": 120000,
        "company_id": 65111,
        "currency": "USD"
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

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

    • breaking

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

    • breaking

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

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    This list may be incomplete.