ClockifySettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Clockify connection the step signs in with. |
| Workspace id override | Leave empty to use the workspace on the connection. Pick another workspace the same key can reach, or type its id — the List workspaces node gives you the ids. The id pickers on this node list from it. |
| Period | "ABSOLUTE" or "TODAY" or "YESTERDAY" or "THIS_WEEK" or "LAST_WEEK" or "PAST_TWO_WEEKS" or "THIS_MONTH" or "LAST_MONTH" or "THIS_YEAR" or "LAST_YEAR" |
| From | text |
| To | text |
| Answer as | Rows come back as data you can loop over. Every other choice comes back as a file — which shape Clockify sends that file in is owed one run against a real workspace. |
| Rows | What each row of the grid is. Clockify publishes no list of allowed values, so anything it accepts is accepted here. |
| Rows underneath | What the second level of the grid is. |
| People | Picked from the list Clockify offers. |
| Projects | Picked from the list Clockify offers. |
| Clients | Picked from the list Clockify offers. |
| Tasks | Picked from the list Clockify offers. |
| Tags | Picked from the list Clockify offers. |
| Billable | "" or "true" or "false" |
| Approval | "ALL" or "APPROVED" or "UNAPPROVED" |
| Invoicing | "ALL" or "INVOICED" or "UNINVOICED" |
| Description contains | text |
| Only entries with no description | true/false |
| Round the way the workspace does | true/false |
| Amounts | "HIDE_AMOUNT" or "EARNED" or "COST" or "PROFIT" or "EXPORT" |
| Direction | "ASCENDING" or "DESCENDING" |
| Time zone | text |
| Week starts on | "MONDAY" or "TUESDAY" or "WEDNESDAY" or "THURSDAY" or "FRIDAY" or "SATURDAY" or "SUNDAY" |
| Anything else | Anything else from Clockify's report filter, merged over the fields above. The fields above win only where this leaves a key out. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `clockify`) |
workspaceId | texta value from the vendor's own list |
dateRangeType | "ABSOLUTE" or "TODAY" or "YESTERDAY" or "THIS_WEEK" or "LAST_WEEK" or "PAST_TWO_WEEKS" or "THIS_MONTH" or "LAST_MONTH" or "THIS_YEAR" or "LAST_YEAR", by default "THIS_WEEK" |
dateRangeStart | textused when `dateRangeType` is "ABSOLUTE" |
dateRangeEnd | textused when `dateRangeType` is "ABSOLUTE" |
exportType | "JSON" or "CSV" or "XLSX" or "PDF" or "ZIP", by default "JSON" |
group | text, by default "USER" |
subgroup | text, by default "PROJECT" |
userIds | texta value from the vendor's own list |
projectIds | texta value from the vendor's own list |
clientIds | texta value from the vendor's own list |
taskIds | texta value from the vendor's own list |
tagIds | texta value from the vendor's own list |
billable | "" or "true" or "false" |
approvalState | "ALL" or "APPROVED" or "UNAPPROVED", by default "ALL" |
invoicingState | "ALL" or "INVOICED" or "UNINVOICED", by default "ALL" |
description | text |
withoutDescription | true/false, by default false |
rounding | true/false, by default false |
amountShown | "HIDE_AMOUNT" or "EARNED" or "COST" or "PROFIT" or "EXPORT", by default "HIDE_AMOUNT" |
sortOrder | "ASCENDING" or "DESCENDING", by default "ASCENDING" |
timeZone | text |
weekStart | "MONDAY" or "TUESDAY" or "WEDNESDAY" or "THURSDAY" or "FRIDAY" or "SATURDAY" or "SUNDAY", by default "MONDAY" |
filter | object (any keys), by default {} |
Output
| Field | Type |
|---|---|
weeksGrid rows, one per group | array |
totals | array |
totalsByDayTotals per day | array |
fileReport file, or nothing when the answer is rows | any |
file.base64Report file (base64) | string |
file.name | string |
file.contentType | string |
file.sizeSize in bytes | number |
Sample output, and the expression for each field
- filenull
- totals[]
- totalsByDay[]
- weeks[]
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"amountShown": "HIDE_AMOUNT",
"approvalState": "ALL",
"billable": "",
"clientIds": "",
"connection": "<connection id>",
"dateRangeEnd": "",
"dateRangeStart": "",
"dateRangeType": "THIS_WEEK",
"description": "",
"exportType": "JSON",
"filter": {},
"group": "USER",
"invoicingState": "ALL",
"projectIds": "",
"rounding": false,
"sortOrder": "ASCENDING",
"subgroup": "PROJECT",
"tagIds": "",
"taskIds": "",
"timeZone": "",
"userIds": "",
"weekStart": "MONDAY",
"withoutDescription": false,
"workspaceId": ""
},
"label": "Weekly report",
"type": "clockify.weeklyReport",
"version": 1
}