Ejemplos de cargas útiles de la API

Obtener datos para los ID de CB

Para obtener una lista de entidades conocidas, utilice scope.portfolio.CB_ID. Establezca lookback_period en 0 para obtener datos a una fecha concreta y solicite únicamente las columnas necesarias.

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

Obtener datos para un universo

Utilice scope.filters cuando desee que la API construya el universo de entrada antes de que se ejecute la consulta. Este ejemplo devuelve entidades de Estados Unidos con una calificación de bbb- o inferior.

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

Obtener todos los datos

Utilice una scope.filters cuando desee todas las entidades con una calificación de consenso.

{
  "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": ""
      }
    ]
  }
}

Filtrado y ordenación de resultados

Utilice result_filter para filtrar u ordenar filas una vez seleccionados los datos. Esto es independiente de scope.filters, que define el universo de entrada antes de que se ejecute la consulta.

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

Sintaxis de unión de filtros

filters_join es opcional; si se omite, los filtros múltiples se combinan con «AND».Inclúyalo únicamente filters_join cuando necesite una lógica booleana explícita, como NOT, OR o una expresión mixta. Cuando esté presente, es posicional y debe tener un elemento más que filters.Para una conjunción AND simple, omítalo. filters_join.

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

Para un «OR» explícito, colóquelo | entre los filtros.

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

Utilice scope.filters para definir el universo de entrada antes de que se ejecute el análisis. Utilice result_filter.filters solo para filtrar las filas de salida calculadas una vez que el análisis ya se haya ejecutado.

Resumen

Puntos finales

Modelo de resolución de entidades

Análisis

Ejemplos de cargas útiles de la API