Get an AEO report
Returns a one-time AEO report over the requested period: brand visibility, tracked prompt performance, a sample of answers and, optionally, recommendations.
- visibility.brands holds the report's 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. If the report has no competitor with a domain, on_site_recommendations is empty.
models isn't checked against the report's tracked models; a model the report doesn't track returns no data.
Request
- Base URLhttps://api.duda.co
- URLhttps://api.duda.co/api/aeo/reports/{report_id}
- AuthHTTP basic
Path parameters
ID of the report, from Create an AEO report or List AEO reports.
Query parameters
First day of the period, inclusive, as an ISO 8601 date (YYYY-MM-DD, UTC). The period can span at most 366 days.
Last day of the period, inclusive, as an ISO 8601 date (YYYY-MM-DD, UTC). Must not be before from.
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.
Number of top tracked prompts to sample answers from. The newest answer per prompt per selected model is returned.
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.
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.
Whether to fill in on_site_recommendations and off_site_recommendations. When false, both are null.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.