diffs

Diff two renders of the dashboard (pixelmatch).

Queues a pixel diff (DVT-25) between two succeeded renders of the dashboard and returns 202 with the diff record; poll GET …/diffs/{diffId} for status, the changed-pixel metrics, and the diff-image URL. The two renders must belong to this dashboard, have succeeded with a stored artifact, and share width/height/format (pixelmatch requires equal dimensions) — otherwise 422 problem type diff-input-invalid. The visual-regression substrate for the agent critique/iterate loop. Any org member may diff renders of a dashboard they can view; render sessions may not. Returns 503 problem type diff-unavailable while no render service is configured.

post/v1/dashboards/{id}/diffs

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/dashboards/{id}/diffs
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

baseRenderIdstring uuid required

The "before" render (the baseline).

headRenderIdstring uuid required

The "after" render (compared against the baseline).

Response

Diff queued.

Changes

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