Exemplos da API Performance Analytics

Análise da plataforma Yokohama

Release

yokohama

ft:locale

pt-BR

ft:publication_title

Análise da plataforma Yokohama

ft:clusterId

par

bundleId

par

workflow

Platform

Exemplos da API Performance Analytics

Versão de lançamento: Yokohama

Atualizado 30 de jan. de 2025

15 min. de leitura

Esses exemplos demonstram como executar uma consulta REST usando comandos cURL e mostram os dados retornados para cada comando. Cada exemplo se baseia no último, com exemplos posteriores usando os dados retornados por exemplos anteriores.

Retornar todos os indicadores exibidos no Hub de análise

Você pode solicitar uma lista de todos os indicadores exibidos no Hub de análise, incluindo seus identificadores de registro exclusivos.

Nota:

Esses exemplos usam a sintaxe macOS para comandos de curva. A sintaxe Windows pode ser diferente.

Comando:

curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards"

A resposta a seguir é truncada para mostrar somente o indicador Número de incidentes em aberto, que é usado em outros exemplos nesta página:

//{
  "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."
    },
...
    
  ]
}

Detalhes do indicador de retorno

Você pode consultar o Hub de análise de um indicador específico fornecendo o parâmetro sysparm_uuid com um valor de sys_id de indicador. Nesse caso, você usa o SYS ID para o indicador Número de incidentes em aberto, que você recuperou no primeiro exemplo, quando obteve todos os indicadores no Hub de análise:

"uuid" : "fb007202d7130100b96d45a3ce6103b4",
"name" : "Number of open incidents",

Comando:

curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4"

Resposta:

{
  "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."
    }
  ]
}

Retornar todos os detalhamentos e agregados de um indicador

Você pode consultar uma lista de detalhamentos e agregados disponíveis para um indicador definindo os parâmetros sysparm_include_available_breakdowns e sysparm_include_available_aggregates como verdadeiros.

Comando:

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"

Resposta:

{
  "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."
    }
  ]
}

Retornar uma agregação de série temporal de pontuações do indicador

Você pode aplicar o agregado SUM em execução de 7 dias ao Hub de análise usando o valor sysparm_uuid com o sys_id do agregado.

Comando:

curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:89ea4c11d7001100ba986f14ce6103dc"

Resposta:

{
  "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."
    }
  ]
}

Retornar os elementos de um detalhamento

Para obter as pontuações associadas a cada elemento de um detalhamento e para obter os sys_ids desses elementos, use o parâmetro sysparm_breakdown com o sys_id do detalhamento. Neste exemplo, você obtém os elementos do detalhamento do Grupo de atribuição para o indicador Número de incidentes em aberto. Do exemplo anterior, você tem o sys_id de fb007202d7130100b96d45a3ce6103b4 para o indicador Número de incidentes em aberto e o sys_id de baec0752bf130100b96dac808c0739ed para o detalhamento de Grupo de atribuição.

Comando:

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"

A resposta consiste em um conjunto de objetos de indicador, cada um contendo um objeto de elemento. Cada um dos objetos de elemento contém o nome e o sys_id de um objeto. Como as informações sobre o indicador são as mesmas para cada objeto de indicador, neste exemplo, somente o primeiro objeto de indicador é fornecido em detalhes.

Resposta:

{
  "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":""
    },
  ...
  ]
...
}

Retornar o indicador filtrado por um detalhamento e elemento

Você pode aplicar um detalhamento anexando os valores de detalhamento e sys_id do elemento de detalhamento ao parâmetro sysparm_uuid. Neste exemplo, os dados são divididos para mostrar incidentes de prioridade 1. O sys_id do detalhamento de Prioridade é 0df47e02d7130100b96d45a3ce610399 e está no exemplo Retornar todos os detalhamentos e agregados de um indicador. Você pode obter o sys_id do elemento 1 - Crítico executando o mesmo comando em Retornar todos os elementos para um detalhamento, mas com o Detalhamento de prioridade em vez do Grupo de atribuição. O sys_id para 1 - Crítico é 5f012106db5123003ee8f93baf9619bd.

Comando:

curl -v -u "user:password" -H "Accept:application/json" "https://instance.service-now.com/api/now/v1/pa/scorecards?sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:0df47e02d7130100b96d45a3ce610399:5f012106db5123003ee8f93baf9619bd"

