Performance Analytics API - GET /now/v1/pa/scorecards

This method retrieves Performance Analytics scorecard details.

URL format

Versioned URL: /api/now/v1/pa/scorecards

Default URL: /api/now/pa/scorecards

Supported parameters

Table 1. Supported parameters
Parameter Description
sysparm_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.

See Performance Analytics API Examples for examples of fully-constructed sysparm_uuid values.

sysparm_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.
sysparm_include_scores Set this parameter 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.
sysparm_include_available_breakdowns Set this parameter to true to return all available breakdowns for a scorecard. If a value is not specified, this parameter defaults to false and returns no breakdowns.
sysparm_include_available_aggregates Set this parameter to true to return all available aggregates for a scorecard. If a value is not specified, this parameter defaults to false and returns no aggregates.
sysparm_display_value Data retrieval operation for reference and choice fields.
Based on this value, retrieves the display value and/or the actual value from the database.
  • true returns display values for all 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.
Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905).
sysparm_exclude_reference_link Set this parameter to true to hide additional information provided for reference fields, such as the URI to the reference resource.
sysparm_favorites Set this parameter to true to return only scorecards that are favorites of the querying user.
sysparm_key Set this parameter to true to return only scorecards for key indicators.
sysparm_target Set this parameter to true to return only scorecards that have a target.
sysparm_display Set this parameter 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.
sysparm_contains Enter a comma-separated list of names or descriptions to return only scorecards with a matching value.
sysparm_tags Enter a comma-separated list of sys_id values to return only scorecards with a matching sys_id.
sysparm_per_page Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.
sysparm_page Specify the page number. For example, when querying 20 scorecards with the default sysparm_per_page value (10), specify a sysparm_page value of 2 to retrieve scorecards 11-20.
sysparm_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.
sysparm_sortdir Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order.
sysparm_elements_filter Specify the sys_id of an elements filter to apply that filter to the returned data.
sysparm_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.

Headers

Table 2. Request headers
Header Description
None

Status codes

Table 3. Status codes
Status code Description
200 Indicates the query ran successfully.