Find experiment groups | Opik Documentation

GET/v1/private/experiments/groupsFind experiment groups

Find experiments grouped by specified fields

Parameters

groupsstringquery

typesstringquery

namestringquery

Filter experiments by name (partial match, case insensitive)

project_idstring · uuidquery

project_deletedbooleanquery

filtersstringquery

Responses

objectExperimentGroupResponse

contentobject

detailsobject

Show child attributes

groups_detailsarray of object

Show child attributes

Show array items

group_sortingarray of string

Show child attributes

Example response

{
  "content": {
    "additionalProp1": {
      "label": "string"
    }
  },
  "details": {
    "groups_details": [
      {
        "group_sorting": [
          "string"
        ]
      }
    ]
  }
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

groupsquery parameter

typesquery parameter

namequery parameter

project_idquery parameter

project_deletedquery parameter

filtersquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string'

const response = await fetch('http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/experiments/groups?filters=string&groups=string&name=string&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&types=string");
using var response = await client.SendAsync(request);

{
  "content": {
    "additionalProp1": {
      "label": "string"
    }
  },
  "details": {
    "groups_details": [
      {
        "group_sorting": [
          "string"
        ]
      }
    ]
  }
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}