Skip to main content
POST
/
v1
/
metrics
/
{metric_id}
/
versions
/
{version_name}
/
deploy
Deploy a specific metric version
curl --request POST \
  --url https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.honeyhive.ai/v1/metrics/{metric_id}/versions/{version_name}/deploy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "name": "<string>",
    "full_sha": "<string>",
    "message": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "deployed": true,
    "content": {
      "name": "<string>",
      "criteria": "<string>",
      "description": "<string>",
      "enabled_in_prod": true,
      "needs_ground_truth": true,
      "sampling_percentage": 50,
      "filters": {
        "filterArray": [
          {
            "field": "<string>",
            "value": "<string>"
          }
        ]
      },
      "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
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

metric_id
string
required

The unique identifier of the metric

version_name
string
required

The name of the version to deploy

Response

Metric version deployed successfully

Response for POST /v1/metrics/{metric_id}/versions/{version_name}/deploy

success
enum<boolean>
required
Available options:
true
data
object
required

A versioned snapshot of a metric definition.