Skip to main content
POST
/
feedback
/
payload_schema
Feedback Payload Schema
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>",
  "trigger_ref": "<string>",
  "sample_limit": 2000
}
'
{
  "paths": [
    {
      "json_path": "<string>",
      "value_type": "numeric"
    }
  ]
}

Authorizations

โ€‹
Authorization
string
header
required

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

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

Successful Response

Response with discovered feedback payload paths and types.

โ€‹
paths
FeedbackPayloadPath ยท object[]

Discovered leaf paths with inferred value types.