Skip to content

Latest commit

 

History

History
121 lines (92 loc) · 5.27 KB

reports.md

File metadata and controls

121 lines (92 loc) · 5.27 KB
Raw

Toggl Reports API v2

Here you can get the general information about how to use Toggl reports API, from how to authenticate, what filters to use and how the response is structured. The available reports are similar to the reports available in Toggl reports page.

More detailed information for the reports.

##URLs##

The reports API base URL is https://toggl.com/reports/api/v2

Weekly report URL GET https://toggl.com/reports/api/v2/weekly

Detailed report URL: GET https://toggl.com/reports/api/v2/details

Summary report URL: GET https://toggl.com/reports/api/v2/summary

For PDF response add .pdf to the end of the URL.

##Rate limiting##

There is rate limiting of 1 request per second (per IP per API token), this limit may change in future. In case client application exceeds rate limit HTTP status 429 will be returned. Excessive requests may yield in stricter limits set upon token/IP combination.

##Authentication##

You can authenticate in the reports API only with your API token. For HTTP Basic Auth you have to add the Authorization header with the request. The token is sent as user name and the string 'api_token' as the password. Whenever possible please use the tools and interfaces provided by your http library to do Basic Auth (for example, curl uses the -u switch for that).

##Request Parameters##

The API expects the request parameters as the query string of the URL.

The following parameters and filters can be used in all of the reports

  • user_agent: string, required, the name of your application or your email address so we can get in touch in case you're doing something wrong.
  • workspace_id: integer, required. The workspace whose data you want to access.
  • since: string, ISO 8601 date (YYYY-MM-DD), by default until - 6 days.
  • until: string, ISO 8601 date (YYYY-MM-DD), by default today
  • billable: possible values: yes/no/both, default both
  • client_ids: client ids separated by a comma, 0 if you want to filter out time entries without a client
  • project_ids: project ids separated by a comma, 0 if you want to filter out time entries without a project
  • user_ids: user ids separated by a comma
  • tag_ids: tag ids separated by a comma, 0 if you want to filter out time entries without a tag
  • task_ids: task ids separated by a comma, 0 if you want to filter out time entries without a task
  • time_entry_ids: time entry ids separated by a comma
  • description: string, time entry description
  • without_description: true/false, filters out the time entries which do not have a description ('(no description)')
  • order_field:
    • date/description/duration/user in detailed reports
    • title/duration/amount in summary reports
    • title/day1/day2/day3/day4/day5/day6/day7/week_total in weekly report
  • order_desc: on/off, on for descending and off for ascending order
  • distinct_rates: on/off, default off
  • rounding: on/off, default off, rounds time according to workspace settings
  • display_hours: decimal/minutes, display hours with minutes or as a decimal number, default minutes

##Successful response##

The general structure of the successful response

  {
    "total_grand":null,
    "total_billable":null,
    "total_currencies":[{"currency":null,"amount":null}],
    "data":[]
  }

The response may include some additional attributes depending on the report type, but the following are present in all of them. The main report data is inside the data array.

  • total_grand: total time in milliseconds for the selected report
  • total_billable: total billable time in milliseconds for the selected report
  • total_currencies: an array with amounts and currencies for the selected report
  • data: an array with detailed information of the requested report. The structure of the data in the array depends on the report.

##Failed requests##

In case of unsuccessful request the API returns the error in JSON and corresponding HTTP status code

  • message: the general message of the occurred error
  • tip: what to do in case of this error
  • code: status code of the response

Example error

  {
    "error": {
      "message":"We are sorry, this Error should never happen to you",
      "tip":"Please contact [email protected] with information on your request",
      "code":500
    }
  }

Notable error codes:

402 Payment Required - feature is not included in current subscription level of
    workspace
410 Gone -  this api version is deprecated. Update your client.
429 Too Many Requests - add delay between requests.

To provide third-party developers with important information, we will use Warning HTTP header in api responses. We recommend to set up automated notifications for Warning headers in all responses, in addition to notifying you about failed requests.

Example warning

Warning:Human readable warning message

There are two test endpoints, that return error so you can test client side error handling: Error 400 and Error 500 both of them set Warning header to test value.