Retrieve Snapshot details

GET /api/0/organizations/{organization_id_or_slug}/preprodartifacts/snapshots/{snapshot_id}/

Retrieve full details for a snapshot, including categorized image lists and comparison status.

When a comparison exists, images are categorized into changed, added, removed, renamed, unchanged, errored, and skipped lists with counts. Without a comparison, only the images list is populated.

Use compact_metadata=1 to strip image objects down to display_name, image_file_name, group, and description only.

This endpoint requires a bearer token with project:read access.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

snapshot_id (string)
REQUIRED

The ID of the snapshot.

Query Parameters:

compact_metadata (string)

Set to '1' or 'true' to strip image metadata to display_name, image_file_name, group, and description only.

Scopes

<auth_token> requires one of the following scopes:
  • org:ci
  • project:admin
  • project:read
  • project:releases
  • project:write
Copied
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/preprodartifacts/snapshots/{snapshot_id}/ \
 -H 'Authorization: Bearer <auth_token>'
RESPONSESCHEMA
Copied
{
  "head_artifact_id": "100",
  "base_artifact_id": "99",
  "project_id": "1",
  "comparison_type": "diff",
  "state": "UPLOADED",
  "vcs_info": {
    "head_sha": "abc123def456",
    "base_sha": "789xyz000111",
    "provider": "github",
    "head_repo_name": "org/repo",
    "base_repo_name": "org/repo",
    "head_ref": "feature-branch",
    "base_ref": "main",
    "pr_number": 42
  },
  "app_id": "com.example.app",
  "is_selective": false,
  "images": [
    {
      "key": "a1b2c3d4e5f6",
      "display_name": "Home Screen",
      "group": "iPhone 15",
      "image_file_name": "home_screen_iphone15.png",
      "width": 1170,
      "height": 2532
    }
  ],
  "image_count": 1,
  "added": [],
  "added_count": 0,
  "removed": [],
  "removed_count": 0,
  "renamed": [],
  "renamed_count": 0,
  "changed": [
    {
      "base_image": {
        "key": "old_hash_123",
        "display_name": "Home Screen",
        "group": "iPhone 15",
        "image_file_name": "home_screen_iphone15.png",
        "width": 1170,
        "height": 2532
      },
      "head_image": {
        "key": "a1b2c3d4e5f6",
        "display_name": "Home Screen",
        "group": "iPhone 15",
        "image_file_name": "home_screen_iphone15.png",
        "width": 1170,
        "height": 2532
      },
      "diff_image_key": "diff_hash_456",
      "diff": 0.02
    }
  ],
  "changed_count": 1,
  "unchanged": [],
  "unchanged_count": 0,
  "errored": [],
  "errored_count": 0,
  "skipped": [],
  "skipped_count": 0,
  "diff_threshold": 0.01,
  "comparison_state": "success",
  "approval_status": "requires_approval",
  "comparison_error_message": null,
  "approvers": []
}
Was this helpful?