Get an ad visibility analysis

GET

ad-visibility

{id}

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

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

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "success",
  "outputs": {
    "score": 78,
    "input": "https://s3.amazonaws.com/api-eyequant/..."
  }
}

{
  "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."
  }
}

Retrieve an ad visibility analysis by its id. Poll until status is success or failed. On success, outputs contains the visibility score and a link to the input ad image. Analyses become unavailable one hour after completion, returning 410 Gone (see Result expiry).

string

required

The request ID returned when the ad visibility job was created.

string

The analysis identifier.

string

The current state: pending, success, or failed.

object

Present when status is success. Contains the ad visibility score and the 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/ad-visibility/611457618c1d4283a830d10a9ad4f8ae

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

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "success",
  "outputs": {
    "score": 78,
    "input": "https://s3.amazonaws.com/api-eyequant/..."
  }
}

{
  "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."
  }
}

Create an ad visibility analysis

Get tag summary

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

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

{
  "id": "611457618c1d4283a830d10a9ad4f8ae",
  "status": "success",
  "outputs": {
    "score": 78,
    "input": "https://s3.amazonaws.com/api-eyequant/..."
  }
}

{
  "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."
  }
}

General

Analyses

Summaries & Recommendations

Ad Visibility

Tags

Get an ad visibility analysis