GET/stats.json

Current User Summary Stats

Returns summary details for the user including Tasks today/late/upcoming, Permissions, Events, Milestones, Projects.


Headers

  • Name
    getPermissions
    Type
    boolean
    Description

    Return Permissions information in the response

    Default
    false
  • Name
    onlyMyProjects
    Type
    boolean
    Description

    Summary of the users Projects only or all Projects

    Default
    false

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "STATUS": "OK",
  "stats": {
    "tasks": {
      "today": "0",
      "late": "0",
      "upcoming": "0"
    },
    "permissions": {
      "canLogTime": true,
      "canAddMilestones": true,
      "canAddTasks": true,
      "canAddMessages": true
    },
    "events": {
      "count": "0",
      "hasEvents": false
    },
    "milestones": {
      "today": "0",
      "late": "1",
      "complete": "20",
      "upcoming": "0",
      "active": "1"
    },
    "projects": {
      "starred": "0",
      "late": "0",
      "count": "10",
      "archived": "90",
      "upcoming": "0",
      "completed": "2",
      "current": "5"
    }
  }
}