List Model Lab run facet values

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.datadoghq.eu/api/v2/model-lab-api/facet-valueshttps://api.ddog-gov.com/api/v2/model-lab-api/facet-valueshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/facet-valueshttps://api.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.us3.datadoghq.com/api/v2/model-lab-api/facet-valueshttps://api.us5.datadoghq.com/api/v2/model-lab-api/facet-values

Overview

List available facet values for a specific run facet key.

Arguments

Query Strings

Name

Type

Description

filter[project_id] [required]

integer

Filter by project ID.

facet_type [required]

enum

Facet type. Valid values: parameter, attribute, tag, metric.
Allowed enum values: parameter, attribute, tag, metric

facet_name [required]

string

Facet name.

Response

OK

Response containing available values for a facet key.

Expand All

Field

Type

Description

data [required]

object

A facet values JSON:API resource object.

attributes [required]

object

Available values for a specific facet key.

facet_name [required]

string

The name of the facet.

facet_type [required]

string

The type of the facet.

metric_stat_ranges

[object]

The ranges for each metric statistic.

max [required]

double

The maximum value of the statistic.

min [required]

double

The minimum value of the statistic.

stat [required]

string

The metric statistic name.

numeric_range

object

The numeric range of values for a facet.

max [required]

double

The maximum value.

min [required]

double

The minimum value.

values [required]

[string]

The list of available string values for this facet.

id [required]

string

The unique identifier of the facet values resource.

type [required]

enum

The JSON:API type for a facet values resource. Allowed enum values: facet_values

{
  "data": {
    "attributes": {
      "facet_name": "model",
      "facet_type": "tag",
      "metric_stat_ranges": [
        {
          "max": 1,
          "min": 0,
          "stat": "mean"
        }
      ],
      "numeric_range": {
        "max": 1,
        "min": 0
      },
      "values": [
        "gpt4"
      ]
    },
    "id": "1",
    "type": "facet_values"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Internal Server Error

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                  # Required query arguments
export filter[project_id]="101"
export facet_type="tag"
export facet_name="algorithm"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/model-lab-api/facet-values?filter[project_id]=${filter[project_id]}&facet_type=${facet_type}&facet_name=${facet_name}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"