Skip to main content
GET
/
v1
/
scoring-frameworks
List scoring frameworks
curl --request GET \
  --url https://api.metal.ai/v1/scoring-frameworks \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isStandard": true,
      "elements": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "weight": 123,
          "scoringLogic": "<string>",
          "dataRequirements": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-metal-client-id
string
header
required

The Client ID of your API key.

x-metal-api-key
string
header
required

The secret value of your API key.

Query Parameters

page
integer
default:1

Page number, starting at 1 (max 100).

Required range: 1 <= x <= 100
limit
integer
default:100

Items per page (1 to 1000).

Required range: 1 <= x <= 1000

Response

A list of scoring frameworks.

data
object[]