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

Get budget chart data.

This returns data for a budget 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
    endDate
    Type
    string
    Description

    end date

  • Name
    budgetType
    Type
    string
    Description

    filter by budget type

    Allowed values
    • all
    • financial
    • time
  • Name
    splitBy
    Type
    object
    Description

    split by entity

    Default
    none
    Allowed values
    • budget.project
    • budget.company
    • budget.type
    • budget.timelog_type
    • budget.category
    • budget.currency
    • budget.status
    • budget.usage
    • project.start_date
    • project.end_date
    • project.created_date
    • project.completed_date
  • Name
    metric
    Type
    object
    Description

    data point

  • Name
    groupBy
    Type
    object
    Description

    group by entity

    Default
    none
    Allowed values
    • budget.project
    • budget.company
    • budget.type
    • budget.timelog_type
    • budget.category
    • budget.currency
    • budget.status
    • budget.usage
    • project.start_date
    • project.end_date
    • project.created_date
    • project.completed_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
    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
  • Name
    budgetStatuses
    Type
    array[string]
    Description

    list of project budget status

    Format
    Comma separated values
    Allowed values
    • all
    • active
    • archived
    • deleted
    • invalid
    • completed
    • upcoming
  • Name
    budgetCategories
    Type
    array[string]
    Description

    filter by budget category

    Default
    all
    Format
    Comma separated values
    Allowed values
    • all
    • retainer
    • standard
    • fixedfee

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    DashboardDataResponse contains information for a specific chart.
  • 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.
  • Code
    500
    Type
    object
    Schema
    Description
    500 Internal Server Error
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

DashboardDataResponse
{
  "data": [
    {}
  ],
  "included": {
    "companies": {
      "additionalProp": {
        "accounts": 0,
        "addressOne": "string",
        "addressTwo": "string",
        "budgetDistribution": [
          {
            "color": "string",
            "companyId": 0,
            "count": 0,
            "from": 0,
            "to": 0
          }
        ],
        "canSeePrivate": true,
        "cid": "string",
        "city": "string",
        "clientManagedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "clients": 0,
        "collaborators": 0,
        "companyDomains": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "companyNameUrl": "string",
        "companyUpdate": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "contacts": 0,
        "countryCode": "string",
        "createdAt": "string",
        "currency": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "emailOne": "string",
        "emailThree": "string",
        "emailTwo": "string",
        "fax": "string",
        "financialBudgetSummary": {
          "totalCapacity": 0,
          "totalCapacityUsed": 0
        },
        "id": 0,
        "industry": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "industryId": 0,
        "isOwner": true,
        "logoUrl": "string",
        "name": "string",
        "phone": "string",
        "privateNotes": "string",
        "privateNotesText": "string",
        "profileText": "string",
        "profitability": {
          "billable": 0,
          "billableTime": 0,
          "companyCount": 0,
          "cost": 0,
          "expenses": 0,
          "expensesBillableTotal": 0,
          "loggedTime": 0,
          "nonBillableTime": 0,
          "ownerCount": 0,
          "profit": 0,
          "profitPercentage": 0,
          "profitTargetPercentage": 0,
          "targetCostsDollars": 0,
          "targetProfitDollars": 0
        },
        "rates": [
          {
            "createdAt": "string",
            "createdByUser": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "rate": {
              "amount": 0,
              "currency": {
                "id": 0,
                "meta": {},
                "type": "string"
              }
            },
            "role": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "updatedAt": "string",
            "updatedByUser": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        ],
        "state": "string",
        "stats": {
          "projectCount": 0,
          "taskCompleteCount": 0,
          "taskCount": 0,
          "unreadEmailCount": 0
        },
        "status": "string",
        "tags": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timeBudgetSummary": {
          "totalCapacity": 0,
          "totalCapacityUsed": 0
        },
        "updatedAt": "string",
        "website": "string",
        "zip": "string"
      }
    },
    "currencies": {
      "additionalProp": {
        "code": "string",
        "decimalPoints": 0,
        "id": 0,
        "name": "string",
        "symbol": "string"
      }
    },
    "projectCategories": {
      "additionalProp": {
        "color": "string",
        "count": 0,
        "id": 0,
        "name": "string",
        "parent": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "parentId": 0
      }
    },
    "projects": {
      "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