API Reference

Get Opportunities

Get prioritized opportunities and criterion-level fix items for a domain, sorted by potential score gain.

GET/api/v1/audits/[slug]/opportunities

Returns strategic deliverables (opportunities) and criterion-level fix suggestions sorted by potential score impact. No full prompt text - use the Get Audit endpoint with include=fix_prompts for detailed remediation prompts.

Path Parameters

Name	Type	Required	Description
`slug`	string	Required	Domain slug (e.g., "notion-com")

Example

bash

curl "https:">//www.aeocontent.ai/api/v1/audits/notion-com/opportunities" \
  -H "Authorization: Bearer $AEO_API_KEY"

Try it

Response

200Opportunities data

json

{
  class="code-string">"data": {
    class="code-string">"slug": class="code-string">"notion-com",
    class="code-string">"domain": class="code-string">"notion.com",
    class="code-string">"overall_score": 62,
    class="code-string">"verdict": class="code-string">"Moderate AEO readiness with notable gaps in structured data.",
    class="code-string">"opportunities": [
      {
        class="code-string">"id": 1,
        class="code-string">"name": class="code-string">"Add llms.txt",
        class="code-string">"description": class="code-string">"Create an llms.txt file at your domain root...",
        class="code-string">"effort": class="code-string">"low",
        class="code-string">"impact": class="code-string">"HIGH"
      }
    ],
    class="code-string">"fix_summary": {
      class="code-string">"criteria_to_fix": 8,
      class="code-string">"total_potential_gain": 23,
      class="code-string">"top_3_fixes": [
        class="code-string">"llms.txt (+10pts)",
        class="code-string">"Schema.org Markup (+8pts)",
        class="code-string">"FAQ Section (+5pts)"
      ]
    },
    class="code-string">"fix_items": [
      {
        class="code-string">"criterion_id": 1,
        class="code-string">"criterion_name": class="code-string">"llms.txt",
        class="code-string">"category": class="code-string">"Discovery",
        class="code-string">"current_score": 0,
        class="code-string">"potential_gain": 10
      }
    ]
  },
  class="code-string">"meta": { class="code-string">"request_id": class="code-string">"...", class="code-string">"timestamp": class="code-string">"..." }
}

404Not found

json

{
  class="code-string">"error": {
    class="code-string">"code": class="code-string">"not_found",
    class="code-string">"message": class="code-string">"No audit found for slug 'unknown-com'."
  }
}

Fix items are sorted by potential_gain (descending). Focus on the top 3 for the biggest score improvement.

Name

Type

Required

Description

slug

string

Required

Domain slug (e.g., "notion-com")

Example

bash

curl "https:">//www.aeocontent.ai/api/v1/audits/notion-com/opportunities" \
  -H "Authorization: Bearer $AEO_API_KEY"

Response

200Opportunities data

json

{
  class="code-string">"data": {
    class="code-string">"slug": class="code-string">"notion-com",
    class="code-string">"domain": class="code-string">"notion.com",
    class="code-string">"overall_score": 62,
    class="code-string">"verdict": class="code-string">"Moderate AEO readiness with notable gaps in structured data.",
    class="code-string">"opportunities": [
      {
        class="code-string">"id": 1,
        class="code-string">"name": class="code-string">"Add llms.txt",
        class="code-string">"description": class="code-string">"Create an llms.txt file at your domain root...",
        class="code-string">"effort": class="code-string">"low",
        class="code-string">"impact": class="code-string">"HIGH"
      }
    ],
    class="code-string">"fix_summary": {
      class="code-string">"criteria_to_fix": 8,
      class="code-string">"total_potential_gain": 23,
      class="code-string">"top_3_fixes": [
        class="code-string">"llms.txt (+10pts)",
        class="code-string">"Schema.org Markup (+8pts)",
        class="code-string">"FAQ Section (+5pts)"
      ]
    },
    class="code-string">"fix_items": [
      {
        class="code-string">"criterion_id": 1,
        class="code-string">"criterion_name": class="code-string">"llms.txt",
        class="code-string">"category": class="code-string">"Discovery",
        class="code-string">"current_score": 0,
        class="code-string">"potential_gain": 10
      }
    ]
  },
  class="code-string">"meta": { class="code-string">"request_id": class="code-string">"...", class="code-string">"timestamp": class="code-string">"..." }
}

404Not found

json

{
  class="code-string">"error": {
    class="code-string">"code": class="code-string">"not_found",
    class="code-string">"message": class="code-string">"No audit found for slug 'unknown-com'."
  }
}