Analyze saved Dataplane reports

The administration reports endpoint provides Jira administrators with a REST API for querying and analyzing saved Dataplane Reports across their Jira instance.

This endpoint allows administrators to:

Identify reports that may require attention during migration.
Analyze report usage patterns.
Discover unused, outdated, or complex reports.
Audit sharing and configuration settings at scale.

This is useful when preparing for cloud migration or when reviewing report usage across large Jira instances.

When to use this endpoint

Use the Admin Reports REST API when you need to:

Review report complexity across your instance.
Identify reports that require manual review before migration.
Determine how many reports are actively used on dashboards.
Analyze sharing patterns.
Assess large datasets efficiently without relying on SQL queries.

This endpoint leverages Dataplane’s internal logic to return accurate results, even for complex report configurations.

Access and authentication

You must be a Jira system administrator authenticated through websudo to access the endpoint.

To start an administrator's websudo session go to the Dataplane Reports > Administration page, which will prompt for authentication.

Attempting to access the endpoint without proper authentication or authorization returns a 403 Forbidden error.

Endpoint details

URL

http(s)://<JIRA_ROOT_DOMAIN>/rest/dataplane/latest/admin/reports

Method

GET

Authentication

Required (Jira user session)

Authorization

Jira System Administrator

Response format

JSON

Query parameters

All query parameters are optional.

If no parameters are provided, the endpoint returns all saved Dataplane reports.

Common parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
`owner`	String	Filter by report owner user key	`owner=admin`
`reportTemplate`	String	Filter by report template type	`reportTemplate=issueHistory`
`lastRunMonthsAgo`	Integer	Include only reports executed within the last N months	`lastRunMonthsAgo=3`
`lastModifiedMonthsAgo`	Integer	Include only reports modified within the last N months	`lastModifiedMonthsAgo=6`
`hasCustomizerScript`	Boolean	Filter by the presence of customizer scripts	`hasCustomizerScript=true`
`hasMultipleSegments`	Boolean	Filter by reports with multiple segments	`hasMultipleSegments=true`
`chartType`	String	Filter by chart visualization type	`chartType=columnChart`
`isSharedWithGroup`	Boolean	Filter by reports shared with Jira groups	`isSharedWithGroup=true`
`isSharedWithProject`	Boolean	Filter by reports shared with Jira projects	`isSharedWithProject=true`
`segment`	String	Filter by specific segment type(s). Accepts a comma-separated list of segment keys. A report matches if it contains any of the specified segments.	`segment=grouping.currentProject` or `segment=grouping.currentProject,grouping.issueType`
`isUsedInGadget`	Boolean	Filter by reports used in Jira dashboards	`isUsedInGadget=true`
`maxResults`	Integer	Maximum number of reports to return (defaults to 1000 if not specified). Ignored when `countOnly=true`.	`maxResults=500`
`countOnly`	Boolean	Return only the count of matching reports without report details. When `true`, result limiting is disabled, and all matching reports are counted.	`countOnly=true`

Response format

Standard response (≤ 100 reports)

When the query returns more than 100 reports and countOnly is not set, the endpoint automatically triggers a JSON file download with the filename format: dataplane_reports_YYYYMMDD_HHMMSS.json

The downloaded file contains the same JSON structure as the standard response, formatted with proper indentation for readability.

The maxResults parameter limits the total number of reports returned (defaults to 1000). If you set maxResults to a value less than 100, the file download will not trigger even if all matching reports are returned. The countOnly parameter disables result limiting and file downloads.

If the query returns 100 or fewer reports, the endpoint returns JSON with the following structure:

{
  "count": 1,
  "reports": [
    {
      "id": 12345,
      "guid": "abc123-def456-ghi789",
      "name": "Issue Status Report",
      "reportTemplate": "issueStatus",
      "owner": "admin",
      "createdDate": "2024-01-15T10:30:00Z",
      "modifiedDate": "2024-12-20T14:45:00Z",
      "lastRunDate": "2025-01-02T09:15:00Z",
      "reportUrl": "https://your-jira.com/plugins/servlet/dataplane/report?guid=...",
      "chartType": "columnChart",
      "segments": ["grouping.currentProject", "grouping.issueType"],
      "dashboards": [
        {
          "dashboardId": 10001,
          "dashboardName": "Executive Dashboard"
        }
      ]
    }
  ]
}

Count-only response

When countOnly=true, the endpoint returns only the total number of matching reports:

{
  "count": 42
}

When countOnly=true:

The maxResults parameter is ignored.
All matching reports are counted.
No report details are returned.

File download response (> 100 reports)

When the query returns more than 100 reports (and countOnly is not set), the endpoint automatically triggers a JSON file download with the filename format: dataplane_reports_YYYYMMDD_HHMMSS.json. The downloaded file contains the same JSON structure as the standard response, formatted with proper indentation for readability.

Note: The maxResults parameter limits the total number of reports returned (defaults to 1000). Setting maxResults to a value less than 100 will prevent the file download from triggering, even if all matching reports are returned. The countOnly parameter disables result limiting and file downloads.

General maintenance use cases

Identify reports that haven't been run in the last 12 months:

https://your-jira.com/rest/dataplane/latest/admin/reports?lastRunMonthsAgo=12

Identify reports that are NOT used in any dashboard gadgets:

https://your-jira.com/rest/dataplane/latest/admin/reports?isUsedInGadget=false

Migration assessment use cases

The Admin Reports endpoint is especially useful when preparing for migration to Dashboard Hub.

Only one “Segment By” option is supported in Cloud migrations. Additional segments are ignored.

