Reports - WorkComposer - Time Tracking

Developer API – Reports

Summary report

API Endpoint

https://api.workcomposer.com/v1/report/summary/

Required Variables

Variable	Description
authToken	Must be set to your unique Authentication Token.

Optional Variables

Variable	Description
from	Date and/or time (formatted as “YYYY-MM-DD HH:mm:ss” or “YYYY-MM-DD”). Use this to set the report start date. Default to the beginning of the current day.
to	A date and/or time (formatted as “YYYY-MM-DD HH:mm:ss” or “YYYY-MM-DD”). Use this to set the report end date. Default to the end of the current day.
timezone	A string that specifies a timezone for the API call. Examples: timezone=America/New_York or timezone=Asia/Hong_Kong works for Beijing, timezone=Europe/London works for London, etc.) The parameter is set to your account timezone by default.

Response

Example:

Copy to Clipboard

{
  "status": 1,
  "totalCount": 2,
  "report": [
    {
      "app": [
        {
          "duration": 12066,
          "name": "hbo.com"
        },
        {
          "duration": 8343,
          "name": "Terminal"
        },
        {
          "duration": 6075,
          "name": "www.workcomposer.com"
        },
        {
          "duration": 5936,
          "name": "WorkComposer"
        },
        {
          "duration": 30360,
          "name": "(manual time)"
        }
      ],
      "task": [
        {
          "duration": 72732,
          "name": "No task"
        },
        {
          "duration": 4315,
          "name": "Preparing email marketing campaign"
        },
        {
          "duration": 6641,
          "name": "Test task"
        },
      ],
      "time": {
        "workedTime": 84523,
        "breakTime": 16240,
        "awayTime": 60
      },
      "_user": "5d2f694cd5f2b56918ad0c57"
    },
    {
      "app": [],
      "task": [],
      "time": {
        "workedTime": 0,
        "breakTime": 0,
        "awayTime": 0
      },
      "_user": "5ec7dadaec0c673712a8c305"
    },
  ]
}

Screenshots

API Endpoint

https://api.www.workcomposer.com/v1/report/screenshot/

Required Variables

Variable	Description
authToken	Must be set to your unique Authentication Token.

Optional Variables

Variable	Description
from	Date and/or time (formatted as “YYYY-MM-DD HH:mm:ss” or “YYYY-MM-DD”). Use this to set the report start date. Default to the beginning of the current day.
to	Date and/or time (formatted as “YYYY-MM-DD HH:mm:ss” or “YYYY-MM-DD”). Use this to set the report end date. Default to the end of the current day.
timezone	A string that specifies a timezone for the API call. Examples: timezone=America/New_York, or timezone=Asia/Hong_Kong works for Beijing, timezone=Europe/London works for London, etc.) The parameter is set to your account timezone by default.

Response

Example:

Copy to Clipboard

{
  "status": 1,
  "totalCount": 9,
  "screenshots": [
    {
      "name": "John Doe",
      "_user": "5efda363e8fab251f3f403a0",
      "screenshots": []
    },
    {
      "name": "George Areyan",
      "_user": "5d2f894dd5f2b56d18ad0c56",
      "screenshots": [
        {
          "minuteTimestamp": "2020-08-09T18:06:00+00:00",
          "url": "https://api2.www.workcomposer.com/screenshot/5f313bed2ef7d124fab64592-862d41eb7dc47487f80a3d377b6da1d5.jpg",
          "urlThumbnail": "https://api2.www.workcomposer.com/screenshot/5f303bed2ef7d123fab64592-861d40eb7dc47487f80a3d377b6da1d5-thumb.jpg",
          "usedApps": [],
          "tasks": []
        },
        {
          "minuteTimestamp": "2020-07-21T06:18:00+00:00",
          "url": "https://api2.www.workcomposer.com/screenshot/5f16891649f23c6864e2a76e-776f0beed6f149ce2fecf8553526b14f.jpg",
          "urlThumbnail": "https://api2.www.workcomposer.com/screenshot/5f16891449f23c6874e2a76e-776f0beed6f149ce2fecf8553526b14f-thumb.jpg",
          "usedApps": [],
          "tasks": []
        },
        {
          "minuteTimestamp": "2020-07-18T14:28:00+00:00",
          "url": "https://api2.www.workcomposer.com/screenshot/5f13077207fb70681a1d9a60-8e748e7b2c3c0247cd09fd778633b9be.jpg",
          "urlThumbnail": "https://api2.www.workcomposer.com/screenshot/5f13077107fb70683a1d9a60-8e748e7b2c3c0247cd09fd778633b9be-thumb.jpg",
          "usedApps": [],
          "tasks": []
        }
      ]
    },
    {
      "name": "Mark Rodenhiser",
      "_user": "5b20b0b693be911e427b628f",
      "screenshots": [
        {
          "minuteTimestamp": "2020-08-09T18:13:00+00:00",
          "url": "https://api2.www.workcomposer.com/screenshot/4f303d65c0ad6e2536690a80-2bddf3784c0b4f445b19adf681cf7f6a.jpg",
          "urlThumbnail": "https://api2.www.workcomposer.com/screenshot/4f303d65c0ad6e2536690a80-2bddf3784c0b4f445b19adf681cf7f6a-thumb.jpg",
          "usedApps": [],
          "tasks": []
        },
        {
          "minuteTimestamp": "2020-07-26T20:50:00+00:00",
          "url": "https://api2.www.workcomposer.com/screenshot/5f1ded3063892d4dd468a678-8dca1188805f177f3e3e48100c450626.jpg",
          "urlThumbnail": "https://api2.www.workcomposer.com/screenshot/5f13ed306b892d4dd468a678-8dca1188805f177f3e3e48100c450626-thumb.jpg",
          "usedApps": [],
          "tasks": []
        },
        {
          "minuteTimestamp": "2020-07-23T17:52:00+00:00",
          "url": "https://api2.www.workcomposer.com/screenshot/5f19cec1e3361087097442fa-4fb34434e1fc225d3a09482f7f588199.jpg",
          "urlThumbnail": "https://api2.www.workcomposer.com/screenshot/5f11cec1e336e087097442fa-4fb34434e1fc225d3a09482f7f588199-thumb.jpg",
          "usedApps": [],
          "tasks": []
        },
      ]
    },
  ]
}