Saved reports

POST Load the previously saved report

https://api.track.toggl.com/reports/api/v3/shared/{report_token}

Returns the previously saved report.

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token} \
  -H "Content-Type: application/json" \
  -u <email>:<password>

req, err := http.NewRequest(http.MethodPost, 
  "https://api.track.toggl.com/reports/api/v3/shared/{report_token}")
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
req.SetBasicAuth("<email>", "<password>")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    print(err)
}

defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    print(err)
}

fmt.Print(string(body))

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.track.toggl.com/reports/api/v3/shared/{report_token}')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Post.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://api.track.toggl.com/reports/api/v3/shared/{report_token}", {
  method: "POST",
  headers: {
	"Content-Type": "application/json",
	"Authorization": `Basic ${base64.encode(<email>:<password>)}`
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

import requests
from base64 import b64encode

data = requests.post('https://api.track.toggl.com/reports/api/v3/shared/{report_token}', headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

extern crate tokio;
extern crate serde_json;
use reqwest::{Client};
use reqwest::header::{CONTENT_TYPE};

#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
  let client = Client::new().basic_auth("<email>", "<password>");
  let json = client.request(Method::POST, "https://api.track.toggl.com/reports/api/v3/shared/{report_token}".to_string())
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Response

200

Returns report information

name

type

description

detailed_results

name	type	description
report	Array of detailed.GroupedTimeEntry	-
totals	totals.ReportData	-

dictionaries

name	type	description
clients	dictionary.GeneralDictionary	-
filters	dictionary.ReportDictionariesData	Remove it after FlexQ release.
projects	dictionary.ProjectDictionary	-
tags	dictionary.GeneralDictionary	-
tasks	dictionary.TaskDictionary	-
user_groups	dictionary.GeneralDictionary	-
users	dictionary.UserDictionary	-

features

name	type	description
additionalProperties	object	-

fixed_daterange

boolean

hide_amounts

boolean

input_params

name	type	description
additionalProperties	object	-

public

boolean

report_name

string

report_type

string

saved_params

name	type	description
additionalProperties	object	-

summary_results

name	type	description
report	summary.ReportData	-
totals	totals.ReportData	-

weekly_results

name	type	description
report	Array of weekly.DataRow	-
totals	totals.ReportData	-

workspace_logo

string

400

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403

Invalid token

404

Not found

500

report is too big to be exported

POST Export CSV for saved report

https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv

Downloads a previously saved report in csv.

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv \
  -H "Content-Type: application/json" \
  -u <email>:<password>

req, err := http.NewRequest(http.MethodPost, 
  "https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv")
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
req.SetBasicAuth("<email>", "<password>")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    print(err)
}

defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    print(err)
}

fmt.Print(string(body))

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Post.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv", {
  method: "POST",
  headers: {
	"Content-Type": "application/json",
	"Authorization": `Basic ${base64.encode(<email>:<password>)}`
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

import requests
from base64 import b64encode

data = requests.post('https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv', headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

extern crate tokio;
extern crate serde_json;
use reqwest::{Client};
use reqwest::header::{CONTENT_TYPE};

#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
  let client = Client::new().basic_auth("<email>", "<password>");
  let json = client.request(Method::POST, "https://api.track.toggl.com/reports/api/v3/shared/{report_token}.csv".to_string())
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Response

200

Returns report information in csv form

400

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403

Possible error messages:

* Invalid token
* Workspace was not found or the report's owner is no longer active on it

404

Not found

500

parameter \`since\` is missing

POST Export XSLX saved report

https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx

Downloads a previously saved report in xlsx.

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx \
  -H "Content-Type: application/json" \
  -u <email>:<password>

req, err := http.NewRequest(http.MethodPost, 
  "https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx")
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
req.SetBasicAuth("<email>", "<password>")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    print(err)
}

defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    print(err)
}

fmt.Print(string(body))

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Post.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx", {
  method: "POST",
  headers: {
	"Content-Type": "application/json",
	"Authorization": `Basic ${base64.encode(<email>:<password>)}`
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

import requests
from base64 import b64encode

data = requests.post('https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx', headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

extern crate tokio;
extern crate serde_json;
use reqwest::{Client};
use reqwest::header::{CONTENT_TYPE};

#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
  let client = Client::new().basic_auth("<email>", "<password>");
  let json = client.request(Method::POST, "https://api.track.toggl.com/reports/api/v3/shared/{report_token}.xlsx".to_string())
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Response

200

Returns report information in xlsx form

400

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403

Possible error messages:

* Invalid token
* Workspace was not found or the report's owner is no longer active on it

404

Not found

500

parameter \`since\` is missing

POST Export saved report in pdf format

https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf

Authentication

A public report is accessible by anyone, a private one is only accessible by the report's owner or workspace admin. If the criteria aren't met it returns 403 status code.

Parameters

The report can be executed without parameters, and in this case the saved or default parameters will be used.

curl -X POST https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf \
  -H "Content-Type: application/json" \
  -u <email>:<password>

req, err := http.NewRequest(http.MethodPost, 
  "https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf")
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
req.SetBasicAuth("<email>", "<password>")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    print(err)
}

defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    print(err)
}

fmt.Print(string(body))

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Post.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf", {
  method: "POST",
  headers: {
	"Content-Type": "application/json",
	"Authorization": `Basic ${base64.encode(<email>:<password>)}`
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

import requests
from base64 import b64encode

data = requests.post('https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf', headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

extern crate tokio;
extern crate serde_json;
use reqwest::{Client};
use reqwest::header::{CONTENT_TYPE};

#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
  let client = Client::new().basic_auth("<email>", "<password>");
  let json = client.request(Method::POST, "https://api.track.toggl.com/reports/api/v3/shared/{report_token}/pdf".to_string())
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Response

200

Returns report information in pdf form

400

Possible error messages:

* report_type does not exist in params
* The report period is not supported

401

Possible error messages:

* Unable to extract authentication data
* Incorrect username and/or password

403

Possible error messages:

* Invalid token
* Workspace was not found or the report's owner is no longer active on it

404

Not found

500

parameter \`since\` is missing

POST Load the previously saved report​

Response​

200​

400​

401​

403​

404​

500​

POST Export CSV for saved report​

Response​

200​

400​

401​

403​

404​

500​

POST Export XSLX saved report​

Response​

200​

400​

401​

403​

404​

500​

POST Export saved report in pdf format​

Response​

200​

400​

401​

403​

404​

500​

POST Load the previously saved report

Response

200

400

401

403

404

500

POST Export CSV for saved report

Response

200

400

401

403

404

500

POST Export XSLX saved report

Response

200

400

401

403

404

500

POST Export saved report in pdf format

Response

200

400

401

403

404

500