PRproductive
Reports

Get person reports

Changed on

Retrieve aggregated person report data grouped by configurable dimensions.

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

Query parameters

OR

Filters

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

Sort person report

group'approval_policy' | 'autotracking' | 'company' | 'contact_address' | 'contact_city' | 'contact_country' | 'contact_email' | 'contact_phone' | 'contact_state' | 'contact_website' | 'contact_zipcode' | 'created_at' | 'custom_fields' | 'custom_role' | 'deactivated_at' | 'job_role' | 'joined_at' | 'last_activity_at' | 'manager' | 'month' | 'offboarding_status' | 'organization' | 'person' | 'quarter' | 'role_id' | 'shared_seat' | 'status' | 'subsidiary' | 'type' | 'week' | 'year'

Group person report

Response

Collection person report

Example response

{
  "data": [
    {
      "id": "r-005",
      "type": "person_reports",
      "attributes": {
        "billable_time": 14400,
        "nonbillable_time": 1800,
        "total_time": 16200,
        "utilization": 0.85,
        "capacity": 9600,
        "revenue": "3600.00",
        "cost": "1620.00",
        "person_id": 12,
        "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

      for the query request parameter filter, the type of property oneOf[subschema #2: Filter person report]/person_type/oneOf[subschema #1: Person Type -> subschema #2: Person Type]/ was specialized from string to integer

    • breaking

      for the query request parameter filter, the type of property oneOf[subschema #2: Filter person report]/person_type/oneOf[subschema #2: Operation -> subschema #1: Operation]/contains was specialized from string to integer

    • breaking

      for the query request parameter filter, the type of property oneOf[subschema #2: Filter person report]/person_type/oneOf[subschema #2: Operation -> subschema #1: Operation]/eq was specialized from string to integer

    • breaking

      for the query request parameter filter, the type of property oneOf[subschema #2: Filter person report]/person_type/oneOf[subschema #2: Operation -> subschema #1: Operation]/not_contain was specialized from string to integer

    • breaking

      for the query request parameter filter, the type of property oneOf[subschema #2: Filter person report]/person_type/oneOf[subschema #2: Operation -> subschema #1: Operation]/not_eq was specialized from string to integer

    • 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 integer to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.