Exemples de charge utile API - Credit Benchmark Docs

Récupérer les données pour les CBIds

Pour obtenir une liste des entités connues, utilisez scope.portfolio.CBId. Définissez lookback_period sur 0 pour les données ponctuelles, et n’interrogez que les colonnes dont vous avez besoin.

{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "portfolio": {
      "CBId": [
        "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 notation de bbb- ou inférieure.

{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CCR21Notch",
        "operator": ">=",
        "values": 8
      }
    ]
  }
}

Récupérer toutes les données

Utilisez une condition large scope.filters lorsque vous souhaitez toutes les entités ayant une notation consensuelle.

{
  "lookback_period": 0,
  "columns": [
    "CBId",
    "CBEntityName",
    "EffectiveDateId",
    "CCR",
    "CCR100PDMid"
  ],
  "scope": {
    "filters": [
      {
        "key": "CCR",
        "operator": "is not null",
        "values": ""
      }
    ]
  }
}

Filtrage et tri des résultats

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

{
  "result_filter": {
    "filters": [
      {
        "key": "CCR100PDMid",
        "operator": ">",
        "values": 0.002
      }
    ],
    "sort": [
      {
        "field": "CCR100PDMid",
        "direction": "asc"
      }
    ]
  }
}

Syntaxe de la jointure de filtres

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

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

Pour un OU explicite, placez | entre les filtres.

{
  "scope": {
    "filters": [
      {
        "key": "CBCountryOfRisk",
        "operator": "==",
        "values": "United States"
      },
      {
        "key": "CBSector",
        "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 exécutée.

Documentation Index