Get site AEO report

get

https://api.duda.co/api/sites/multiscreen/{site_name}/aeo/report

Returns a combined AEO report for the site over the requested period: brand visibility, tracked prompt performance, a sample of answers and, optionally, recommendations. The parameters and response match Get AEO report, applied to the site's own project. Reading it uses no report allowance.

visibility.brands holds the own brand plus up to brands competitors.
answers holds the newest answer for each of the top chats tracked prompts, per selected model.
With include_recommendations=true, on_site_recommendations and off_site_recommendations are filled in. Otherwise they are null.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_name

string

required

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

Query Params

from

date

required

First day of the period, inclusive, as an ISO 8601 date (YYYY-MM-DD, UTC). The period can span at most 366 days.

date

required

Last day of the period, inclusive, as an ISO 8601 date (YYYY-MM-DD, UTC). Must not be before from.

brands

int32

0 to 9

Defaults to 4

Number of competitor brands to include in visibility.brands, besides the own brand, which is always included. Competitors are picked by visibility, highest first. 0 returns only the own brand.

chats

int32

0 to 10

Defaults to 2

Number of top tracked prompts to sample answers from. The newest answer per prompt per selected model is returned.

models

array of strings

Only include these AI models in the statistics and sampled answers. Send a comma-separated list or repeat the parameter, up to 10 values. Case-insensitive. Unknown values return 400. Omit to include every model.

models

Allowed:

geos

array of strings

Only include prompts in these countries, as ISO 3166-1 alpha-2 codes (e.g. US). Send a comma-separated list or repeat the parameter. Case-insensitive. Unsupported codes return 400. Omit to include every country.

geos

include_recommendations

boolean

Defaults to false

Whether to fill in on_site_recommendations and off_site_recommendations. When false, both are null.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad request. error_code is InvalidInput and errors is empty. A parameter is missing, invalid or out of range.

401Unauthorized. The credentials are missing or invalid.

404Not found. error_code is ResourceNotExist, and errors[0].code names the cause: AeoProjectNotFound: the site has no AEO project.

422Unprocessable entity. error_code is InvalidState, and errors[0].code names the cause: AeoCompetitorDomainRequired: include_recommendations=true and no competitor brand has a domain. Add one with Add a competitor brand.

429Too many requests. The rate limit was exceeded.