> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creditbenchmark.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Exemples de charge utile de l’API

> Copiez-collez les corps de requête pour les requêtes courantes de l’API Credit Benchmark Analytics, y compris la syntaxe de jointure des filtres et des exemples de charges utiles multidimensionnelles.

Utilisez ces formats de charge utile canoniques pour les requêtes courantes de l’API Analytics. La requête la plus courante est une `getdata` portant sur une liste connue de `CB_ID`.

<AccordionGroup>
  <Accordion title="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.

    ```json theme={null}
    {
      "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"
          ]
        }
      }
    }
    ```
  </Accordion>

  <Accordion title="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.

    ```json theme={null}
    {
      "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
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="Récupérer toutes les données">
    Utilisez une `scope.filters` lorsque vous souhaitez toutes les entités disposant d’une note de consensus.

    ```json theme={null}
    {
      "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": ""
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="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**.

    ```json theme={null}
    {
      "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"
          }
        ]
      }
    }
    ```
  </Accordion>

  <Accordion title="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`.

    ```json theme={null}
    {
      "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.

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

    <Tip>
      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.
    </Tip>
  </Accordion>
</AccordionGroup>