Feedback Payload Schema

Discover feedback payload schema (paths and types) from sample rows.

POST /feedback/payload_schema

Feedback Payload Schema

cURL

curl --request POST \
  --url https://api.example.com/feedback/payload_schema \
  --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>",
  "sample_limit": 2000
}
'

import requests

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

payload = {
    "project_id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "feedback_type": "<string>",
    "trigger_ref": "<string>",
    "sample_limit": 2000
}
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>',
    sample_limit: 2000
  })
};

fetch('https://api.example.com/feedback/payload_schema', 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/payload_schema",
  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>',
    'sample_limit' => 2000
  ]),
  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/payload_schema"

	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  \"sample_limit\": 2000\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/payload_schema")
  .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  \"sample_limit\": 2000\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sample_limit\": 2000\n}"

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

200

{
  "paths": [
    {
      "json_path": "<string>",
      "value_type": "numeric"
    }
  ]
}

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

Body

application/json

Request for feedback payload schema discovery.

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).

sample_limit · integer · default: 2000

Max distinct trigger_refs to sample when discovering the payload schema. Each distinct trigger_ref (monitor/source) typically has a fixed payload structure, so sampling one payload per ref is usually enough to see the full schema. 2 000 covers virtually all real-world projects while keeping the query fast; the hard cap of 5 000 prevents runaway scans.

Required range: 1 <= x <= 5000

Response

200

application/json

Successful Response

Response with discovered feedback payload paths and types.

paths · FeedbackPayloadPath · object[]

Discovered leaf paths with inferred value types.

Show child attributes