|
sysparm\_breakdown
|
Sys\_id of a breakdown to return chart information organized as defined by the breakdown. For example, the sys\_id of a priority breakdown to return separate task chart information for each priority value, such as the number of open incidents / Priority / 2 - High.Data type: String
|
|
sysparm\_breakdown\_relation
|
Sys\_id of a breakdown relation to break down the returned data using that relation.Data type: String
|
|
sysparm\_contains
|
Comma-separated list of names or descriptions to return results only from indicators with a matching value. All the comma-separated list items must match, or no results are returned: The list follows AND logic, not OR logic.Data type: String
|
|
sysparm\_display
|
Flag that indicates the type of indicators to return.Valid values:
- true: Return only indicators that display on the Analytics Hub.
- all: Return all indicators.
Data type: String
Default: true
|
|
sysparm\_display\_value
|
Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences.If returning display values, the value that is returned is dependent on the field type.
- Choice fields: The database value may be a number, but the display value will be more descriptive.
- Date fields: The database value is in UTC format, while the display value is based on the user's time zone.
- Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context.
- Reference fields: The database value is sys\_id, but the display value is a display field of the referenced record.
Data type: String
Valid values:
- true: Returns the display values for all fields.
- false: Returns the actual values from the database.
- all: Returns both actual and display values.
Default: false
**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\).](https://support.servicenow.com/kb_view.do?sysparm_article=KB0534905)
|
|
sysparm\_elements\_filter
|
Sys\_id of an elements filter to apply to the returned data.Data type: String
|
|
sysparm\_exclude\_reference\_link
|
Flag that indicates whether to hide additional information provided for reference fields, such as the URI to the reference resource.Valid values:
- true: Hide additional information provided for reference fields.
- false: Do not hide additional information provided for reference fields.
Data type: Boolean
Default: false
|
|
sysparm\_favorites
|
Flag that indicates whether to return only indicators that are favorites of the querying user.Valid values:
- true: Return only indicators that are favorites of the querying user.
- false: Return all indicators.
Data type: Boolean
Default: false
|
|
sysparm\_from
|
Earliest date to return scores from. Only scores from this date or later are returned. This parameter requires that **include\_scores** is set to `true`.
Format: ISO-8601 standard
Date type: String
|
|
sysparm\_include\_aggregates
|
Flag that indicates whether to return all possible aggregates for an indicator, including aggregates that have already been applied.Valid values:
- true: Return all possible aggregates for an indicator, including aggregates that have already been applied.
- false: Return no aggregates.
Data type: Boolean
Default: false
|
|
sysparm\_include\_available\_aggregates
|
Flag that indicates whether to return all available aggregates for an indicator when no aggregate has been applied.Valid values:
- true: Return all available aggregates for an indicator when no aggregate has been applied.
- false: Return no aggregates.
Data type: Boolean
Default: false
|
|
sysparm\_include\_available\_breakdowns
|
Flag that indicates whether to return all available breakdowns for an indicator.Valid values:
- true: Return all available breakdowns for an indicator.
- false: Return no breakdowns.
Data type: Boolean
Default: false
|
|
sysparm\_include\_forecast\_scores
|
Flag that indicates whether to return the forecast\_scores element that contains an array of date-value pairs that define the forecast data for the Analytics Hub. This parameter requires that the **include\_scores** parameter is also set to `true`.
Valid values:
- true: Return the forecast\_scores element.
- false: Do not return the forecast\_scores element.
Data type: Boolean
Default: false
|
|
sysparm\_include\_realtime
|
Flag that indicates whether 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.Valid values:
- true: Return the realtime\_enabled element.
- false: Do not return the realtime\_enabled element.
Data type: Boolean
Default: false
|
|
sysparm\_include\_score\_notes
|
Flag that indicates whether to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added.Valid values:
- true: Return all notes associated with the score.
- false: Do not return all notes associated with the score.
Data type: Boolean
Default: false
|
|
sysparm\_include\_scores
|
Flag that indicates whether to return indicator scores for the entire time range selected on the Analytics Hub. If a value is not specified, this parameter defaults to false and returns only the most recent score value. To constrain the date range of the scores that are returned, combine this parameter with **from** and **to**.
Valid values:
- true: Return indicator scores for the entire selected time range.
- false: Do not return indicator scores for the entire selected time range.
Data type: Boolean
Default: false
|
|
sysparm\_include\_target\_color\_scheme
|
Flag that indicates whether 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 Analytics Hub.Valid values:
- true: Return the target\_color\_scheme element.
- false: Do not return the target\_color\_scheme element.
Data type: Boolean
Default: false
|
|
sysparm\_include\_trendline\_scores
|
Flag that indicates whether to return the trendline\_scores element that contains an array of date-value pairs that define the Analytics Hub trendline. This parameter requires that the **include\_scores** parameter is also set to `true`.
Valid values:
- true: Return the trendline\_scores element.
- false: Do not return the trendline\_scores element.
Data type: Boolean
Default: false
|
|
sysparm\_key
|
Flag that indicates whether to return results only for key indicators.Valid values:
- true: Return the trendline\_scores element.
- false: Do not return the trendline\_scores element .
Data type: Boolean
Default: false
|
|
sysparm\_limit
|
Maximum number of scores to return.Data type: Number
|
|
sysparm\_page
|
Page number. For example, when querying 20 indicators with the default sysparm\_per\_page value \(10\), specify a sysparm\_page value of 2 to retrieve indicators 11-20.Data type: Number
|
|
sysparm\_per\_page
|
Maximum number of indicators each query can return on a page.Default: 10
Maximum: 100
Data type: Number
|
|
sysparm\_sortby
|
Value to use when sorting results.Valid values:
- bullet
- change
- changeperc
- date
- default
- direction
- duedate
- frequency
- gap
- gapperc
- group
- indicator\_group
- name
- order
- target
- trend
- value
Data type: String
Default: value
|
|
sysparm\_sortdir
|
Sort direction.Valid values:
- asc: Denotes ascending
- des: Denotes descending
Data type: String
Default: Descending
|
|
sysparm\_step
|
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.Data type: Number
|
|
sysparm\_tags
|
Indicator group sys\_id in which to return the indicators of that group. Do not use **sysparm\_uuid** with this parameter.You cannot obtain the sys\_id of an indicator group through this API. Instead, get the sys\_id from the indicator group record. For more information about obtaining sys\_ids from records, see [Unique record identifier \(sys\_id\)](https://www.servicenow.com/docs?context=platform_unique-record-id&version=sandiego).
Data type: String
|
|
sysparm\_target
|
Flag that indicates whether to return results only for indicators that have a target set on the Analytics Hub.Valid values:
- true: Only return results for indicators that have a target set.
- false: Return results for all applicable indicators.
Data type: Boolean
Default: false
|
|
sysparm\_to
|
Latest date from which to return scores. Only scores from this date or earlier are returned. This parameter requires that **include\_scores** is set to `true`.
Data type: String
Format: ISO-8601 standard
|
|
sysparm\_uuid
|
Colon-separated list of sys\_id values to specify which indicators, breakdowns, aggregates, and domains to query. The parameter follows this format:<indicator\_sys\_id>:<breakdown\_sys\_id>:<elements\_filter\_sys\_id or element\_sys\_ids>:<lvl-2 breakdown\_sys\_id>:<lvl-2 elements\_filter\_sys\_id or element\_sys\_ids>:<aggregate\_sys\_id>;<domain\_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 values that this API retrieves for that indicator use the selected aggregate.
Data type: String
|