Get an analysis

GET

analyses

{analysis-id}

curl \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  -X GET \
  https://api.eyequant.com/v2/analyses/611457618c1d4283a830d10a9ad4f8ae

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "_internal_exposed_id": "0b9c2e7a1f4d4a9e8c2b6d5f3a1e7c90",
  "status": "success",
  "outputs": {
    "attention": {
      "attentionMap": "https://s3.amazonaws.com/api-eyequant/...",
      "perceptionMap": "https://s3.amazonaws.com/api-eyequant/...",
      "hotspotsMap": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "clarity": {
      "score": 71,
      "map": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "excitingness": {
      "score": 64,
      "map": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "input": {
      "image": "https://s3.amazonaws.com/api-eyequant/..."
    }
  }
}

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "pending"
}

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "failed",
  "error": {
    "code": "unreadable_input_image",
    "message": "We were unable to read the input image, either because the format is not supported, or because the image is truncated or corrupted."
  }
}

{
  "error": {
    "code": "resource_gone",
    "message": "This resource is no longer available."
  }
}

Retrieve an analysis by its id. Because analyses are processed asynchronously, poll this endpoint until status is success or failed. Output URLs are time-limited — download and store them promptly. See Result expiry. Which keys appear under outputs depends on the predictions you requested. See the Predictions model.

id vs _internal_exposed_id — id is the screenshot id (the same id returned by Create an analysis and used to request this analysis). _internal_exposed_id is the analysis id, which you need to update metadata or request a summary or recommendations.

string

required

The screenshot id returned by Create an analysis.

string

The screenshot id.

string

The analysis id. Use this when updating analysis metadata or requesting generated summaries and recommendations. Present on success.

string

The current state of the analysis: pending, success, or failed.

object

Present when status is success. The keys depend on the predictions requested.

Show outputs

object

attentionMap, perceptionMap, hotspotsMap, and roiMap (when regions of interest are defined) image URLs.

object

The clarity score (0–100) and map image URL.

object

The excitingness score (0–100) and map image URL.

object

The analyzed input image URL.

object

Present when status is failed. Contains an error code and message.

curl \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  -X GET \
  https://api.eyequant.com/v2/analyses/611457618c1d4283a830d10a9ad4f8ae

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "_internal_exposed_id": "0b9c2e7a1f4d4a9e8c2b6d5f3a1e7c90",
  "status": "success",
  "outputs": {
    "attention": {
      "attentionMap": "https://s3.amazonaws.com/api-eyequant/...",
      "perceptionMap": "https://s3.amazonaws.com/api-eyequant/...",
      "hotspotsMap": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "clarity": {
      "score": 71,
      "map": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "excitingness": {
      "score": 64,
      "map": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "input": {
      "image": "https://s3.amazonaws.com/api-eyequant/..."
    }
  }
}

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "pending"
}

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "failed",
  "error": {
    "code": "unreadable_input_image",
    "message": "We were unable to read the input image, either because the format is not supported, or because the image is truncated or corrupted."
  }
}

{
  "error": {
    "code": "resource_gone",
    "message": "This resource is no longer available."
  }
}

Create an analysis

Create a video analysis

curl \
  -H "Authorization: Bearer $apikey" \
  -H "Content-Type: application/json" \
  -X GET \
  https://api.eyequant.com/v2/analyses/611457618c1d4283a830d10a9ad4f8ae

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "_internal_exposed_id": "0b9c2e7a1f4d4a9e8c2b6d5f3a1e7c90",
  "status": "success",
  "outputs": {
    "attention": {
      "attentionMap": "https://s3.amazonaws.com/api-eyequant/...",
      "perceptionMap": "https://s3.amazonaws.com/api-eyequant/...",
      "hotspotsMap": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "clarity": {
      "score": 71,
      "map": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "excitingness": {
      "score": 64,
      "map": "https://s3.amazonaws.com/api-eyequant/..."
    },
    "input": {
      "image": "https://s3.amazonaws.com/api-eyequant/..."
    }
  }
}

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "pending"
}

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "failed",
  "error": {
    "code": "unreadable_input_image",
    "message": "We were unable to read the input image, either because the format is not supported, or because the image is truncated or corrupted."
  }
}

{
  "error": {
    "code": "resource_gone",
    "message": "This resource is no longer available."
  }
}

General

Analyses

Summaries & Recommendations

Ad Visibility

Tags