GET/projects/api/v3/time/report/{type}.json

Get time report by type

Path Params

  • Name
    type
    Type
    integer
    required
    Description

Query Params

  • Name
    type
    Type
    string
    Description

    filter by report type

  • Name
    startDate
    Type
    string
    Description

    filter by start date

  • Name
    searchTerm
    Type
    string
    Description

    filter by search term, searches the name of the type selected

  • Name
    reportType
    Type
    string
    Description

    specifies the report type

    Default
    time
    Allowed values
    • time
    • loggedtime
    • userloggedtime
    • projecttime
  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

  • Name
    projectType
    Type
    string
    Description

    filter results by project type. Leave empty to include all types (e.g. &projectType=)

    Allowed values
    • normal
    • tentative
  • Name
    orderMode
    Type
    string
    Description

    order mode

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

    sort order

    Default
    name
    Allowed values
    • name
    • loggedtime
    • billabletime
    • nonbillabletime
    • billedtime
    • budget
  • Name
    groupBy
    Type
    string
    Description

    determine how report totals are grouped

    Default
    day
    Allowed values
    • day
    • week
    • month
  • Name
    expandedType
    Type
    string
    Description
  • Name
    endDate
    Type
    string
    Description

    filter by end date

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    matchAllTags
    Type
    boolean
    Description

    match all tags

  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report document

  • Name
    includeCompletedTasks
    Type
    boolean
    Description

    include completed tasks

    Default
    true
  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

    Default
    false
  • Name
    expandAllGroups
    Type
    boolean
    Description

    allow to expand all rows

  • Name
    addChart
    Type
    boolean
    Description

    adds chart to export

    Default
    false
  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids

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

    filter by timelog tag ids

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

    filter by team ids

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

    filter by tasklist ids

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

    filter by task ids

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

    filter by company/project/task tag ids

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

    customise the report by selecting columns

    Format
    Comma separated values
    Allowed values
    • company
    • project
    • user
    • tasklist
    • task
    • team
    • loggedtime
    • billabletime
    • billedtime
    • nonbillabletime
    • billablenonbillablesplit
    • budget
    • estimatedtime
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description

    filter by project owner ids

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

    filter by project ids

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

    filter by project category ids set to 0 to filter by projects without a category

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

    filter by job role ids

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

    include

    Format
    Comma separated values
    Allowed values
    • companies
    • projects
    • tasks
    • tasks.parentTasks
    • companies
    • teams
    • users
    • projects.companies
  • Name
    expandedGroupIds
    Type
    array[integer]
    Description

    expanded-related fields are used when generating reports

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

    filter by company ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ReportResponse contains information about a time report.
  • 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

ReportResponse
{  "included": {    "companies": {      "additionalProp": {        "accounts": 0,        "addressOne": "string",        "addressTwo": "string",        "budgetDistribution": [          {            "color": "string",            "companyId": 0,            "count": 0,            "from": 0,            "to": 0          }        ],        "canSeePrivate": true,        "cid": "string",
Download Swagger