Feedback Stats

Return aggregated feedback statistics over time buckets.

POST /feedback/stats

Feedback Stats

cURL

curl --request POST \
  --url https://api.example.com/feedback/stats \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "feedback_type": "<string>",
  "trigger_ref": "<string>",
  "granularity": 123,
  "timezone": "UTC",
  "metrics": [
    {
      "json_path": "<string>",
      "value_type": "numeric",
      "aggregations": [],
      "percentiles": [
        123
      ]
    }
  ]
}
'

import requests

url = "https://api.example.com/feedback/stats"

payload = {
    "project_id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "feedback_type": "<string>",
    "trigger_ref": "<string>",
    "granularity": 123,
    "timezone": "UTC",
    "metrics": [
        {
            "json_path": "<string>",
            "value_type": "numeric",
            "aggregations": [],
            "percentiles": [123]
        }
    ]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    start: '2023-11-07T05:31:56Z',
    end: '2023-11-07T05:31:56Z',
    feedback_type: '<string>',
    trigger_ref: '<string>',
    granularity: 123,
    timezone: 'UTC',
    metrics: [
      {
        json_path: '<string>',
        value_type: 'numeric',
        aggregations: [],
        percentiles: [123]
      }
    ]
  })
};

fetch('https://api.example.com/feedback/stats', 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/feedback/stats",
  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([
    'project_id' => '<string>',
    'start' => '2023-11-07T05:31:56Z',
    'end' => '2023-11-07T05:31:56Z',
    'feedback_type' => '<string>',
    'trigger_ref' => '<string>',
    'granularity' => 123,
    'timezone' => 'UTC',
    'metrics' => [
        [
                'json_path' => '<string>',
                'value_type' => 'numeric',
                'aggregations' => [
                                
                ],
                'percentiles' => [
                                123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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/feedback/stats"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"feedback_type\": \"<string>\",\n  \"trigger_ref\": \"<string>\",\n  \"granularity\": 123,\n  \"timezone\": \"UTC\",\n  \"metrics\": [\n    {\n      \"json_path\": \"<string>\",\n      \"value_type\": \"numeric\",\n      \"aggregations\": [],\n      \"percentiles\": [\n        123\n      ]\n    }\n  ]\n}")

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

	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/feedback/stats")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"feedback_type\": \"<string>\",\n  \"trigger_ref\": \"<string>\",\n  \"granularity\": 123,\n  \"timezone\": \"UTC\",\n  \"metrics\": [\n    {\n      \"json_path\": \"<string>\",\n      \"value_type\": \"numeric\",\n      \"aggregations\": [],\n      \"percentiles\": [\n        123\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/feedback/stats")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"feedback_type\": \"<string>\",\n  \"trigger_ref\": \"<string>\",\n  \"granularity\": 123,\n  \"timezone\": \"UTC\",\n  \"metrics\": [\n    {\n      \"json_path\": \"<string>\",\n      \"value_type\": \"numeric\",\n      \"aggregations\": [],\n      \"percentiles\": [\n        123\n      ]\n    }\n  ]\n}"

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

200

{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "granularity": 123,
  "timezone": "<string>",
  "buckets": [
    {}
  ],
  "window_stats": {}
}

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

Body

application/json

Request for aggregated feedback statistics over time buckets.

project_id · string · required

start · string<date-time> · required

Inclusive start time (UTC, ISO 8601).

end · string<date-time> | null

Exclusive end time (UTC, ISO 8601). Defaults to now if omitted.

feedback_type · string | null

Filter by feedback_type.

trigger_ref · string | null

Filter by trigger_ref (exact or prefix match for all-versions).

granularity · integer | null

Bucket size in seconds. If omitted, auto-selected based on time range.

timezone · string · default: UTC

IANA timezone for bucket alignment.

metrics · FeedbackMetricSpec · object[]

Metrics to aggregate from payload_dump.

Show child attributes

Response

200

application/json

Successful Response

Response with time-series feedback statistics.

start · string<date-time> · required

Resolved start time (always UTC, regardless of the requested timezone).

end · string<date-time> · required

Resolved end time (always UTC, regardless of the requested timezone).

granularity · integer · required

Bucket size used (in seconds)

timezone · string · required

Timezone used for bucket alignment

buckets · Buckets · object[]

Time-bucketed aggregations. Each dict has 'timestamp' (ISO string), 'count' (int), and '{agg}_{slug}' keys for each requested metric+aggregation.

window_stats · Window Stats · object | null

Aggregations over the full query window, keyed by metric slug (e.g. 'output_score'). Each value maps agg name to result.

Show child attributes