AEO Reports

Create an AEO report

Creates a one-time AEO report for any domain, and returns its ID. Data collection runs in the background and takes several minutes. Read the report with Get AEO report; there is no separate status field.

  • domain is required.
  • country_code defaults to the account's country. A report covers one country.
  • brand_name defaults to a name derived from domain.
  • brands adds up to 5 competitor brands, and cities up to 5 target cities.
  • ai_models defaults to the plan's report models (ChatGPT and Gemini if the plan sets none). Duplicates are ignored.

The plan decides how many suggested prompts the report tracks. Each report uses one report from the plan's monthly allowance. On custom (contract) plans, it reserves one full scan from the plan's run pool instead.

post/api/aeo/reports

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/aeo/reports
  • Auth
    HTTP basic

Request body

ai_modelsApiAeoModel[]

AI models to track. Defaults to the plan's report models. Must not be empty when sent; duplicates are ignored.

brand_namestring

Name of the brand to report on. Defaults to a name derived from domain.

citiesstring[]

Up to 5 cities to target for local visibility.

country_codestring

Country to report on, as an ISO 3166-1 alpha-2 code. Case-insensitive. Defaults to the account's country.

domainstring required

Domain of the brand to report on. A leading http:// or https:// and a trailing / are ignored.

Example request

{
  "brand_name": "My Brand",
  "brands": [
    {
      "domains": [
        "acme.com"
      ],
      "name": "Acme"
    }
  ],
  "cities": [
    "Austin"
  ],
  "country_code": "US",
  "domain": "mybrand.com"
}

Response

Created

idstring

ID of the created resource.

Changes

No recorded changes to this operation across all 1 revision of this API.