> ## 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.

# Esempi di payload API

> Corpi di richiesta pronti da copiare per le query più comuni dell’API Analytics, con sintassi di unione dei filtri ed esempi di payload multidimensionali.

Utilizzare tali strutture come forme canoniche di payload per le richieste più comuni all’API di Analytics. La richiesta più diffusa consiste in una `getdata` per un elenco noto di `CB_ID`.

<AccordionGroup>
  <Accordion title="Ottenere i dati per gli ID CB">
    Per un elenco di entità note, utilizzare `scope.portfolio.CB_ID`. Impostare `lookback_period` su `0` per ottenere dati a una certa data e richiedere soltanto le colonne necessarie.

    ```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="Ottenere i dati per un universo">
    Utilizzi `scope.filters` quando si desidera che l’API crei l’universo di input **prima dell’esecuzione della query**. Questo esempio restituisce le entità statunitensi con una valutazione pari a `bbb-` o inferiore.

    ```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="Recupera tutti i dati">
    Utilizzare una condizione ampia `scope.filters` quando si desiderano tutte le entità con una valutazione di consenso.

    ```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="Filtraggio e ordinamento dei risultati">
    Utilizzi `result_filter` per filtrare o ordinare le righe **dopo la selezione dei dati**. Questo parametro è distinto da `scope.filters`, che definisce l’universo di input **prima dell’esecuzione della query**.

    ```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="Sintassi di unione dei filtri">
    `filters_join` è facoltativo. Se lo si omette, i filtri multipli vengono concatenati con AND.

    Includere solo `filters_join` quando è necessaria una logica booleana esplicita, come NOT, OR o un’espressione mista. Quando è presente, è posizionale e deve contenere un elemento in più rispetto a `filters`.

    Per un semplice AND, ometta `filters_join`.

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

    Per un OR esplicito, inserisca `|` tra i filtri.

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

    <Tip>
      Utilizzi `scope.filters` per definire l’universo di input prima dell’esecuzione dell’analisi. `result_filter.filters` solo per filtrare le righe di output calcolate dopo che l’analisi è già stata eseguita.
    </Tip>
  </Accordion>
</AccordionGroup>