Exemples de charge utile de l’API

Récupérer les données pour les identifiants CB

Pour obtenir la liste des entités connues, utilisez scope.portfolio.CB_ID. Définissez lookback_period sur 0 pour les données à un instant donné, et ne demandez que les colonnes dont vous avez besoin.

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "portfolio": {
      "CB_ID": [
        "CB0000022706",
        "CB0000022177"
      ]
    }
  }
}

Récupérer les données d’un univers

Utilisez scope.filters lorsque vous souhaitez que l’API construise l’univers d’entrée avant l’exécution de la requête. Cet exemple renvoie les entités des États-Unis ayant une note de bbb- ou inférieure.

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CB_Country",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CB_CCR_21_Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

Récupérer toutes les données

Utilisez une scope.filters lorsque vous souhaitez toutes les entités disposant d’une note de consensus.

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CB_CCR",
        "operator": "!=",
        "values": ""
      }
    ]
  }
}

Filtrage et tri des résultats

Utilisez result_filter pour filtrer ou trier les lignes une fois les données sélectionnées. Ceci est distinct de scope.filters, qui définit l’univers d’entrée avant l’exécution de la requête.

{
  "lookback_period": 0,
  "columns": [
    "CB_ID",
    "CB_Legal_Name",
    "CB_Effective_Date_ID",
    "CB_CCR",
    "CB_CCR_100_PDMid"
  ],
  "scope": {
    "portfolio": {
      "CB_ID": [
        "CB0000022706",
        "CB0000022177"
      ]
    }
  },
  "result_filter": {
    "filters": [
      {
        "key": "CB_CCR_100_PDMid",
        "operator": ">",
        "values": 0.002
      }
    ],
    "sort": [
      {
        "field": "CB_CCR_100_PDMid",
        "direction": "asc"
      }
    ]
  }
}

Syntaxe de la jointure de filtres

filters_join est facultatif. Si vous l’omettez, les filtres multiples sont combinés avec l’opérateur ET.N’ajoutez filters_join lorsque vous avez besoin d’une logique booléenne explicite telle que NOT, OR ou une expression mixte. Lorsqu’il est présent, il est positionnel et doit comporter un élément de plus que filters.Pour un simple « ET », omettez filters_join.

{
  "scope": {
    "filters": [
      {
        "key": "CB_Country",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CB_CCR_21_Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

Pour un « OU » explicite, placez-le | entre les filtres.

{
  "scope": {
    "filters": [
      {
        "key": "CB_Country",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CB_Sector",
        "operator": "!=",
        "values": "Insurance"
      }
    ],
    "filters_join": ["", "|", ""]
  }
}

Utilisez scope.filters pour définir l’univers d’entrée avant l’exécution de l’analyse. Utilisez result_filter.filters uniquement pour filtrer les lignes de sortie calculées une fois l’analyse terminée.

Aperçu

Critères d'évaluation

Modèle de résolution d'entités

Analyse