Reports

Get service reports

Changed on

Retrieve aggregated service report data grouped by configurable dimensions.

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

Query parameters

OR

Filters

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

Sort service report

group'billable' | 'billing_type' | 'booking_tracking_enabled' | 'budget' | 'budget_cap_enabled' | 'budget_custom_fields' | 'budget_status' | 'company' | 'custom_fields' | 'date' | 'deal_custom_fields' | 'deal_status' | 'expense_tracking_enabled' | 'limitation_type' | 'organization' | 'origin_deal' | 'pipeline' | 'project' | 'project_type' | 'recurring' | 'responsible' | 'sales_status' | 'section' | 'section_name' | 'service' | 'service_type' | 'stage_status' | 'stage_type' | 'subsidiary' | 'time_tracking_enabled' | 'unit'

Group service report

Response

Collection service report

Example response

{
  "data": [
    {
      "id": "r-010",
      "type": "service_reports",
      "attributes": {
        "budget_total": "50000.00",
        "budget_used": "32000.00",
        "revenue": "38000.00",
        "cost": "24000.00",
        "profit": "14000.00",
        "profit_margin": 0.37,
        "billable_time": 24000,
        "nonbillable_time": 3000,
        "worked_time": 27000,
        "estimated_time": 32000,
        "service_id": 1856422,
        "deal_id": 89,
        "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

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/sales_status_id/oneOf[subschema #1: Operation]/contains of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/sales_status_id/oneOf[subschema #1: Operation]/eq of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/sales_status_id/oneOf[subschema #1: Operation]/not_contain of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/sales_status_id/oneOf[subschema #1: Operation]/not_eq of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/sales_status_id/oneOf[subschema #2: Sales Status]/ of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/stage_status_id/oneOf[subschema #1: Operation]/contains of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/stage_status_id/oneOf[subschema #1: Operation]/eq of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/stage_status_id/oneOf[subschema #1: Operation]/not_contain of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/stage_status_id/oneOf[subschema #1: Operation]/not_eq of the query request parameter filter

    • breaking

      removed the enum value 4.00 from the property oneOf[subschema #2: Filter service report]/stage_status_id/oneOf[subschema #2: Stage Status]/ of the query request parameter filter

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      the /// response's property type changed from integer to boolean 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 object for status

    • breaking

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

    • breaking

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

    • breaking

      the /// response's property type changed from integer to boolean 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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.