Stats

Read the real contents of one page of replies (audited)

Returns the same page unredacted, and records a form.replies_revealed activity naming the acting admin, the site, the form, how many replies were read and the reason given. A POST rather than a query flag because it is a recorded action with a required body, and because a justification does not belong in a URL that lands in access logs. One page per record, so the audit trail stays proportionate to what was actually read.

post/stats/forms/{id}/submissions/reveal

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/stats/forms/{id}/submissions/reveal
  • Auth: bearer (a scheme the document does not define)

Path parameters

idstring required

Form UUID

Request body

reasonstring required

Why these replies need reading — an abuse investigation, a support escalation, an erasure request. Recorded verbatim in the admin activity feed and not editable afterwards.

limitnumber

Replies to reveal.

offsetnumber

Rows to skip.

Response

totalnumber required

Total replies stored for this form

revealedboolean required

False on the default listing — every value is redacted. True only on the response to an audited reveal, where the values are the real ones and a form.replies_revealed activity has been recorded.

Changes

No recorded changes to this operation across all 1 revision of this API.