GET/projects/api/v3/reporting/dashboards/details/estimation.json

Get estimation details.

Returns a paginated list of completed tasks with their estimated vs logged time, accuracy score, and assignees. Supports filtering by status, project, company, task list, and free-text search. Sorting and sideloading of related entities (users, tasks, projects) are also supported.

Query Params

  • Name
    startDate
    Type
    string
    Description

    filter tasks completed on or after this date

  • Name
    searchTerm
    Type
    string
    Description

    filter by task name or project name

  • Name
    orderMode
    Type
    string
    Description

    sort direction

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by field

    Default
    task
    Allowed values
    • task
    • project
    • loggedTime
    • estimatedTime
    • estimationAccuracy
    • completedDate
  • Name
    endDate
    Type
    string
    Description

    filter tasks completed on or before this date

  • Name
    pageSize
    Type
    integer
    Description

    number of items per page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    acceptanceThreshold
    Type
    integer
    Description

    percentage margin within which a task is considered on target (0–100)

    Default
    10
  • Name
    taskListIds
    Type
    array[integer]
    Description

    filter by task list IDs

    Format
    Comma separated values
  • Name
    taskIds
    Type
    array[integer]
    Description

    filter by task IDs

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project IDs

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    related entities to sideload in the response

    Format
    Comma separated values
    Allowed values
    • users
    • tasks
    • projects
  • Name
    filter
    Type
    array[any]
    Description

    filter object body

    Format
    Comma separated values
  • Name
    estimationStatuses
    Type
    array[string]
    Description

    filter by estimation status

    Format
    Comma separated values
    Allowed values
    • overestimated
    • underestimated
    • withinmargin
    • nonestimated
  • Name
    companyIds
    Type
    array[integer]
    Description

    filter by company IDs

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    EstimationDetailsResponse is the response for estimation details endpoint.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

EstimationDetailsResponse
{
  "data": [
    {
      "assignees": [
        {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      ],
      "completedDate": "string",
      "estimatedTime": 0,
      "estimationAccuracy": 0,
      "loggedTime": 0,
      "project": {
        "id": 0,
        "meta": {},
        "type": "string"
      },
      "projectId": 0,
      "task": {
        "id": 0,
        "meta": {},
        "type": "string"
      },
      "taskId": 0,
      "taskStatus": "string"
    }
  ],
  "included": {
    "projects": {
      "additionalProp": {}
    },
    "tasks": {
      "additionalProp": {}
    },
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAccessPortfolio": true,
        "canAddProjects": true,
        "canManagePortfolio": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastLogin": "string",
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "skills": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "userRates": {
          "additionalProp": {
            "amount": 0,
            "currency": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        },
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "data": {},
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  }
}
Download Swagger