GET/projects/api/v3/reporting/dashboards/data/projects.json

Get project chart data.

This returns data for a project chart, using the provided filters, group by, split by and data points.

Query Params

  • Name
    startDate
    Type
    string
    Description

    start date

  • Name
    searchTerm
    Type
    string
    Description

    filter by project name

  • Name
    orderMode
    Type
    string
    Description

    order mode

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

    order by

    Default
    name
    Allowed values
    • startdate
    • duedate
    • datecreated
    • name
  • Name
    metric
    Type
    string
    Description
  • Name
    endDate
    Type
    string
    Description

    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
    splitBy
    Type
    enum
    Description
    Default
    none
    Allowed values
    • project.status
    • project.category
    • project.update_health
    • project.owner
    • project.company
    • project.start_date
    • project.end_date
    • project.created_date
    • project.completed_date
  • Name
    groupBy
    Type
    enum
    Description
    Default
    none
    Allowed values
    • project.status
    • project.category
    • project.update_health
    • project.owner
    • project.company
    • project.start_date
    • project.end_date
    • project.created_date
    • project.completed_date
  • Name
    skipCounts
    Type
    boolean
    Description

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

  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    projectTagIds
    Type
    array[integer]
    Description

    filter by project tag ids

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

    filter by project status

    Format
    Comma separated values
    Allowed values
    • active
    • current
    • late
    • upcoming
    • completed
    • deleted
  • 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
    projectHealths
    Type
    array[integer]
    Description

    filter by project healths

    0: not set 1: bad 2: ok 3: good

    Format
    Comma separated values
    Allowed values
    • 0
    • 1
    • 2
    • 3
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description

    filter by company ids

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

    filter by project category ids

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

    include

    Format
    Comma separated values
    Allowed values
    • projects.categories
    • projects.companies
    • projectOwners

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ContainersResponse contains information about a group of containers.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

ContainersResponse
{
  "containers": [
    {
      "appRoute": "string",
      "createdAt": "string",
      "createdByUser": 0,
      "description": "string",
      "id": 0,
      "isVisible": true,
      "name": "string",
      "ownerId": 0,
      "type": "string",
      "updatedAt": "string",
      "updatedByUser": 0,
      "widgets": [
        {
          "config": "string",
          "createdAt": "string",
          "createdByUser": 0,
          "description": "string",
          "height": 0,
          "id": 0,
          "name": "string",
          "posX": 0,
          "poxY": 0,
          "type": "string",
          "updatedAt": "string",
          "updatedByUser": 0,
          "width": 0
        }
      ]
    }
  ],
  "included": {},
  "meta": {
    "averageSpend": 0,
    "data": {},
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  }
}
Download Swagger