Create a report from URL

Timetracker allows creating reports directly via URLs. This document provides detailed instructions for constructing these URLs and describes the parameters available for customizing the reports.

This can be useful to share reports with URL-s or integrate Timetracker reports to other apps/interfaces.

Base URL

The base URL for accessing reports is:

https://<my-site>.atlassian.net/plugins/servlet/ac/org.everit.jira.timetracker.plugin/timetracker-page#!/reporting

Replace <my-site> with your own Jira subdomain.

Report Types

The report type is appended to the base URL to specify which report to generate. Supported report types include:

• Details Report: /reporting/details

• Summary Report: /reporting/summary

• Timesheet Report: /reporting/timesheet

• Chart Report: /reporting/chart

Example URL for a summary report:

https://<my-site>.atlassian.net/plugins/servlet/ac/org.everit.jira.timetracker.plugin/timetracker-page#!/reporting/summary

Search Parameters

Reports can be customized using the following optional search parameters:

1. user

One or more Jira account IDs. Filters the report to include worklogs only for specific users.

Example:

user=accountId1&user=accountId2

2. group

One or more group names. Filters the report to include users belonging to specific groups.

Example:

group=developers&group=testers

3. tag

One or more tag names. Filters the report to include only worklogs with specific tags. Use the special value without-tag to include worklogs that do not have any tags.

Example:

tag=feature1&tag=bugfix&tag=without-tag

4. billing

Filters worklogs based on billing type. Acceptable values are billable or non-billable. Ommiting this parameter will include both.

Example:

billing=billable

5. startDate

Specifies the start date for the report in ISO8601 date format (YYYY-MM-DD).

Example:

startDate=2024-01-01

6. endDate

Specifies the end date for the report in ISO8601 date format (YYYY-MM-DD).

Example:

endDate=2024-01-31

7. period

Specifies a dynamic reporting period. If provided, startDate and endDate are ignored.

• Accepted Values:

  • today

  • this-week

  • this-month

  • this-quarter

  • last-week

  • last-7-days

  • last-30-days

  • last-month

Example:

period=this-month

8. jql

Filters the report by applying a Jira Query Language (JQL) expression. Instead of the worklogAuthor and worklogDate fields, use the user, group, startDate, endDate, and period parameters.

Example:

jql=project=ABC AND status="In Progress"

9. run

Automatically runs the report when the URL is opened. The presence of the parameter triggers the action; its value is not required.

Example URLs

Example 1: Simple Details Report for a User

https://example.atlassian.net/plugins/servlet/ac/org.everit.jira.timetracker.plugin/timetracker-page#!/reporting/details?user=acc123&run

Example 2: Summary Report for a Group and Date Range

https://example.atlassian.net/plugins/servlet/ac/org.everit.jira.timetracker.plugin/timetracker-page#!/reporting/summary?group=developers&startDate=2024-01-01&endDate=2024-01-31&run

Example 3: Timesheet Report for the Current Week

https://example.atlassian.net/plugins/servlet/ac/org.everit.jira.timetracker.plugin/timetracker-page#!/reporting/timesheet?period=this-week&run

Example 4: Timesheet Report with Tags, Billing, and JQL

https://example.atlassian.net/plugins/servlet/ac/org.everit.jira.timetracker.plugin/timetracker-page#!/reporting/timesheet?tag=feature1&billing=billable&jql=project=ABC&run