Query Custom Metrics

POST /v2/projects/{project_id}/metrics/custom_search

Query Custom Metrics

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/projects/{project_id}/metrics/custom_search \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "metric_details": [
    {
      "id": "<string>",
      "metric_name": "<string>"
    }
  ],
  "log_stream_id": "<string>",
  "experiment_id": "<string>",
  "metrics_testing_id": "<string>",
  "filter_tree": {
    "filter": {
      "column_id": "<string>",
      "value": "<string>",
      "operator": "eq",
      "type": "id"
    }
  },
  "interval_minutes": 5,
  "group_by": "<string>"
}
'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/metrics/custom_search"

payload = {
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "metric_details": [
        {
            "id": "<string>",
            "metric_name": "<string>"
        }
    ],
    "log_stream_id": "<string>",
    "experiment_id": "<string>",
    "metrics_testing_id": "<string>",
    "filter_tree": { "filter": {
            "column_id": "<string>",
            "value": "<string>",
            "operator": "eq",
            "type": "id"
        } },
    "interval_minutes": 5,
    "group_by": "<string>"
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_time: '2023-11-07T05:31:56Z',
    end_time: '2023-11-07T05:31:56Z',
    metric_details: [{id: '<string>', metric_name: '<string>'}],
    log_stream_id: '<string>',
    experiment_id: '<string>',
    metrics_testing_id: '<string>',
    filter_tree: {filter: {column_id: '<string>', value: '<string>', operator: 'eq', type: 'id'}},
    interval_minutes: 5,
    group_by: '<string>'
  })
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/metrics/custom_search', 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.galileo.ai/v2/projects/{project_id}/metrics/custom_search",
  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([
    'start_time' => '2023-11-07T05:31:56Z',
    'end_time' => '2023-11-07T05:31:56Z',
    'metric_details' => [
        [
                'id' => '<string>',
                'metric_name' => '<string>'
        ]
    ],
    'log_stream_id' => '<string>',
    'experiment_id' => '<string>',
    'metrics_testing_id' => '<string>',
    'filter_tree' => [
        'filter' => [
                'column_id' => '<string>',
                'value' => '<string>',
                'operator' => 'eq',
                'type' => 'id'
        ]
    ],
    'interval_minutes' => 5,
    'group_by' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-API-Key: <api-key>"
  ],
]);

$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.galileo.ai/v2/projects/{project_id}/metrics/custom_search"

	payload := strings.NewReader("{\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"metric_details\": [\n    {\n      \"id\": \"<string>\",\n      \"metric_name\": \"<string>\"\n    }\n  ],\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"filter_tree\": {\n    \"filter\": {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  },\n  \"interval_minutes\": 5,\n  \"group_by\": \"<string>\"\n}")

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

	req.Header.Add("Galileo-API-Key", "<api-key>")
	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.galileo.ai/v2/projects/{project_id}/metrics/custom_search")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"metric_details\": [\n    {\n      \"id\": \"<string>\",\n      \"metric_name\": \"<string>\"\n    }\n  ],\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"filter_tree\": {\n    \"filter\": {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  },\n  \"interval_minutes\": 5,\n  \"group_by\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/metrics/custom_search")

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

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"end_time\": \"2023-11-07T05:31:56Z\",\n  \"metric_details\": [\n    {\n      \"id\": \"<string>\",\n      \"metric_name\": \"<string>\"\n    }\n  ],\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"filter_tree\": {\n    \"filter\": {\n      \"column_id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"operator\": \"eq\",\n      \"type\": \"id\"\n    }\n  },\n  \"interval_minutes\": 5,\n  \"group_by\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "group_by_columns": [
    "<string>"
  ],
  "aggregate_metrics": {},
  "bucketed_metrics": {},
  "ems_captured_error": false,
  "standard_errors": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

project_id · string<uuid4> · required

Body

application/json

start_time · string<date-time> · required

Include traces from this time onward.

end_time · string<date-time> · required

Include traces up to this time.

metric_details · MetricAggregationDetail · object[] · required

List of metrics to aggregate with their widget IDs and aggregation types (max 100)

Maximum array length: 100

Show child attributes

log_stream_id · string<uuid4> | null

Log stream id associated with the traces.

experiment_id · string<uuid4> | null

Experiment id associated with the traces.

metrics_testing_id · string<uuid4> | null

Metrics testing id associated with the traces.

filter_tree · FilterLeaf[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] · object

Filter expression tree for complex filtering

FilterLeaf[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

AndNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

OrNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

NotNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]

Show child attributes

interval_minutes · integer · default: 5

Time interval in minutes for bucketing

group_by · string | null

Column to group by

Response

200

application/json

Successful Response

group_by_columns · string[] · required

aggregate_metrics · Aggregate Metrics · object · required

Show child attributes

bucketed_metrics · Bucketed Metrics · object · required

Show child attributes

ems_captured_error · boolean · default: false

Whether any EMS error codes were encountered in the queried metrics

standard_errors · Standard Errors · object | null

Structured EMS errors for each error code encountered, keyed by code

Show child attributes