https://your-jira.com/rest/dataplane/latest/admin/reports?hasMultipleSegments=true

Segmenting by project category, current issue, or Jira issue key may not be supported in certain migration scenarios. Find reports using these segments:

By project category:

https://your-jira.com/rest/dataplane/latest/admin/reports?segment=grouping.projectCategory

By current issue:

https://your-jira.com/rest/dataplane/latest/admin/reports?segment=grouping.currentIssueBy issue key:

https://your-jira.com/rest/dataplane/latest/admin/reports?segment=grouping.issueKey

You can also find reports with any of these unsupported segments in a single query using comma-separated values:

https://your-jira.com/rest/dataplane/latest/admin/reports?segment=grouping.projectCategory,grouping.currentIssue

This will match reports segmented by project category, current issue, or both. You can include all three unsupported segment types:

https://your-jira.com/rest/dataplane/latest/admin/reports?segment=grouping.projectCategory,grouping.currentIssue,grouping.issueKey

Customizer Scripts are not supported in Cloud and are skipped during migration.

https://your-jira.com/rest/dataplane/latest/admin/reports?hasCustomizerScript=true

Multiple pie charts are converted into a single pie chart in Cloud.

https://your-jira.com/rest/dataplane/latest/admin/reports?chartType=pieChart

Reports shared with Jira groups or project roles may be migrated as private reports.

Find all reports shared with groups:

https://your-jira.com/rest/dataplane/latest/admin/reports?isSharedWithGroup=true

Find all reports shared with projects:

https://your-jira.com/rest/dataplane/latest/admin/reports?isSharedWithProject=true

Find all reports shared with either groups or projects:

https://your-jira.com/rest/dataplane/latest/admin/reports?isSharedWithGroup=true&isSharedWithProject=true

To identify reports that may require attention during migration:

https://your-jira.com/rest/dataplane/latest/admin/reports?hasMultipleSegments=true&hasCustomizerScript=true

You can combine the following to identify migration-affected reports currently displayed on dashboards.

https://your-jira.com/rest/dataplane/latest/admin/reports?isUsedInGadget=true

Additional resources

Report Templates

Template Key	Description

Template Key	Description
`issuesTableReport`	Issues Table
`issuesCreatedByDateReport`	Issues Created by Date
`issuesResolvedByDateReport`	Issues Resolved by Date
`issuesByDateReport`	Issues by Date
`issueReportersByDateReport`	Issue Reporters by Date
`timeFromStatusDirectToStatus`	Time to Next Status
`timeFromStatusIndirectToStatus`	Time from Status to Status
`resolutionTimeReport`	Resolution Time
`closureTimeReport`	Closure Time
`statSumByDateReport`	Stat Sum by Date
`currentIssueValuesReport`	Current Issue Values
`historicalSnapshotReport`	Issue Values Snapshots by Date
`historicalFlowReport`	Issue Status Flow
`projectLinksReport`	Project Links
`currentStatSumReport`	Current Stat Sum
`issuesWorkLogReport`	Issues Work Log Table
`workLoggedByDateReport`	Work Logged by Date
`projectWorkLoggedByDateReport`	Project Work Logged by Date
`userWorkLoggedByDateReport`	User Work Logged by Date
`issueValuesSnapshotsSumByDateReport`	Issue Values Snapshots Sum by Date
`flatCurrentReport`	Full Custom Current
`flatHistoricalReport`	Full Custom Historical
`flatTransitionReport`	Full Custom Transition
`pivotTableReport`	Pivot Table
`issuesEnteringStatusByDateReport`	Issues Entering Status by Date
`timeInStatusReport`	Time in Status
`issueAssigneesReport`	Issue Assignees
`issuePrioritiesReport`	Issue Priorities
`issueStatusesReport`	Issue Statuses
`issueAffectsVersionsReport`	Issue Affects Versions
`issueFixVersionsReport`	Issue Fix Versions
`issueComponentsReport`	Issue Components
`issueReportersReport`	Issue Reporters
`issueResolutionsReport`	Issue Resolutions
`issueSecurityLevelsReport`	Issue Security Levels

Chart Types

Chart Type	Description

Chart Type	Description
`table`	Table view
`htmlTable`	HTML Table view
`barChart`	Bar chart
`verticalBarChart`	Vertical bar chart
`nonStackedBarChart`	Grouped bar chart
`verticalNonStackedBarChart`	Vertical grouped bar chart
`relativeBarChart`	Normalized bar chart
`verticalRelativeBarChart`	Vertical normalized bar chart
`pieChart`	Pie chart
`multiPieChart`	Multiple pie chart
`columnChart`	Column chart
`nonStackedColumnChart`	Grouped column chart
`relativeColumnChart`	Normalized column chart
`lineChart`	Line chart
`areaChart`	Area chart
`maxMinChart`	Range chart
`lineDifferenceChart`	Line difference chart

Segment Types

Common segment values for filtering (any field selectable in Dataplane "segment by" can be used):

Segment Key	Description

Segment Key	Description
`grouping.currentProject`	Project
`grouping.issueType`	Issue Type
`grouping.priority`	Priority
`grouping.status`	Status
`grouping.assignee`	Assignee
`grouping.reporter`	Reporter
`grouping.component`	Component
`grouping.label`	Label
`grouping.projectCategory`	Project Category
`grouping.currentIssue`	Issue Key

The segment parameter accepts comma-separated values to filter by multiple segment types. For example, segment=grouping.currentProject,grouping.issueType will match reports segmented by Project or Issue Type (or both). A report matches if it contains any of the specified segments.