Widgets

Read one widget

Returns one widget of one section of a report: the same object /v1/reports/get publishes for it -- what it is, where it reads from and either its definition in the widget DSL or the named reason it has none -- plus the three things an edit needs. widget_hash is the fingerprint of the definition and travels back as if_widget_hash on a write. lost_properties says what a rewrite carrying that same definition would not be able to keep. backup_keys lists the backups the widget can be put back from, newest first; they expire after 7 days. In a report built on a template this answers for the copy the report keeps of its own, which is the widget_key /v1/reports/get publishes there.

Refusals: 400 for the body, 404 NOT_FOUND for the report, the section or the widget, 409 REPORT_IN_TRASH.

post/widgets/get

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/widgets/get
  • Auth: HTTP bearer

Request body

report_keystring required

The report the widget belongs to.

section_keystring required

The section the widget is in, as /v1/reports/get names it.

widget_keystring required

The widget to read, as /v1/reports/get names it. In a report built on a template that is the key of the copy the report keeps of its own, which is the one this endpoint answers for.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

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