Trigger report generation | Opik Documentation

POST/v1/private/projects/{projectId}/reports/generateTrigger report generation

Creates a pending report and triggers asynchronous generation via the orchestrator.

Parameters

projectIdstring · uuidpathrequired

Responses

objectGenerateReportResponse

Response for report generation trigger

reportIdstring · uuid

Example response

{
  "reportId": "00000000-0000-0000-0000-000000000000"
}

Examples

projectIdrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate'

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate', { method: 'POST' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate', { method: 'POST' });
console.log(await response.json());

import requests

response = requests.request("POST", "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate", 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/projects/00000000-0000-0000-0000-000000000000/reports/generate");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate")
request = Net::HTTPGenericRequest.new("POST", 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.Post, "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/reports/generate");
using var response = await client.SendAsync(request);

{
  "reportId": "00000000-0000-0000-0000-000000000000"
}