Funzioni di Insight

Le funzioni Insight forniscono la sintassi e le descrizioni delle classi, dei metodi, degli attributi e dei parametri dell'interfaccia di programmazione dell'applicazione allo strumento Insight nella suite di strumenti Data Studio. La generazione dell'approfondimento viene eseguita in background e richiede il controllo del completamento.

Procedura recupero elenco richieste

Restituisce l'elenco dei nomi delle richieste e dei rispettivi parametri

Sintassi

Insight.get_request_list(owner)

Parametri:

• Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile elencare i job degli approfondimenti:

adp.Insight.get_request_list()
 
// Output
 
 [
  ... 
  {
    "owner": "ADMIN",
    "request_name": "REQUEST_INSIGHT_1",
    "request_type": "TABLE_INSIGHT",
    "source_object": "SALES",
    "source_owner": "ADMIN",
    "request_metadata": "{\"targets\":[\"ACTUAL\"],\"appName\":\"INSIGHTS\"}",
    "created": "2022-10-31T08:03:26.634Z",
    "updated": "2022-10-31T08:03:26.634Z",
    "request_job_setting": "{\"EXTRACTION\":{\"selectionRule\":{\"value\":\"MAX_DIFFERENCE\"},\"fittedShareConvergence\":{\"value\":\"LAX\"},\"maxNumExtractionDims\":{\"value\":10000},\"insightValueType\":{\"value\":\"MEMBER\"},\"excludeZero\":{\"value\":\"YES\"},\"minXAxisCount\":{\"value\":2}},\"sessionId\":null,\"applicationName\":\"INSIGHTS\",\"insightTypes\":[\"FITTED_SHARE_COMPARISON\"]}",
    "max_num_insights": 20
  },
  ...
]

Procedura Ottieni elenco approfondimenti

Restituisce la lista di approfondimenti. Ogni approfondimento ha i seguenti campi: nome_insight, id_visualization, colonna_insight, valore_insight, dimensione_insight, dimensione

Sintassi

Insight.get_insights_list(request_name)

Parametri:

• nome_richiesta: il nome della richiesta.

Esempio

In questo esempio è possibile elencare gli approfondimenti:

adp.Insight.get_insights_list('REQUEST_INSIGHT_1')
 
// Output:
[
  {
    "insight_name": "INSIGHT_62",
    "visualization_id": 199,
    "insight_column": "ACTUAL",
    "insight_value": "COUNTRY.2",
    "insight_dimension": "COUNTRY",
    "dimension": "FORECST"
  },..
]

Procedura Drop Insight

Elimina richiesta di approfondimento

Sintassi

Insight.drop(request_name)

Parametri:

• nome_richiesta: il nome della richiesta.

Esempio

In questo esempio è possibile eliminare la richiesta:

adp.Insight.drop('REQUEST_INSIGHT_1')

Genera procedura di approfondimento

Generare approfondimenti sulla misura per la vista Analitica.

Sintassi

Insight.generate(av_name, measure, job_owner,
                      source_owner)

Parametri:

• av_name: il nome della vista analitica.
• Misura: la misura.
• job_owner: questo campo visualizza il proprietario della mansione. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.
• proprietario_origine: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile generare approfondimenti per la vista analitica.

adp.Insight.generate('COSTS_AV', 'UNIT_COST')
 
// Output
 {
  "object_owner": "ADMIN",
  "request_name": "REQUEST_INSIGHT_1",
  "max_insight_count": 20,
  "source_object": "COSTS_AV",
  "source_owner": "COSTS_AV",
  "request_metadata": "{\"targets\":[\"UNIT_COST\"],\"appName\":\"INSIGHTS\"}",
  "default_job_settings": "{\"insightTypes\":[\"FITTED_SHARE_COMPARISON\"]}",
  "new_request": "true"
}

Ottieni stato job

Recupera lo stato del job specificato come Nome richiesta. La generazione degli approfondimenti è terminata quando il campo insight_job_status è COMPLETED.

Sintassi

Insight.get_job_status(request_name, owner)

Parametri:

• request_name: il nome della richiesta.
• Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile visualizzare lo stato del job:

adp.Insight.get_job_status('REQUEST_INSIGHT_1')
 
// Output
{
  "insight_job_status": "COMPLETED",
  "progress_msg": " ",
  "error_msg": null
}

Procedura recupero dettagli grafico

Restituisce il dizionario json dei dati che possono essere rappresentati.

I risultati sono costituiti da due campi:

item contiene informazioni generali dall'approfondimento: description, XAXIS, measure, insight_type_label, visualization_condition, source_object

La query contiene informazioni per la rappresentazione e ha tre elenchi: etichette, effettivi e stime.

Sintassi

Insight.get_graph_details(name, id, count, query_manipulation,
                          owner)

Parametri:

• nome: il nome dell'Insight.
• ID: l'ID della visualizzazione.
• conteggio: numero di valori visualizzati
• query_manipulation: se non è impostato su Nessuno, aggiungere i campi relativi al tipo di cursore e ai totali complessivi alla query.
• Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile ottenere i dati per tracciare il grafico:

adp.Insight.get_graph_details("INSIGHT_62", 199, 5, True)
 
 Output:
{
  "items": {
    "description": "COUNTRY.2",
    "XAXIS": "FORECST",
    "measure": "ACTUAL",
    "insight_type_label": "Expected",
    "visualization_condition": "COUNTRY.2",
    "source_object": "C0"
  },
  "query": {
    "labels": [
      "01:[66.7-1590]",
      "02:[829-2350]",
      "04:[2350-3870]",
      "06:[3870-5390]",
      "07:[4630-6150]"
    ],
    "actuals": [
      2200,
      6200,
      24600,
      26600,
      14200
    ],
    "estimates": [
      2671.105013588167,
      4830.820533674098,
      7135.506976989193,
      24772.963909661587,
      22121.48462234561
    ]
  }
}