Skip to main content
POST
/
v3
/
baselines
add baseline to a model
curl --request POST \
  --url https://api.example.com/v3/baselines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "env_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_time": 123,
  "end_time": 123,
  "offset_delta": 2
}
'
import requests

url = "https://api.example.com/v3/baselines"

payload = {
    "name": "<string>",
    "model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "env_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_time": 123,
    "end_time": 123,
    "offset_delta": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    model_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    env_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    start_time: 123,
    end_time: 123,
    offset_delta: 2
  })
};

fetch('https://api.example.com/v3/baselines', 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.example.com/v3/baselines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'model_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'env_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'start_time' => 123,
    'end_time' => 123,
    'offset_delta' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.example.com/v3/baselines"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"env_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_time\": 123,\n  \"end_time\": 123,\n  \"offset_delta\": 2\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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.example.com/v3/baselines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"env_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_time\": 123,\n  \"end_time\": 123,\n  \"offset_delta\": 2\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/baselines")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"model_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"env_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_time\": 123,\n  \"end_time\": 123,\n  \"offset_delta\": 2\n}"

response = http.request(request)
puts response.read_body
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "row_count": 123,
    "model": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "version": "<string>"
    },
    "project": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "organization": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "environment": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "start_time": 123,
    "end_time": 123,
    "offset_delta": 2
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

A name describing the baseline

​
model_id
string<uuid>
required

The unique identifier for the model associated with the baseline

​
type
enum<string>
required

The type of baseline, indicating whether it is STATIC or ROLLING.

Available options:
STATIC,
ROLLING
​
env_type
enum<string>
required

The environment type for the baseline, indicating whether it applies to production or pre-production environments.

Available options:
PRODUCTION,
PRE_PRODUCTION
​
env_id
string<uuid> | null

Required when env_type is PRE_PRODUCTION

​
start_time
integer

Start time in milliseconds from epoch for production data

​
end_time
integer

End time in milliseconds from epoch for production data

​
offset_delta
integer

x is offset delta for offset=x*window_bin_size

Required range: x >= 1
​
window_bin_size
enum<string>

Window size to be used for relative baseline

Available options:
Hour,
Day,
Week,
Month

Response

successful baseline creation

Response object for standard API responses.

​
api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
​
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
​
data
timestamp · object

To record created at and updated at timestamp fields