Feedback

Generated feedback operations.

GET/v1/feedback/capabilitiesRead feedback capabilitiesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_feedback_capabilities

Responses

200Successapplication/json

Example

{
  "data": {
    "canSubmit": true,
    "diagnosticsDecisions": [
      "string"
    ],
    "diagnosticsOptional": true,
    "diagnosticsSupported": true,
    "duplicateWindowHours": 0,
    "kinds": [
      {
        "categories": [
          {}
        ],
        "id": "id_8h2k4q",
        "label": "string"
      }
    ],
    "maxMessageLength": 0,
    "minMessageLength": 0,
    "perProfileHourlyLimit": 0,
    "reporterAuthority": "string",
    "reporterName": "Fargo",
    "retentionDays": 0,
    "revision": "r12",
    "statuses": [
      "string"
    ],
    "submitBlockedReason": "string"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- canSubmitbooleanrequired
- diagnosticsDecisionsarray of stringrequired
- diagnosticsOptionalbooleanrequired
- diagnosticsSupportedbooleanrequired
- duplicateWindowHoursintegerrequired
- kindsarray of objectrequired
  - categoriesarray of objectrequired
    descriptionstringrequired
    idstringrequired
    labelstringrequired
    wantsItembooleanrequired
    wantsPlaybackSessionbooleanrequired
  - idstringrequired
  - labelstringrequired
- maxMessageLengthintegerrequired
- minMessageLengthintegerrequired
- perProfileHourlyLimitintegerrequired
- reporterAuthoritystringrequired
- reporterNamestringrequired
- retentionDaysintegerrequired
- revisionstringrequired
- statusesarray of stringrequired
- submitBlockedReasonstring
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/feedback/capabilities" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/feedback/reportsRead or update the selected projectionread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_feedback_reports

Parameters

Name	In	Type
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–100
`status`	query	`string`
`kind`	query	`string`
`category`	query	`string`
`itemId`	query	`string`
`reporter`	query	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "filter": {
      "key": "string"
    },
    "items": [
      {
        "category": "string",
        "client": {
          "appVersion": "string",
          "online": true,
          "platform": "string"
        },
        "createdAt": "2026-10-18T19:30:00Z",
        "cursor": "eyJvIjoyMH0",
        "diagnostics": {
          "decision": "string",
          "detail": "string",
          "reference": "string"
        },
        "duplicateOf": "string",
        "duplicates": 0,
        "expiresAt": "2026-10-18T19:30:00Z",
        "id": "id_8h2k4q",
        "itemId": "id_8h2k4q",
        "kind": "string",
        "message": "string",
        "reporter": {
          "authority": "string",
          "name": "Fargo",
          "role": "string",
          "self": true
        },
        "revision": 0,
        "status": "string",
        "thread": [
          {}
        ],
        "updatedAt": "2026-10-18T19:30:00Z"
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "observedAt": "2026-10-18T19:30:00Z",
    "statusCounts": {
      "key": 0
    },
    "total": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- filterobjectrequired
- itemsarray of objectrequired
  - categorystringrequired
  - clientobject
    appVersionstringrequired
    onlineboolean
    platformstringrequired
  - createdAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - cursorstringrequired
  - diagnosticsobjectrequired
    decisionstringrequired
    detailstring
    referencestring
  - duplicateOfstring
  - duplicatesintegerrequired
  - expiresAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - idstringrequired
  - itemIdstring
  - kindstringrequired
  - messagestringrequired
  - reporterobjectrequired
    authoritystringrequired
    namestringrequired
    rolestringrequired
    selfbooleanrequired
  - revisionintegerrequired
  - statusstringrequired
  - threadarray of objectrequired
    actorClassstringrequired
    atstringrequired
    RFC 3339 UTC instant; empty when absent.
    replystringrequired
    revisionintegerrequired
    sequenceintegerrequired
    statusstringrequired
  - updatedAtstringrequired
    RFC 3339 UTC instant; empty when absent.
- nextCursorstringrequired
- observedAtstringrequired
  RFC 3339 UTC instant; empty when absent.
- statusCountsobjectrequired
- totalintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/feedback/reports" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/feedback/reportsRead or update the selected projectionplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: post_feedback_reports
Max body: 1 MiB

Request body application/json · required

Example

{
  "attachDiagnostics": true,
  "category": "string",
  "client": {
    "appVersion": "string",
    "online": true,
    "platform": "string"
  },
  "itemId": "id_8h2k4q",
  "kind": "string",
  "message": "string",
  "operationId": "id_8h2k4q",
  "playbackSessionId": "id_8h2k4q"
}

Schema

attachDiagnosticsbooleanrequired
categorystringrequired
clientobject
- appVersionstringrequired
- onlineboolean
- platformstringrequired
itemIdstringrequired
kindstringrequired
messagestringrequiredlength 8–2000
operationIdstringrequired
playbackSessionIdstringrequired

Responses

200Successapplication/json

Example

{
  "data": {
    "created": true,
    "duplicate": true,
    "duplicateOf": "string",
    "report": {
      "category": "string",
      "client": {
        "appVersion": "string",
        "online": true,
        "platform": "string"
      },
      "createdAt": "2026-10-18T19:30:00Z",
      "cursor": "eyJvIjoyMH0",
      "diagnostics": {
        "decision": "string",
        "detail": "string",
        "reference": "string"
      },
      "duplicateOf": "string",
      "duplicates": 0,
      "expiresAt": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "itemId": "id_8h2k4q",
      "kind": "string",
      "message": "string",
      "reporter": {
        "authority": "string",
        "name": "Fargo",
        "role": "string",
        "self": true
      },
      "revision": 0,
      "status": "string",
      "thread": [
        {
          "actorClass": "string",
          "at": "2026-10-18T19:30:00Z",
          "reply": "string",
          "revision": 0,
          "sequence": 0,
          "status": "string"
        }
      ],
      "updatedAt": "2026-10-18T19:30:00Z"
    }
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- createdbooleanrequired
- duplicatebooleanrequired
- duplicateOfstring
- reportobjectrequired
  - categorystringrequired
  - clientobject
    appVersionstringrequired
    onlineboolean
    platformstringrequired
  - createdAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - cursorstringrequired
  - diagnosticsobjectrequired
    decisionstringrequired
    detailstring
    referencestring
  - duplicateOfstring
  - duplicatesintegerrequired
  - expiresAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - idstringrequired
  - itemIdstring
  - kindstringrequired
  - messagestringrequired
  - reporterobjectrequired
    authoritystringrequired
    namestringrequired
    rolestringrequired
    selfbooleanrequired
  - revisionintegerrequired
  - statusstringrequired
  - threadarray of objectrequired
    actorClassstringrequired
    atstringrequired
    RFC 3339 UTC instant; empty when absent.
    replystringrequired
    revisionintegerrequired
    sequenceintegerrequired
    statusstringrequired
  - updatedAtstringrequired
    RFC 3339 UTC instant; empty when absent.
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/feedback/reports" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "attachDiagnostics": true,
  "category": "string",
  "client": {
    "appVersion": "string",
    "online": true,
    "platform": "string"
  },
  "itemId": "id_8h2k4q",
  "kind": "string",
  "message": "string",
  "operationId": "id_8h2k4q",
  "playbackSessionId": "id_8h2k4q"
}'

GET/v1/feedback/reports/{id}Read or update the selected projectionread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_feedback_reports_id

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "category": "string",
    "client": {
      "appVersion": "string",
      "online": true,
      "platform": "string"
    },
    "createdAt": "2026-10-18T19:30:00Z",
    "cursor": "eyJvIjoyMH0",
    "diagnostics": {
      "decision": "string",
      "detail": "string",
      "reference": "string"
    },
    "duplicateOf": "string",
    "duplicates": 0,
    "expiresAt": "2026-10-18T19:30:00Z",
    "id": "id_8h2k4q",
    "itemId": "id_8h2k4q",
    "kind": "string",
    "message": "string",
    "reporter": {
      "authority": "string",
      "name": "Fargo",
      "role": "string",
      "self": true
    },
    "revision": 0,
    "status": "string",
    "thread": [
      {
        "actorClass": "string",
        "at": "2026-10-18T19:30:00Z",
        "reply": "string",
        "revision": 0,
        "sequence": 0,
        "status": "string"
      }
    ],
    "updatedAt": "2026-10-18T19:30:00Z"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- categorystringrequired
- clientobject
  - appVersionstringrequired
  - onlineboolean
  - platformstringrequired
- createdAtstringrequired
  RFC 3339 UTC instant; empty when absent.
- cursorstringrequired
- diagnosticsobjectrequired
  - decisionstringrequired
  - detailstring
  - referencestring
- duplicateOfstring
- duplicatesintegerrequired
- expiresAtstringrequired
  RFC 3339 UTC instant; empty when absent.
- idstringrequired
- itemIdstring
- kindstringrequired
- messagestringrequired
- reporterobjectrequired
  - authoritystringrequired
  - namestringrequired
  - rolestringrequired
  - selfbooleanrequired
- revisionintegerrequired
- statusstringrequired
- threadarray of objectrequired
  - actorClassstringrequired
  - atstringrequired
    RFC 3339 UTC instant; empty when absent.
  - replystringrequired
  - revisionintegerrequired
  - sequenceintegerrequired
  - statusstringrequired
- updatedAtstringrequired
  RFC 3339 UTC instant; empty when absent.
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/feedback/reports/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"