Resposta:

{
// 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":""
    }
  ]
}

Retornar o indicador dividido por local

A API Performance Analytics retorna dados de geolocalização quando disponíveis.

Comando:

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"

Resposta:

{
  "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
      },
      ...
    }
  ]
}

Retornar pontuações de detalhamento de primeiro e segundo níveis

Você pode aplicar dois níveis de detalhamento anexando dois sys_ids de detalhamento ao parâmetro sysparm_uuid. Neste exemplo, os dados são divididos por prioridade para mostrar incidentes de prioridade 1 e por categoria para mostrar incidentes de banco de dados.

Comando:

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"

Resposta:

{
  "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
    }
  ]
}

Retornar pontuações em um intervalo de datas para dois níveis de detalhamento

Você pode solicitar uma lista de pontuações individuais para todas as datas disponíveis definindo o parâmetro sysparm_include_scores como verdadeiro. Para especificar o intervalo de datas das pontuações, use também os parâmetros sysparm_from e sysparm_to. Neste exemplo, o detalhamento de nível 1 e o elemento são Grupo de atribuição: Software (sys_id baec0752bf130100b96dac808c0739ed e 8a4dde73c6112278017a6a4baf547aa7). O detalhamento e o elemento de nível 2 são Prioridade: 1 - Crítico (sys_id 0df47e02d7130100b96d45a3ce610399 e e5900140200331007665978299a805f3). Somente pontuações a partir de 30 de novembro de 2018 são retornadas.

Comando:

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"

Resposta:

{
  "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":""
    }
  ]
}

Retornar relações de detalhamento para um detalhamento e elemento

Para obter os valores de sys_id para todas as relações de detalhamento associadas a um indicador, use o parâmetro sysparm_include_available_breakdowns. No parâmetro sysparm_uuid, inclua os sys_ids do detalhamento de primeiro nível e o elemento cujas relações você deseja encontrar. Neste exemplo, o parâmetro sysparm_uuid inclui o sys_id do detalhamento do Grupo de atribuição e o sys_id do elemento Software. O sys_id do grupo de atribuição foi obtido no exemplo em que todos os detalhamentos e agregados foram retornados. O sys_id do elemento Software foi obtido no exemplo anterior, em que todos os elementos do Grupo de atribuição foram retornados. O sys_id do detalhamento do Grupo de atribuição é baec0752bf130100b96dac808c0739ed e o do elemento Software é 8a4dde73c6112278017a6a4baf547aa7. A relação de detalhamento é obtida para o indicador Número de incidentes em aberto, cujo sys_id é fb007202d7130100b96d45a3ce6103b4.

Nota:

Para encontrar as relações de detalhamento de incidentes que não correspondem a nenhum valor de elemento em um detalhamento, como em Grupo de atribuição: não atribuído, use a cadeia de caracteres unmatched no lugar do elemento sys_id. Nesse caso, o parâmetro seria sysparm_uuid=fb007202d7130100b96d45a3ce6103b4:baec0752bf130100b96dac808c0739ed:unmatched.

Comando:

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"

Resposta:

{
  "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
    }
  ]
}

Retornar indicador usando uma relação de detalhamento

Para usar uma relação de detalhamento, inclua os valores de sys_id do indicador, detalhamento e elemento no parâmetro sysparm_uuid e o sys_id da relação de detalhamento no parâmetro sysparm_breakdown_relation. Este exemplo retorna os valores de Grupo semelhante para Grupo de atribuição: Software do exemplo anterior.

Comando:

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"

Resposta:

{
  "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
  ]
}

Retornar um conjunto filtrado de elementos para um detalhamento

Você pode aplicar um filtro aos dados Hub de análise usando o parâmetro sysparm_elements_filter com o sys_id de um registro de filtro de elemento do Performance Analytics.

Obtenha o sys_id do filtro de elementos do registro de filtro de elementos, conforme descrito em .

Neste exemplo, o filtro de elemento se aplica à origem de detalhamento Grupos, com a condição [[Parent][is][Database]]. O sys_id deste filtro de elemento é 7b9eb563eb11020065deac6aa206fe11. O exemplo obtém os elementos do detalhamento do Grupo de atribuição que têm o elemento Banco de dados como primário.

Comando:

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"

Resposta:

{
  "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
    }
  ]
}