Skip to main content
When you submit a URL to EyeQuant, the API automatically takes a screenshot of the page — simulating either a desktop or mobile browser — and runs its machine perception models against the resulting image. This means you can analyze any live web page with a single API call, without needing to capture or upload a screenshot yourself.
1

POST to /v2/analyses

Send a POST request to /v2/analyses with an input type of webPageUrl. Set content to the page you want to analyze, and set medium to either desktopWeb or mobileWeb to control which browser viewport EyeQuant simulates. Replace $apikey with your API credentials.
curl \
  -X POST \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  -d '{
        "input": {
          "type": "webPageUrl",
          "content": "http://www.google.com",
          "medium": "desktopWeb",
          "title": "Example"
        }
      }' \
  https://api.eyequant.com/v2/analyses
A successful request returns HTTP 201 Created along with the ID and location of the new analysis resource:
{
  "location": "https://api.eyequant.com/v2/analyses/611457618c1d4283a830d10a9ad4f8ae",
  "id": "611457618c1d4283a830d10a9ad4f8ae"
}
Save the location URL — you’ll use it to check on progress in the next step.
2

Poll for completion

Taking a screenshot and running the analysis both take a few seconds to complete. Send a GET request to the location URL to check the current status.
curl \
  -X GET \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  https://api.eyequant.com/v2/analyses/611457618c1d4283a830d10a9ad4f8ae
While processing is still underway, the response will show a pending status:
{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "pending"
}
Once the analysis finishes successfully, the status changes to success and the response includes your output URLs:
{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "success",
  "outputs": {
    "attention": {
      "attentionMap": "https://s3.amazonaws.com/api-eyequant/attentionHeatmap.png"
    }
  }
}
Keep polling until the status is no longer pending.
3

Access your outputs

Once the status is success, the outputs.attention.attentionMap field contains a URL pointing directly to your generated attention heatmap image. Download or display that image to see where viewers’ eyes are predicted to be drawn on the page.

​
Additional options

Removing cookie banners: Pass "removeCookieBanner": true in the input object to instruct EyeQuant to strip cookie consent banners from the screenshot before running analysis. This is useful when banners would otherwise dominate the predicted attention. Supported media types: Only desktopWeb and mobileWeb are valid values for medium when using a webPageUrl input. The generic media type is only available for image uploads.
The URL you submit must be publicly accessible on the internet. EyeQuant’s servers cannot reach private networks, localhost addresses, or pages that require authentication. If your URL is not reachable, the analysis will fail.
For the full list of accepted parameters — including optional fields for controlling viewport size and more — see the Input Model reference.