TrackingTime API

Time Entries

This section describes how to retrieve recorded time entries and how to manually update them.

Parameters

Type Parameter Description Required
Integer id Read only
Date start The date time when the user starts tracking the event YES
Date end The date time when the event was stopped YES
String timezone The event's timezone, e.g. 'GMT-02:00' NO
Integer task_id The id of the task this event is associated to YES
Long duration The total duration in seconds Read Only
String formated_duration The duration formated as HH:MM:SS Ready only
String color The project's color Read only
String notes Notes up to 5000 characters allowed NO
String repeat Indicates whether this is a repeating event (time entry) or not. Accepted values: [EVERY_DAY | EVERY_WEEK | EVERY_MONTH | EVERY_YEAR | CUSTOM]. Default: Null (None) NO
Date end_repeat The date the last repeating event (time entry) should be created on. NO
String frequency When choosing custom repeat you need to specify the frequency at which the event occurs: [DAILY | WEEKLY | MONTHLY | YEARLY] NO
Integer repeat_every The number of times the event occurs for the given frequency, e.g. every 5 weeks, every 18 days, every 2 years, etc. NO

JSON Object

{"response":{"status":200,"message":"Request completed successfully."},"data":{
  "start": "2015-11-20 15:00:00",
  "loc_start": "20.11.2015 15:00:00",
  "end": "2015-11-20 18:00:00",
  "loc_end": "20.11.2015 18:00:00",
  "duration": 10800,
  "loc_duration": "03:00",
  "formated_duration": "03:00:00",
  "service": null,
  "service_id": null,
  "customer": null,
  "customer_id": null,
  "project": null,
  "project_id": null,
  "skill": null,
  "skill_id": null,
  "task": "Recent Task",
  "task_id": 21522,
  "user": "Diego Wyllie",
  "user_id": 1,
  "timezone": null,
  "notes": "NOTES",
  "id": 103531,
  "created_at": "2015-11-20 14:23:16",
  "updated_at": "2015-11-20 14:30:43"
}}
                

Available Endpoints

List Time Entries

List all account events filtered by an object type.

Action URL

https://app.trackingtime.co/v2/events

Parameters

Type Parameter Description Required
String filter [SERVICE | CUSTOMER | PROJECT | USER | ACCOUNT | TASK]. Default: USER YES
Integer id The id of the object passed as filter YES
Date from Optional date filter. Defaults to today if not entered. NO
Date to Optional date filter. Defaults to today if not entered. NO
Integer page If you want to paginate your results enter the index of the page you want (0...n) NO
Integer page_size Specifies the number of results included in one page. Default: 50 NO
String order Specifies whether the results should be order by start date ascending or descending. Valid values: ["asc" | "desc"] Default: "asc" NO

Permissions

  • Admins and project managers can always view all account entries
  • Co-workers can be given permission (can_edit_time_entries) to edit time entries (own entries as well as entries they have access to)

Get Time Entry

Retrieve the event with the given id.

Action URL

https://app.trackingtime.co/v2/events/:event_id

Add Time Entry

Add a new time entry.

Action URL

https://app.trackingtime.co/v2/events/add

Parameters

Type Parameter Description Required
Integer task_id The id of the task associated to this event YES
Date start The date time when the user starts tracking the event NO
Date end The date time when the event was stopped NO
String timezone The event's timezone, e.g. 'GMT-03:00' NO
String notes Notes up to 5000 characters allowed NO
String repeat Indicates whether this is a repeating event (time entry) or not. Accepted values: [EVERY_DAY | EVERY_WEEK | EVERY_MONTH | EVERY_YEAR | CUSTOM]. Default: Null (None) NO
Date end_repeat The date the last repeating event (time entry) should be created on. NO
String frequency When choosing custom repeat you need to specify the frequency at which the event occurs: [DAILY | WEEKLY | MONTHLY | YEARLY] NO
Integer repeat_every The number of times the event occurs for the given frequency, e.g. every 5 weeks, every 18 days, every 2 years, etc. NO

Permissions

  • Admins and project managers can always add time entries
  • Co-workers can be given permission (can_edit_time_entries) to edit time entries (own entries as well as entries they have access to)

Update Time Entry

Update an existing time entry.

Action URL

https://app.trackingtime.co/v2/events/update/event_:id

Parameters

Type Parameter Description Required
Integer task_id The id of the task associated to this event NO
Date start The date time when the user starts tracking the event NO
Date end The date time when the event was stopped YES
String timezone The event's timezone, e.g. 'GMT-03:00' NO
String notes Notes up to 5000 characters allowed NO
Boolean update_all In case of a repeating event, indicates whether to update all associated events or not. Default: false NO

Permissions

  • Admins and project managers can always add time entries
  • Co-workers can be given permission (can_edit_time_entries) to edit time entries (own entries as well as entries they have access to)

Delete Time Entry

Delete an existing event.

Action URL

https://app.trackingtime.co/v2/events/delete/:event_id?update_all=true

Parameters

Type Parameter Description Required
Boolean delete_all In case of a repeating event, indicates whether to delete all associated events or not. Default: false NO

Permissions

  • Admins and project managers can always delete time entries
  • Co-workers can be given permission (can_edit_time_entries) to delete time entries (own entries as well as entries they have access to)

Export Time Entries

Export a list of time entries in CSV format. The export contains all event and task parameters.

Action URL

https://app.trackingtime.co/v2/events/export?separator=;&filter=PROJECT&id=1234&from=2016-01-01&to=2016-01-31

Parameters

Type Attribute Description Required
String separator The character to use as separator: ; or , YES
String filter [SERVICE | CUSTOMER | PROJECT | USER | ACCOUNT | TASK]. Default: USER YES
Integer id The id of the object passed as filter YES
Date from Optional date filter NO
Date to Optional date filter NO

Response

CSV Sample File

Permissions

  • Only admins and project managers can export time entries