Passer au contenu principal
POST
/
feedback
/
payload_schema
Schéma de payload de feedback
curl --request POST \
  --url https://api.example.com/feedback/payload_schema \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "feedback_type": "<string>",
  "sample_limit": 2000,
  "trigger_ref": "<string>"
}
'
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>",
"sample_limit": 2000,
"trigger_ref": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', '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>',
sample_limit: 2000,
trigger_ref: '<string>'
})
};

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>',
'sample_limit' => 2000,
'trigger_ref' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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 \"sample_limit\": 2000,\n \"trigger_ref\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
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("Authorization", "Basic <encoded-value>")
.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 \"sample_limit\": 2000,\n \"trigger_ref\": \"<string>\"\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["Authorization"] = 'Basic <encoded-value>'
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 \"sample_limit\": 2000,\n \"trigger_ref\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "paths": [
    {
      "json_path": "<string>",
      "value_type": "numeric"
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Autorisations

Authorization
string
header
requis

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Corps

application/json

Requête de découverte du schéma de payload du feedback.

project_id
string
requis
start
string<date-time>
requis

Heure de début incluse (UTC, ISO 8601).

end
string<date-time> | null

Heure de fin exclue (UTC, ISO 8601). Par défaut, l’heure actuelle si elle est omise.

feedback_type
string | null

Filtre par feedback_type.

sample_limit
integer
défaut:2000

Nombre maximal de trigger_ref distincts à échantillonner lors de la découverte du schéma de payload. Chaque trigger_ref distinct (monitor/source) a généralement une structure de payload fixe ; échantillonner un payload par ref suffit donc habituellement pour voir le schéma complet. 2 000 couvrent pratiquement tous les projets réels tout en gardant une requête rapide ; la limite stricte de 5 000 évite les scans incontrôlés.

Plage requise: 1 <= x <= 5000
trigger_ref
string | null

Filtre par trigger_ref (correspondance exacte ou par préfixe pour all-versions).

Réponse

Réponse réussie

Réponse contenant les chemins et les types découverts du payload de feedback.

paths
FeedbackPayloadPath · object[]

Chemins terminaux découverts avec types de valeurs inférés.