API Reference

Uploads a list of snapshots for a certain identifier (usually a commit sha). If there is an existing report for the same sha, it will be overwritten as a result of calling this endpoint, unless you're posting partial reports.

Gets a list of snapshots for a certain identifier (usually a commit sha).

Gets some metadata about a report

When you're uploading partial reports (via the Create Report endpoint), you need to use this endpoint to signal that all the partials have been added and that the report is complete.

Compare reports and get useful information on the possible differences.

Get the comparison status between two reports. This endpoint can be used after the "Compare two reports" endpoint has been used, to check for the current resolution status.

Get all comparison statuses for a sha. The response will contain a list of comparison statuses where the report is either the "before" report or the "after" report.

Tell Happo that you are about to run multiple comparisons between two shas. A special report will be created and a single, combined build status will be posted to github.

Tell Happo that you are about to run a comparison between two shas. A job will either be created (when no orchestration job exists for the same shas) or reused (when an orchestration job exists for the shas).

Tell Happo that a job comparing two shas had to be cancelled for some reason. It might have been cancelled in CI or failed in some other way. When you're using orchestrated jobs, this can help prevent orchestrated jobs getting in an infinite "pending" state.

Deprecated - see "Cancel a job".

Use this endpoint to permanently ignore a diff between two snapshots. The snapshotId1/snapshotId2 params need to correspond to ids from Snapshot objects.

Add subscribers (email addresses) to a specific UI component. When a diff is found in a component, subscribers are notified with a link to the Happo report. Users can themselves unsubscribe manually. If you try adding an email address that has been unsubscribed by the user, it will be ignored and the user will continue to be unsubscribed.

Remove subscribers for a specific UI component.

Get the latest snapshot for a component variant.

Tells Happo to skip running for a certain sha. This is useful if you have Happo configured as a required check for your PRs but want to avoid running Happo tests (e.g. because no UI code changed). Calling this endpoint will post a successful build status to the PR/commit.

Clones a report from one identifier/sha to another. This is useful if you know a commit doesn't introduce any visual changes but you still want it to be associated with a report. An example use-case of this would be if you have some logic to skip a Happo run if a PR has already run Happo on a commit, and a subsequent commit does not touch any UI code. You can then clone the existing report (from the previous commit) to the new commit. After that you can run a comparison with the cloned report set as the "after" report to trigger a Happo build status on the PR.

Cloning a report does not affect your snapshot usage.

Get a sorted list of components and the number of diffs they have for reports created on the main branch. This endpoint can be used to figure out what components contribute the most to flaky/spurious diffs.