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

 

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