Fonctions d'analyse

Les fonctions Insight fournissent la syntaxe et les descriptions des classes, méthodes, attributs et paramètres de l'interface de programmation d'application à l'outil Insight de la suite d'outils Data Studio. La génération d'informations clés est effectuée en arrière-plan et nécessite une vérification de la fin.

Obtenir la liste de demandes - Procédure

Renvoie la liste des noms de demande et leurs paramètres

Syntaxe

Insight.get_request_list(owner)

Paramètres:

• owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez répertorier les travaux d'analyse :

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

Obtenir une procédure de liste d'informations clés

Renvoie une liste d'informations clés. Chaque information clé comporte les champs suivants : insight_name, visualization_id, insight_column, insight_value, insight_dimension, dimension

Syntaxe

Insight.get_insights_list(request_name)

Paramètres:

• request_name : nom de la demande.

Exemple

Dans cet exemple, vous pouvez répertorier les informations clés :

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

Supprimer la procédure d'analyse

Supprimer la demande d'informations clés

Syntaxe

Insight.drop(request_name)

Paramètres:

• request_name : nom de la demande.

Exemple

Dans cet exemple, vous pouvez supprimer la demande :

adp.Insight.drop('REQUEST_INSIGHT_1')

Générer une procédure d'analyse

Générer des informations sur la mesure pour la vue analytique.

Syntaxe

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

Paramètres:

• av_name : nom de la vue analytique.
• mesure : Mesure.
• job_owner : Ce champ affiche le propriétaire du travail. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
• source_owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez générer des informations clés pour la vue analytique :

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

Obtenir le statut du travail

Obtenir le statut du travail spécifié : Nom de la demande. La génération des informations clés est terminée lorsque le champ insight_job_status a la valeur COMPLETED.

Syntaxe

Insight.get_job_status(request_name, owner)

Paramètres:

• request_name : nom de la demande.
• owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez afficher le statut d'un travail :

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

Obtenir les détails du graphique - Procédure

Renvoie le dictionnaire json des données pouvant être représentées.

Les résultats se composent de deux champs :

item contient des informations générales issues des informations clés : description, XAXIS, measure, insight_type_label, visualization_condition, source_object

query contient des informations pour le traçage et comporte trois listes : labels, actuals et estimates

Syntaxe

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

Paramètres:

• name : nom de l'analyse.
• id : ID de visualisation.
• count : nombre de valeurs affichées
• query_manipulation : Si ce n'est pas le cas, ajoutez des champs de type de curseur et de totaux généraux à la requête.
• owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez obtenir des données pour tracer le graphique :

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