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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
string

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

brands
array of objects
length ≤ 5

Up to 5 competitor brands to track from the start. Don't include the site's own brand.

brands
cities
array of strings
length ≤ 5

Up to 5 cities to target for local visibility.

cities
string
required

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

Responses
202

Accepted

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json