Skip to main content
GET
/
v1
/
metrics
Get all metrics
curl --request GET \
  --url https://api.honeyhive.ai/v1/metrics \
  --header 'Authorization: Bearer <token>'
[
  [
    {
      "name": "<string>",
      "type": "PYTHON",
      "criteria": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "",
      "return_type": "float",
      "enabled_in_prod": false,
      "needs_ground_truth": false,
      "sampling_percentage": 100,
      "model_provider": "<string>",
      "model_name": "<string>",
      "scale": 123,
      "threshold": {
        "min": 123,
        "max": 123,
        "pass_when": true,
        "passing_categories": [
          "<string>"
        ]
      },
      "categories": [
        {
          "category": "<string>",
          "score": 123
        }
      ],
      "child_metrics": [
        {
          "name": "<string>",
          "weight": 123,
          "id": "<string>",
          "scale": 123
        }
      ],
      "filters": {
        "filterArray": []
      }
    }
  ]
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
string

Filter by metric type

id
string

Filter by specific metric ID

Response

200 - application/json

A list of metrics

name
string
required
Maximum string length: 200
type
enum<string>
required
Available options:
PYTHON,
LLM,
HUMAN,
COMPOSITE
criteria
string
required
Minimum string length: 1
id
string
required
Minimum string length: 1
created_at
string<date-time>
required
updated_at
string<date-time> | null
required
description
string
default:""
return_type
enum<string>
default:float
Available options:
float,
boolean,
string,
categorical
enabled_in_prod
boolean
default:false
needs_ground_truth
boolean
default:false
sampling_percentage
number
default:100
Required range: 0 <= x <= 100
model_provider
string | null
model_name
string | null
scale
integer | null
threshold
object
categories
object[] | null
Minimum array length: 1
child_metrics
object[] | null
Minimum array length: 1
filters
object