Get recommendations

GET

analyses

recommendations

{analysis-id}

curl \
  -H "Authorization: Bearer $apikey" \
  -X GET \
  https://api.eyequant.com/v2/analyses/recommendations/$analysisId

const baseUrl = 'https://api.eyequant.com/v2';

const response = await fetch(`${baseUrl}/analyses/recommendations/${analysisId}`, {
  headers: { Authorization: `Bearer ${apiKey}` },
});

const recommendations = await response.json();

if (recommendations.status === 'completed') {
  renderMarkdown(recommendations.data);
}

{
  "success": true,
  "status": "completed",
  "data": "## Recommendations\n\n1. Increase contrast on the primary call to action..."
}

{
  "success": true,
  "status": "processing",
  "msg": "Recommendation generation in progress"
}

Retrieve generated recommendations, or the current generation status. When status is completed, the data field holds the recommendations as a Markdown string. Tasks older than one hour return 410 Gone.

The analysis-id path parameter is the analysis id returned as _internal_exposed_id from Get an analysis.

string

required

The analysis id (_internal_exposed_id from Get an analysis).

boolean

Whether the request succeeded.

string

One of started, processing, completed, failed, or expired.

string

The recommendations content as a Markdown string. Present only when status is completed.

string

Human-readable status message. Present when status is not completed.

curl \
  -H "Authorization: Bearer $apikey" \
  -X GET \
  https://api.eyequant.com/v2/analyses/recommendations/$analysisId

const baseUrl = 'https://api.eyequant.com/v2';

const response = await fetch(`${baseUrl}/analyses/recommendations/${analysisId}`, {
  headers: { Authorization: `Bearer ${apiKey}` },
});

const recommendations = await response.json();

if (recommendations.status === 'completed') {
  renderMarkdown(recommendations.data);
}

{
  "success": true,
  "status": "completed",
  "data": "## Recommendations\n\n1. Increase contrast on the primary call to action..."
}

{
  "success": true,
  "status": "processing",
  "msg": "Recommendation generation in progress"
}

Generate recommendations

Create an ad visibility analysis

curl \
  -H "Authorization: Bearer $apikey" \
  -X GET \
  https://api.eyequant.com/v2/analyses/recommendations/$analysisId

const baseUrl = 'https://api.eyequant.com/v2';

const response = await fetch(`${baseUrl}/analyses/recommendations/${analysisId}`, {
  headers: { Authorization: `Bearer ${apiKey}` },
});

const recommendations = await response.json();

if (recommendations.status === 'completed') {
  renderMarkdown(recommendations.data);
}

{
  "success": true,
  "status": "completed",
  "data": "## Recommendations\n\n1. Increase contrast on the primary call to action..."
}

{
  "success": true,
  "status": "processing",
  "msg": "Recommendation generation in progress"
}

General

Analyses

Summaries & Recommendations

Ad Visibility

Tags

Get recommendations