Package com.atlassian.jira.dashboarditem.statistics.rest

Class StatisticsResource

java.lang.Object

com.atlassian.jira.dashboarditem.statistics.rest.StatisticsResource

@Path("/statistics")
public class StatisticsResource
extends Object

Statistic searching REST resource.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_ID

Constructor Summary

Constructors

Constructor	Description
StatisticsResource(JiraAuthenticationContext authenticationContext, SearchRequestService searchRequestService, SearchService searchService, StatisticsService statisticsService, StatTypeFactory statTypeFactory)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	twoDimensionalSearch(String jql, Long filterId, String statType, String aggregateType, boolean addEmptyStatTypeToChart)	Complete a two dimensional search on a jql search query or a filter id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FILTER_ID

public static final String FILTER_ID

See Also:

• Constant Field Values

Constructor Details

StatisticsResource

@Inject
public StatisticsResource(JiraAuthenticationContext authenticationContext,
 SearchRequestService searchRequestService,
 SearchService searchService,
 StatisticsService statisticsService,
 StatTypeFactory statTypeFactory)

Method Details

twoDimensionalSearch

@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response twoDimensionalSearch(@QueryParam("jql") @Nullable
 String jql,
 @QueryParam("filterId") @Nullable
 Long filterId,
 @QueryParam("statType") @Nullable
 String statType,
 @QueryParam("aggregateType") @DefaultValue("issuecount")
 String aggregateType,
 @QueryParam("addEmptyStatTypeToChart")
 boolean addEmptyStatTypeToChart)

Complete a two dimensional search on a jql search query or a filter id. The request must provide `jql` or `filterId`. If both are present, `filterId` takes precedence.

Parameters:

jql - (optional) The jql to use for the query.

filterId - (optional) The filterId to use for the query.

statType - The statistic type to group search results by.

aggregateType - Field to aggregate by

addEmptyStatTypeToChart - flag to add issues with empty stat type to the chart (e.g. counting story points by label, if issue has no label, its story points will be shown on pie chart)

Returns:

HTTP response containing an error or the result of the query