パフォーマンス分析 API の例
次の例では、cURL コマンドを使用して REST クエリを実行し、各コマンドで返されるデータを表示する方法を示しています。各例は最後の例に基づいて構築されており、後の例では前の例で返されたデータを使用します。
に表示されているすべてのインジケーターを返します アナリティクスハブ
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards"
次の応答は切り捨てられ、このページの他の例で使用されているオープンインシデント数インジケーターのみが表示されます。
//{
"result" : [
...
{
"change_formatted" : "",
"key" : false,
"value_unit" : "",
"value_formatted" : "",
"period_title" : null,
"gapperc" : null,
"gap" : null,
"target" : null,
"period" : null,
"target_formatted" : "",
"favorite" : false,
"direction_label" : "Minimize",
"uuid" : "fb007202d7130100b96d45a3ce6103b4",
"name" : "Number of open incidents",
"value_color" : "#000000",
"frequency_label" : "Daily",
"change" : null,
"gap_formatted" : "",
"gapperc_formatted" : "",
"value" : null,
"unit" : {
"display_value" : "#",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value" : "17b365e2d7320100ba986f14ce6103ad"
},
"changeperc_formatted" : "",
"direction" : 2,
"frequency" : 10,
"precision" : 0,
"changeperc" : null,
"indicator" : {
"display_value" : "Number of open incidents",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value" : "fb007202d7130100b96d45a3ce6103b4"
},
"description" : "Number of incidents open based on resolved date is empty."
},
...
]
}
インジケーターの詳細を返す
"uuid" : "fb007202d7130100b96d45a3ce6103b4",
"name" : "Number of open incidents",コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4"
応答:
{
"result" : [
{
"change_formatted" : "",
"key" : false,
"value_unit" : "",
"value_formatted" : "",
"period_title" : null,
"gapperc" : null,
"gap" : null,
"target" : null,
"period" : null,
"target_formatted" : "",
"favorite" : false,
"direction_label" : "Minimize",
"uuid" : "fb007202d7130100b96d45a3ce6103b4",
"name" : "Number of open incidents",
"value_color" : "#000000",
"frequency_label" : "Daily",
"change" : null,
"gap_formatted" : "",
"gapperc_formatted" : "",
"value" : null,
"unit" : {
"display_value" : "#",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value" : "17b365e2d7320100ba986f14ce6103ad"
},
"changeperc_formatted" : "",
"direction" : 2,
"frequency" : 10,
"precision" : 0,
"changeperc" : null,
"indicator" : {
"display_value" : "Number of open incidents",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value" : "fb007202d7130100b96d45a3ce6103b4"
},
"description" : "Number of incidents open based on resolved date is empty."
}
]
}
インジケーターのすべてのブレークダウンと集計を返します
sysparm_include_available_breakdownsパラメーターとsysparm_include_available_aggregatesパラメーターを true に設定することで、インジケーターで利用可能なブレークダウンと集計のリストを照会できます。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4&sysparm_include_available_breakdowns=true&sysparm_include_available_aggregates=true"
応答:
{
"result" : [
{
"key" : false,
"change_formatted" : "",
"aggregates" : [
{
"display_value" : "7d running SUM",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_aggregates/89ea4c11d7001100ba986f14ce6103dc",
"value" : "89ea4c11d7001100ba986f14ce6103dc"
},
{
"display_value" : "28d running SUM",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_aggregates/4dfa4c11d7001100ba986f14ce6103e2",
"value" : "4dfa4c11d7001100ba986f14ce6103e2"
},
{
"display_value" : "30d running SUM",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_aggregates/3e409011d7001100ba986f14ce610319",
"value" : "3e409011d7001100ba986f14ce610319"
},
// Aggregates truncated for brevity
],
"changeperc" : null,
"value_formatted" : "",
"period_title" : null,
"gapperc" : null,
"value_unit" : "",
"target" : null,
"period" : null,
"target_formatted" : "",
"favorite" : false,
"gap" : null,
"direction_label" : "Minimize",
"uuid" : "fb007202d7130100b96d45a3ce6103b4",
"name" : "Number of open incidents",
"value_color" : "#000000",
"frequency_label" : "Daily",
"change" : null,
"gap_formatted" : "",
"gapperc_formatted" : "",
"value" : null,
"unit" : {
"display_value" : "#",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value" : "17b365e2d7320100ba986f14ce6103ad"
},
"breakdowns" : [
{
"display_value" : "Priority",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_breakdowns/0df47e02d7130100b96d45a3ce610399",
"value" : "0df47e02d7130100b96d45a3ce610399"
},
{
"display_value" : "Category",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_breakdowns/1f918835d7231100b96d45a3ce6103fe",
"value" : "1f918835d7231100b96d45a3ce6103fe"
},
{
"display_value" : "Assignment Group",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value" : "baec0752bf130100b96dac808c0739ed"
},
// Information for State and Age indicators truncated
],
"changeperc_formatted" : "",
"frequency" : 10,
"precision" : 0,
"direction" : 2,
"indicator" : {
"display_value" : "Number of open incidents",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value" : "fb007202d7130100b96d45a3ce6103b4"
},
"description" : "Number of incidents open based on resolved date is empty."
}
]
}
インジケータースコアの時系列アグリゲーションを返します
集計のsys_idとsysparm_uuid値を使用して、7 日間の累計集計をアナリティクスハブに適用できます。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:89ea4c11d7001100ba986f14ce6103dc"
応答:
{
"result" : [
{
"key" : false,
"change_formatted" : "",
"value_unit" : "",
"value_formatted" : "",
"period_title" : null,
"aggregate" : {
"display_value" : "7d running SUM",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_aggregates/89ea4c11d7001100ba986f14ce6103dc",
"value" : "89ea4c11d7001100ba986f14ce6103dc"
},
"gapperc" : null,
"target" : null,
"period" : null,
"target_formatted" : "",
"favorite" : false,
"gap" : null,
"direction_label" : "Minimize",
"uuid" : "fb007202d7130100b96d45a3ce6103b4:89ea4c11d7001100ba986f14ce6103dc",
"name" : "Number of open incidents / 7d running SUM",
"value_color" : "#000000",
"frequency_label" : "Daily",
"change" : null,
"gap_formatted" : "",
"gapperc_formatted" : "",
"value" : null,
"unit" : {
"display_value" : "#",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value" : "17b365e2d7320100ba986f14ce6103ad"
},
"changeperc_formatted" : "",
"direction" : 2,
"frequency" : 10,
"precision" : 0,
"changeperc" : null,
"indicator" : {
"display_value" : "Number of open incidents",
"link" : "https://instance.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value" : "fb007202d7130100b96d45a3ce6103b4"
},
"description" : "Number of incidents open based on resolved date is empty."
}
]
}
ブレークダウンの要素を返す
ブレークダウンの各要素に関連付けられたスコアを取得し、それらの要素のsys_idsを取得するには、ブレークダウンのsys_idとともに sysparm_breakdown パラメーターを使用します。この例では、[オープンインシデント数] インジケーターのアサイン先グループブレークダウンの要素を取得します。前の例では、[オープンインシデント数] インジケーターのsys_idが fb007202d7130100b96d45a3ce6103b4 で、[アサイン先グループ] ブレークダウンのsys_idが baec0752bf130100b96dac808c0739ed となっています。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://<instance>.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4&sysparm_breakdown=baec0752bf130100b96dac808c0739ed"
応答は インジケーターオブジェクトの セットで構成され、それぞれに 1 つの 要素 オブジェクトが含まれています。要素オブジェクトにはそれぞれ、オブジェクトの名前とsys_idが含まれています。インジケーターに関する情報は インジケーター オブジェクトごとに同じであるため、この例では最初の インジケーター オブジェクトのみが詳細に示されます。
応答:
{
"result":[
{
"indicator": {
"display_value":"Number of open incidents",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value":"fb007202d7130100b96d45a3ce6103b4"
},
"gap_formatted":"",
"benchmarking":false,
"frequency_label":"Daily",
"changeperc_formatted":"0.0%",
"direction_label":"Minimize",
"precision":0,
"breakdown": {
"display_value":"Assignment Group",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value":"baec0752bf130100b96dac808c0739ed"
},
"personal_target":null,
"description":"Number of incidents open based on resolved date is empty.",
"value_color":"#455464",
"uuid":"fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:unmatched",
"frequency":10,
"gap":null,
"value_unit":"14",
"indicator_frequency":10,
"value":14.0,
"indicator_aggregate":1,
"facts_table": {
"name":"incident",
"label":"Incidents"
},
"key":false,
"indicator_frequency_label":"Daily",
"direction":2,
"element": {
"display_value":"Unassigned", //Element name
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/unmatched",
"value":"unmatched" //No sys_id for unmatched scores
},
"period_title":"Jul 22",
"period":"Jul 22",
"target_formatted":"",
"change":0.0,
"gapperc_formatted":"",
"query":"opened_atONToday@javascript:gs.beginningOfToday()@javascript:gs.endOfToday()^ORopened_at<javascript:gs.beginningOfToday()^resolved_atISEMPTY^ORresolved_at>javascript:gs.endOfToday()^state!=8",
"realtime_enabled":true,
"changeperc":0.0,
"target":null,
"unit": {
"display_value":"#",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"type":"formatted",
"value":"17b365e2d7320100ba986f14ce6103ad"
},
"value_formatted":"14", // Score where Assignment Group=Unassigned
"name":"Number of open incidents > Assignment Group = Unassigned",
"gapperc":null,
"change_formatted":"0",
"favorite":false,
"personal_target_formatted":""
},
{"indicator": {
"element": {
"display_value":"Software",
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
"value":"8a4dde73c6112278017a6a4baf547aa7" // sys_id of element Software
},
...
"value_formatted":"6", // Score where Assignment Group: Software
"name":"Number of open incidents > Assignment Group = Software",
"gapperc":null,
"change_formatted":"0",
"favorite":false,
"personal_target_formatted":""
},
{"indicator": {
...
"element": {
"display_value":"Service Desk",
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/d625dccec0a8016700a222a0f7900d06",
"value":"d625dccec0a8016700a222a0f7900d06" // sys_id of element Service Desk
},
...
"value_formatted":"5", // Score for Assignment Group: Service Desk
"name":"Number of open incidents > Assignment Group = Service Desk",
"gapperc":null,
"change_formatted":"0",
"favorite":false,
"personal_target_formatted":""
},
{"indicator": {
...
"element": {
"display_value":"Hardware",
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
"value":"8a5055c9c61122780043563ef53438e3" // sys_id for element Hardware
},
...
"value_formatted":"3", // Score for Assignment Group: Hardware
"name":"Number of open incidents > Assignment Group = Hardware",
"gapperc":null,
"change_formatted":"0",
"favorite":false,
"personal_target_formatted":""
},
{"indicator": {
...
"element": {
"display_value":"Network",
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e",
"value":"287ebd7da9fe198100f92cc8d1d2154e"}, // sys_id for element Network
...
"value_formatted":"3", // Score for Assignment Group: Network
"name":"Number of open incidents > Assignment Group = Network",
"gapperc":null,
"change_formatted":"0",
"favorite":false,
"personal_target_formatted":""
},
...
]
...
}
ブレークダウンと要素でフィルタリングされたインジケーターを返します
ブレークダウンとブレークダウン要素のsys_id値を sysparm_uuid パラメーターに追加することで、ブレークダウンを適用できます。この例では、データを細分化して優先度 1 のインシデントを示しています。優先度ブレークダウンのsys_idは 0df47e02d7130100b96d45a3ce610399 で、「インジケーターのすべてのブレークダウンと集計を返す」の例にあります。1 - 重大要素のsys_idを取得するには、「ブレークダウンのすべての要素を返す」と同じコマンドを実行しますが、アサイン先グループではなく優先度ブレークダウンを使用します。「1 - 重大」のsys_idは 5f012106db5123003ee8f93baf9619bd です。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:0df47e02d7130100b96d45a3ce610399:5f012106db5123003ee8f93baf9619bd"
応答:
{
// The request is made Dec 12. The
// score is 76, which is unchanged from
// Dec 11, and which exceeds the
// target of 70.
"result": [
{
"indicator": {
"display_value":"Number of open incidents",
"link":"https://instance.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value":"fb007202d7130100b96d45a3ce6103b4"
},
"gap_formatted":"-6",
"benchmarking":false,
"frequency_label":"Daily",
"changeperc_formatted":"0.0%",
"direction_label":"Minimize",
"precision":0,
"breakdown": {
"display_value":"Priority",
"link":"https://instance.service-now.com/api/now/v1/table/pa_breakdowns/0df47e02d7130100b96d45a3ce610399",
"value":"0df47e02d7130100b96d45a3ce610399"
},
"personal_target":null,
"description":"Number of incidents open based on resolved date is empty.",
"value_color":"#ff8c00",
"uuid":"fb007202d7130100b96d45a3ce6103b4:0df47e02d7130100b96d45a3ce610399:5f012106db5123003ee8f93baf9619bd",
"frequency":10,
"gap":-6.0,
"value_unit":"76",
"indicator_frequency":10,
"value":76.0,
"indicator_aggregate":1,
"facts_table": {
"name":"incident",
"label":"Incidents"
},
"key":false,
"indicator_frequency_label":"Daily",
"direction":2,
"element": {
"display_value":"1 - Critical",
"link":"https://instance.service-now.com/api/now/v1/table/sys_choice/5f012106db5123003ee8f93baf9619bd",
"value":"5f012106db5123003ee8f93baf9619bd"
},
"period_title":"Dec 12",
"period":"Dec 12",
"target_formatted":"70",
"change":0.0,
"gapperc_formatted":"-8.6%",
"query":"opened_atONToday@javascript:gs.beginningOfToday()@javascript:gs.endOfToday()^ORopened_at<javascript:gs.beginningOfToday()^resolved_atISEMPTY^ORresolved_at>javascript:gs.endOfToday()^state!=8^priority=1^EQ",
"realtime_enabled":true,
"changeperc":0.0,
"target":70.0,
"unit": {
"display_value":"#",
"link":"https://instance.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"type":"formatted","value":"17b365e2d7320100ba986f14ce6103ad"
},
"value_formatted":"76",
"name":"Number of open incidents > Priority = 1 - Critical",
"gapperc":-0.08571428571428572,
"change_formatted":"0",
"favorite":true,
"personal_target_formatted":""
}
]
}
場所別に分類されたインジケーターを返す
パフォーマンスアナリティクス API は、位置情報管理データが利用可能な場合に返します。
curl -v -u "user:password" -H "Accept:application/json" "https://<instance>.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4&sysparm_breakdown=656d5662eb23310065deac6aa206fee7"{
"result": [
{
...
"element": {
"display_value": "San Diego",
"link": "https://<instance>.service-now.com/api/now/v1/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
"value": "108752c8c611227501d4ab0e392ba97f",
"longitude": -117.15726,
"latitude": 32.71533
},
...
}
{
...
"element": {
"display_value": "Florida",
"link": "https://<instance>.service-now.com/api/now/v1/table/cmn_location/8e3e85f037d0200044e0bfc8bcbe5d14",
"value": "8e3e85f037d0200044e0bfc8bcbe5d14",
"longitude": -95.71289,
"latitude": 37.09024
},
...
}
]
}第 1 レベルと第 2 レベルのブレークダウンスコアを返します
sysparm_uuid パラメーターに 2 つのブレークダウンsys_idsを追加することで、2 つのレベルのブレークダウンを適用できます。この例では、データは優先度別に分類されて優先度 1 のインシデントを表示し、カテゴリ別に分類されてデータベースインシデントを表示します。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:0df47e02d7130100b96d45a3ce610399:e5900140200331007665978299a805f3:1f918835d7231100b96d45a3ce6103fe:9e418d40200331007665978299a805c1"
応答:
{
"result": [
{
"value_formatted": "",
"indicator": {
"display_value": "Number of open incidents",
"link": "http://instance.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value": "fb007202d7130100b96d45a3ce6103b4"
},
"gapperc": null,
"change": null,
"value_color": "#000000",
"direction": 2,
"target_formatted": "",
"frequency": 10,
"changeperc_formatted": "",
"direction_label": "Minimize",
"period_title": null,
"description": "Number of incidents open based on resolved date is empty.",
"name": "Number of open incidents / Priority / 1 - Critical / Category / Database",
"value": null,
"key": false,
"gap_formatted": "",
"element": {
"display_value": "1 - Critical",
"link": "http://instance.service-now.com/api/now/v1/table/sys_choice/e5900140200331007665978299a805f3",
"value": "e5900140200331007665978299a805f3"
},
"precision": 0,
"element_level2": {
"display_value": "Database",
"link": "http://instance.service-now.com/api/now/v1/table/sys_choice/9e418d40200331007665978299a805c1",
"value": "9e418d40200331007665978299a805c1"
},
"breakdown": {
"display_value": "Priority",
"link": "http://instance.service-now.com/api/now/v1/table/pa_breakdowns/0df47e02d7130100b96d45a3ce610399",
"value": "0df47e02d7130100b96d45a3ce610399"
},
"period": null,
"favorite": false,
"change_formatted": "",
"unit": {
"display_value": "#",
"link": "http://instance.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value": "17b365e2d7320100ba986f14ce6103ad"
},
"frequency_label": "Daily",
"breakdown_level2": {
"display_value": "Category",
"link": "http://instance.service-now.com/api/now/v1/table/pa_breakdowns/1f918835d7231100b96d45a3ce6103fe",
"value": "1f918835d7231100b96d45a3ce6103fe"
},
"target": null,
"changeperc": null,
"uuid": "fb007202d7130100b96d45a3ce6103b4:0df47e02d7130100b96d45a3ce610399:e5900140200331007665978299a805f3:1f918835d7231100b96d45a3ce6103fe:9e418d40200331007665978299a805c1",
"gapperc_formatted": "",
"value_unit": "",
"gap": null
}
]
}
2 つのレベルのブレークダウンについて、日付範囲にわたるスコアを返します
sysparm_include_scoresパラメーターを true に設定することで、利用可能なすべての日付の個々のスコアのリストを要求できます。スコアの日付範囲を指定するには、 sysparm_from パラメーターと sysparm_to パラメーターも使用します。この例では、レベル 1 のブレークダウンと要素は、アサイン先グループ:ソフトウェア (sys_id baec0752bf130100b96dac808c0739ed および 8a4dde73c6112278017a6a4baf547aa7) です。レベル 2 のブレークダウンと要素は、優先度 1 - 重大 (sys_id 0df47e02d7130100b96d45a3ce610399 および e5900140200331007665978299a805f3) です。2018 年 11 月 30 日以降のスコアのみが返されます。
コマンド:
curl -v -u "resttest:resttest" -H "Accept:application/json" "https://<instance>.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:8a4dde73c6112278017a6a4baf547aa7:0df47e02d7130100b96d45a3ce610399:e5900140200331007665978299a805f3&sysparm_include_scores=true&sysparm_from=2018-11-30"
応答:
{
"result": [
{ "indicator": {
"display_value":"Number of open incidents",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value":"fb007202d7130100b96d45a3ce6103b4"
},
"gap_formatted":"",
"benchmarking":false,
"frequency_label":"Daily",
"scores": [
{ "end_at":"2018-12-04",
"period":"Dec 04",
"value_formatted":"2",
"start_at":"2018-12-04",
"value":2.0
},
...
{ "end_at":"2018-11-30",
"period":"Nov 30",
"value_formatted":"0",
"start_at":"2018-11-30",
"value":0.0
}
],
"changeperc_formatted":"",
"direction_label":"Minimize",
"precision":0,
"breakdown": { //First-level breakdown
"display_value":"Assignment Group",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value":"baec0752bf130100b96dac808c0739ed"
},
"personal_target":null,
"description":"Number of incidents open based on resolved date is empty.",
"value_color":"#455464",
"uuid":"fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:8a4dde73c6112278017a6a4baf547aa7:0df47e02d7130100b96d45a3ce610399:e5900140200331007665978299a805f3",
"frequency":10,
"gap":null,
"value_unit":"2",
"indicator_frequency":10,
"value":2.0,
"indicator_aggregate":1,
"key":false,
"indicator_frequency_label":"Daily",
"direction":2,
"element": { //First-level breakdown element
"display_value":"Software",
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
"value":"8a4dde73c6112278017a6a4baf547aa7"
},
"period_title":"Dec 04",
"period":"Dec 04",
"target_formatted":"",
"change":2.0,
"gapperc_formatted":"",
"realtime_enabled":false,
"changeperc":null,
"target":null,
"unit":{
"display_value":"#",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"type":"formatted",
"value":"17b365e2d7320100ba986f14ce6103ad"
},
"value_formatted":"2", //Second-level breakdown and element
"name":"Number of open incidents > Assignment Group = Software > Priority = e5900140200331007665978299a805f3",
"gapperc":null,
"change_formatted":"2",
"favorite":false,
"breakdown_level2": {
"display_value":"Priority",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/0df47e02d7130100b96d45a3ce610399",
"value":"0df47e02d7130100b96d45a3ce610399"
},
"personal_target_formatted":""
}
]
}
ブレークダウンと要素のブレークダウンの関連付けを返します
インジケーターに関連付けられたすべてのブレークダウンの関連付けのsys_id値を取得するには、 sysparm_include_available_breakdowns パラメーターを使用します。sysparm_uuidパラメーターに、第 1 レベルのブレークダウンのsys_idsと、関係を検索する要素を含めます。この例では、 sysparm_uuid パラメーターにアサイン先グループブレークダウンのsys_idとソフトウェア要素のsys_idが含まれています。アサイン先グループのsys_idは、すべてのブレークダウンと集計が返された例で取得されました。ソフトウェア要素のsys_idは前の例で取得され、アサイン先グループのすべての要素が返されました。アサイン先グループブレークダウンのsys_idは baec0752bf130100b96dac808c0739ed で、ソフトウェア要素のブレークダウンは 8a4dde73c6112278017a6a4baf547aa7 です。ブレークダウンの関連付けは、sys_idが fb007202d7130100b96d45a3ce6103b4 であるオープンインシデント数インジケーターに対して取得されます。
unmatched」 を使用します。この場合、パラメーターは sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:unmatched になります。コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://<instance>.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:8a4dde73c6112278017a6a4baf547aa7&sysparm_include_available_breakdowns=true"
応答:
{
"result": [
{
"value_formatted": "37",
"indicator": {
"display_value": "Number of open incidents",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value": "fb007202d7130100b96d45a3ce6103b4"
},
"gapperc": null,
"change": 9.0,
"value_color": "#455464",
"direction": 2,
"target_formatted": "",
"frequency": 10,
"changeperc_formatted": "32.1%",
"direction_label": "Minimize",
"period_title": "Jul 22",
"description": "Number of incidents open based on resolved date is empty.",
"name": "Number of open incidents / Assignment Group / Software",
"value": 37.0,
"key": false,
"gap_formatted": "",
"element": {
"display_value": "Software",
"link": "https://<instance>.service-now.com/api/now/v1/table/sys_user_group/287ee6fea9fe198100ada7950d0b1b73",
"value": "8a4dde73c6112278017a6a4baf547aa7"
},
"precision": 0,
"breakdowns": [
// Information about each breakdown
],
"breakdown_relations": [
{
"display_value": "Child Groups",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_breakdown_relations/301fd511eb23310065deac6aa206fe31",
"value": "301fd511eb23310065deac6aa206fe31"
},
{
"display_value": "Parent Group",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_breakdown_relations/790b6e11eb23310065deac6aa206fe1c",
"value": "790b6e11eb23310065deac6aa206fe1c"
},
{
"display_value": "Sibling Groups",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_breakdown_relations/15e15a12eb233100871aac6aa206fe59",
"value": "15e15a12eb233100871aac6aa206fe59"
}
],
"breakdown": {
"display_value": "Assignment Group",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value": "baec0752bf130100b96dac808c0739ed"
},
"period": "Jul 22",
"favorite": false,
"change_formatted": "9",
"unit": {
"display_value": "#",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value": "17b365e2d7320100ba986f14ce6103ad"
},
"frequency_label": "Daily",
"target": null,
"changeperc": 0.32142857142857145,
"uuid": "fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:8a4dde73c6112278017a6a4baf547aa7",
"gapperc_formatted": "",
"value_unit": "6",
"gap": null
}
]
}
ブレークダウン関連付けを使用したリターンインジケーター
ブレークダウンの関連付けを使用するには、インジケーター、ブレークダウン、および要素のsys_id値を sysparm_uuid パラメーターに含め、ブレークダウンの関連付けのsys_idを sysparm_breakdown_relation パラメーターに含めます。この例では、前の例の [アサイン先グループ:ソフトウェア] の [兄弟グループ] の値を返します。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://<instance>.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:8a4dde73c6112278017a6a4baf547aa7&sysparm_breakdown_relation=15e15a12eb233100871aac6aa206fe59"
応答:
{
"result": [
{
"indicator": {
"gap_formatted":"",
"benchmarking":false,
"frequency_label":"Daily",
"changeperc_formatted":"0.0%",
"direction_label":"Minimize",
"precision":0,
"breakdown": {
"display_value":"Assignment Group",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value":"baec0752bf130100b96dac808c0739ed"
},
"personal_target":null,
"description":"Number of incidents open based on resolved date is empty",
"value_color":"#455464",
"uuid":"fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:0a52d3dcd7011200f2d224837e6103f2",
"frequency":10,
"gap":null,
"value_unit":"0",
"indicator_frequency":10,
"value":0.0,
"indicator_aggregate":1,
"facts_table": {
"name":"incident",
"label":"Incidents"
},
"key":false,
"indicator_frequency_label":"Daily",
"direction":2,
"element": {
"display_value":"Application Development",
"link":"https://<instance>.service-now.com/api/now/v1/table/sys_user_group/0a52d3dcd7011200f2d224837e6103f2",
"value":"0a52d3dcd7011200f2d224837e6103f2"
},
"period_title":"Dec 03",
"period":"Dec 03",
"target_formatted":"",
"change":0.0,
"gapperc_formatted":"",
"query":"opened_atONToday@javascript:gs.beginningOfToday()@javascript:gs.endOfToday()^ORopened_at<javascript:gs.beginningOfToday()^resolved_atISEMPTY^ORresolved_at>javascript:gs.endOfToday()^state!=8^assignment_group=0a52d3dcd7011200f2d224837e6103f2^EQ",
"realtime_enabled":true,
"changeperc":0.0,
"target":null,
"unit": {
"display_value":"#",
"link":"https://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"type":"formatted",
"value":"17b365e2d7320100ba986f14ce6103ad"
},
"value_formatted":"0",
"name":"Number of open incidents > Assignment Group = Application Development",
"gapperc":null,
"change_formatted":"0",
"favorite":false,
"personal_target_formatted":""
}
// Followed by an indicator object with an element object for every element in the Sibling Group
]
}
ブレークダウンの要素のフィルター済みセットを返します
パフォーマンスアナリティクス要素フィルターレコードのsys_idとともに sysparm_elements_filter パラメーターを使用して、アナリティクスハブデータにフィルターを適用できます。
説明に従って、要素フィルターレコードから要素フィルターのsys_idを取得します。
この例では、要素フィルターが条件 [[親][次の値に等しい][データベース]] のグループブレークダウンソースに適用されます。このエレメントフィルターのsys_idは 7b9eb563eb11020065deac6aa206fe11 です。この例では、要素データベースを親として持つアサイン先グループブレークダウンの要素を取得します。
コマンド:
curl -v -u "user:password" -H "Accept:application/json" "https://<instance>.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4&sysparm_breakdown=baec0752bf130100b96dac808c0739ed&sysparm_elements_filter=7b9eb563eb11020065deac6aa206fe11"
応答:
{
"result": [
{
"value_formatted": "37",
"indicator": {
"display_value": "Number of open incidents",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value": "fb007202d7130100b96d45a3ce6103b4"
},
"gapperc": null,
"change": 9.0,
"value_color": "#455464",
"direction": 2,
"target_formatted": "",
"frequency": 10,
"changeperc_formatted": "32.1%",
"direction_label": "Minimize",
"period_title": "Jul 22",
"description": "Number of incidents open based on resolved date is empty.",
"name": "Number of open incidents / Assignment Group / Database",
"value": 37.0,
"key": false,
"gap_formatted": "",
"element": {
"display_value": "Database",
"link": "https://<instance>.service-now.com/api/now/v1/table/sys_user_group/287ee6fea9fe198100ada7950d0b1b73",
"value": "287ee6fea9fe198100ada7950d0b1b73"
},
"precision": 0,
"breakdown": {
"display_value": "Assignment Group",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value": "baec0752bf130100b96dac808c0739ed"
},
"period": "Jul 22",
"favorite": false,
"change_formatted": "9",
"unit": {
"display_value": "#",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value": "17b365e2d7320100ba986f14ce6103ad"
},
"frequency_label": "Daily",
"target": null,
"changeperc": 0.32142857142857145,
"uuid": "fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:287ee6fea9fe198100ada7950d0b1b73",
"gapperc_formatted": "",
"value_unit": "37",
"gap": null
},
{
"value_formatted": "20",
"indicator": {
"display_value": "Number of open incidents",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value": "fb007202d7130100b96d45a3ce6103b4"
},
// Database Atlanta
"gapperc": null,
"change": 4.0,
"value_color": "#455464",
"direction": 2,
"target_formatted": "",
"frequency": 10,
"changeperc_formatted": "25.0%",
"direction_label": "Minimize",
"period_title": "Jul 22",
"description": "Number of incidents open based on resolved date is empty.",
"name": "Number of open incidents / Assignment Group / Database Atlanta",
"value": 20.0,
"key": false,
"gap_formatted": "",
"element": {
"display_value": "Database Atlanta",
"link": "https://<instance>.service-now.com/api/now/v1/table/sys_user_group/db53580b0a0a0a6501aa37c294a2ba6b",
"value": "db53580b0a0a0a6501aa37c294a2ba6b"
},
"precision": 0,
"breakdown": {
"display_value": "Assignment Group",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value": "baec0752bf130100b96dac808c0739ed"
},
"period": "Jul 22",
"favorite": false,
"change_formatted": "4",
"unit": {
"display_value": "#",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value": "17b365e2d7320100ba986f14ce6103ad"
},
"frequency_label": "Daily",
"target": null,
"changeperc": 0.25,
"uuid": "fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:db53580b0a0a0a6501aa37c294a2ba6b",
"gapperc_formatted": "",
"value_unit": "20",
"gap": null
},
{
"value_formatted": "19",
"indicator": {
"display_value": "Number of open incidents",
"link": "https://<instance>.service-now.com/api/now/v1/table/pa_indicators/fb007202d7130100b96d45a3ce6103b4",
"value": "fb007202d7130100b96d45a3ce6103b4"
},
...
// Database San Diego
"gapperc": null,
"change": 0.0,
"value_color": "#455464",
"direction": 2,
"target_formatted": "",
"frequency": 10,
"changeperc_formatted": "0.0%",
"direction_label": "Minimize",
"period_title": "Jul 22",
"description": "Number of incidents open based on resolved date is empty.",
"name": "Number of open incidents / Assignment Group / Database San Diego",
"value": 10.0,
"key": false,
"gap_formatted": "",
"element": {
"display_value": "Database San Diego",
"link": "https://<instance>.service-now.com/api/now/v1/table/sys_user_group/db53a9290a0a0a650091abebccf833c6",
"value": "db53a9290a0a0a650091abebccf833c6"
},
"precision": 0,
"breakdown": {
"display_value": "Assignment Group",
"link": "http://localhost:8080/api/now/v1/table/pa_breakdowns/baec0752bf130100b96dac808c0739ed",
"value": "baec0752bf130100b96dac808c0739ed"
},
"period": "Jul 22",
"favorite": false,
"change_formatted": "0",
"unit": {
"display_value": "#",
"link": "http://<instance>.service-now.com/api/now/v1/table/pa_units/17b365e2d7320100ba986f14ce6103ad",
"value": "17b365e2d7320100ba986f14ce6103ad"
},
"frequency_label": "Daily",
"target": null,
"changeperc": 0.0,
"uuid": "fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:db53a9290a0a0a650091abebccf833c6",
"gapperc_formatted": "",
"value_unit": "10",
"gap": null
}
]
}