AEO Projects

Activate AEO for a site

Creates the site's AEO project and starts activation. Activation runs in the background and takes several minutes, so the call returns 202 Accepted with an empty body. Poll Get AEO project status until status is ACTIVATION_COMPLETED.

  • country_code is required and sets the project's primary market.
  • The site's own brand is named from brand_name, or from the site's domain when it is omitted.
  • brands adds up to 5 competitor brands, and cities up to 5 target cities.
  • New projects track ChatGPT and Gemini. Change this with Update AI models.

The site counts toward the plan's site allowance. On custom (contract) plans, it reserves one full scan per billing cycle from the plan's run pool instead.

If the site already has a project, the call returns 202 again and ignores the request body.

post/api/sites/multiscreen/{site_name}/aeo

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/aeo
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

Request body

brand_namestring

Name of the site's own brand. Defaults to a name derived from the site's domain.

citiesstring[]

Up to 5 cities to target for local visibility.

country_codestring required

The project's primary market, as an ISO 3166-1 alpha-2 country code. Case-insensitive.

Example request

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

Response

Accepted

Changes

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