---
title: "Compare two screens"
method: GET
path: "/api/v1/comparisons"
tags: ["comparisons"]
---

# Compare two screens

`GET /api/v1/comparisons`

## Request

- Base URL: `https://screenrove.com`
- URL: `https://screenrove.com/api/v1/comparisons`
- Auth: none declared

Compare two captured screens side by side: layout structure, page sections, observed actions,
dimensions, screen types, and design guide differences. Returns a structured comparison with
similarities, differences, and factual observations.

Use this when the user wants to understand how two products approach the same problem
differently—e.g. comparing Linear's pricing page with Stripe's pricing page, or Vercel's
onboarding with Notion's onboarding.

You can also compare one screen against a target description to see how close a reference
matches what the user is trying to build.

## Query parameters

- `screenA` string, required
- `screenB` string
- `targetDescription` string
- `focus` 'layout' | 'sections' | 'actions' | 'dimensions' | 'typography' | 'all'

## Response `200`

Structured comparison of the two screens.

- Comparison
  - `report` string: Markdown summary of the comparison between the two screens.
  - `screenA` object: Details about the first screen.
    - `id` string
    - `product` string
    - `productName` string
    - `title` string
    - `kind` 'flow' | 'marketing' | 'product': flow is an onboarding step, marketing a public web page, product an in-app screen.
    - `screenType` string
    - `width` integer
    - `height` integer
    - `sectionCount` integer
    - `actionCount` integer
    - `imageUrl` string
    - `previewUrl` string
  - `screenB` object, nullable: Details about the second screen (null if comparing against targetDescription).
    - `id` string
    - `product` string
    - `productName` string
    - `title` string
    - `kind` 'flow' | 'marketing' | 'product': flow is an onboarding step, marketing a public web page, product an in-app screen.
    - `screenType` string
    - `width` integer
    - `height` integer
    - `sectionCount` integer
    - `actionCount` integer
    - `imageUrl` string
    - `previewUrl` string
  - `targetDescription` string: The target description if comparing against text instead of screenB.
  - `similarities` string[]: What the two screens have in common.
  - `differences` string[]: How the two screens differ.
  - `observations` string[]: Design observations and takeaways from the comparison.

## Other responses

- `400`: The request could not be used.
- `404`: No product, screen or reference with that id.

---

[API](https://skmtc.dev/screenrove/apis/screenrove-api.md) · [All operations](https://skmtc.dev/screenrove/apis/screenrove-api/llms.txt) · [OpenAPI document](https://skmtc.dev/screenrove/apis/screenrove-api/revisions/9383a872c966?raw)