PAScorecards parameters

You can set these parameters using the PAScorecards API addParam method.

uuid Enter a colon-separated list of sys_id values to specify which indicators, breakdowns, and aggregates to query. The parameter follows this format:

<indicator sys_id>:<breakdown sys_id>:<element sys_id>:<aggregate sys_id>

The parameter must begin with the sys_id of an indicator record. Optionally, you can append the sys_id values of a breakdown and breakdown element to group the response based on the breakdown, and the sys_id of an aggregate to apply that aggregate. You can use a breakdown with an aggregate, or use only one.

Note: If an indicator is configured to use a Default time series, all scorecards for that indicator use the selected aggregate.
breakdown Enter the sys_id of a breakdown to return chart information organized as defined by the breakdown. For example, enter the sys_id of a priority breakdown to return separate task chart information for each priority value, such as Number of open incidents / Priority / 2 - High.
breakdown_relation Specify the sys_id of a breakdown relation to break down the returned data using that relation. You can view available breakdown relations by setting the sysparm_include_available_breakdowns parameter to true.
elements_filter Specify the sys_id of an elements filter to apply that filter to the returned data.
display Set to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default.
favorites Set to true to return only scorecards that are favorites of the querying user.
key Set to true to return only scorecards for key indicators.
target Set to true to return only scorecards that have a target.
contains Enter a comma-separated list of names or descriptions to return only scorecards with a matching value.
tags Enter a comma-separated list of sys_id values to return only scorecards with a matching sys_id.
per_page Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.
page Specify the page number. For example, when querying 20 scorecards with the default per_page value (10), specify a page value of 2 to retrieve scorecards 11-20.
sortby Specify the value to use when sorting results. Valid values for this parameter are value, change, changeperc, gap, gapperc, duedate, name, order, default, group, indicator_group, frequency, target, date, trend, bullet, and direction. By default, queries sort records by value.
sortdir Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Set this parameter to asc to sort in ascending order.
display_value Data retrieval operation for reference and choice fields.
Based on this value, the display value and/or the actual value in the database are retrieved.
  • true returns display values for all of the fields.
  • false returns actual values from the database. If a value is not specified, this parameter defaults to false.
  • all returns both actual and display values.
exclude_reference_link Set to true to hide additional information provided for reference fields, such as the URI to the reference resource.
include_scores Set to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value.
from Specify the earliest date to return scores from. Only scores from this date or later are returned. The date format must match the ISO-8601 standard.
to Specify the latest date to return scores from. Only scores from this date or earlier are returned. The date format must match the ISO-8601 standard.
step Specify a numeric value to skip scores, based on the indicator frequency. For example, specify a value of 3 to return only scores from every third day for a daily indicator, or from every third week for a weekly indicator.
limit Specify the maximum number of scores to return.
include_available_breakdowns Set to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns.
include_available_aggregates Set to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.
include_realtime Set this parameter to true to return the realtime_enabled element which indicates if real-time scores are enabled for the indicator, and the realtime_value element which contains the real-time score value. This parameter is not supported for formula indicators.
include_target_color_scheme Set this parameter to true to return the target_color_scheme element that contains the minimum and maximum values, and the color of each section of the target color scheme for the scorecard.
include_forecast_Scores Set this parameter to true to return the forecast_scores element that contains an array of date-value pairs that define the forecast data for the scorecard.
include_trendline_scores Set this parameter to true to return the trendline_scores element that contains an array of date-value pairs that define the scorecard trendline.