Skip to main content
GET
/
v1
/
scoring-frameworks
/
{id}
Get a scoring framework
curl --request GET \
  --url https://api.metal.ai/v1/scoring-frameworks/{id} \
  --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.

Path Parameters

​
id
string
required

The scoring framework id.

Response

Retrieves a scoring framework by id.

​
data
object