Google AI Overview Scraper
scraper.overview captures comprehensive Google AI Overview responses, including enriched product data, citations, advertisements, and web sources to help you analyze search results across different regions.
Request Example
curl '{api_host}/api/v2/scraper/execute' \
--header 'Content-Type: application/json' \
--header 'x-api-token: {you_api_key}' \
--data '{
"actor": "scraper.overview",
"input": {
"prompt": "Recommended attractions in New York",
"country": "US"
},
"webhook": {
"url": "http://www.youwebhook.com"
}
}'Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
prompt | string | Yes | Prompt sent to Google AI Overview. |
country | string | Yes | Country or region. |
Response Fields
Data field Source: products inside ai overview
| type | product_position | description |
|---|---|---|
| product | recommended | recommended products |
| product | inline_link | inline link products |
| product | reference | reference products |
| ads product | null | ads products |
Data field Products: Google wale sponsored products
Data field Ads: Google Ads(Serp)
| Parameter | Type | Required | Description |
|---|---|---|---|
content | string | Yes | Answer body in Markdown format. |
rawtext | string | Yes | Original answer data. |
metadata | object | Yes | Metadata information. |
metadata.rawUrl | string | Yes | Webpage URL. |
is_overview_shopping | boolean | Yes | Whether there is embedded shopping data. |
products | array | No | Product data. |
products.delivery | string | No | Delivery service. |
products.discount | string | No | Discount information. |
products.img | string | No | Product image URL. |
products.orig_price | string | No | Original price. |
products.rating | string | No | Rating. |
products.review_count | string | No | Number of reviews. |
products.seller | string | No | Seller. |
products.url | string | No | Product detail page URL. |
products.stores | array | No | Store information. |
products.stores.delivery_fee | string | No | Delivery fee. |
products.stores.extensions | array | No | Additional services. |
products.stores.link | string | No | Product redirect link. |
products.stores.name | string | No | Store name. |
products.stores.price | string | No | Sale price. |
products.ratings | string | No | Ratings. |
products.tag | string | No | Tags. |
products.title | string | No | Product title. |
products.total_price | string | No | Total price. |
source | array | No | Citation sources. |
source.favicon | string | No | Website favicon. |
source.snippet | string | No | Citation article snippet. |
source.thumbnail | string | No | Citation article cover image. |
source.title | string | No | Citation title. |
source.type | string | No | Source Type. |
source.url | string | No | Citation original URL. |
source.website_name | string | No | Website name. |
source.html_index | int | No | Indicates the position of the recommended product shopping card in the Markdown content. |
source.stores | array | No | Store information. |
source.stores.delivery_fee | string | No | Delivery fee. |
source.stores.extensions | array | No | Additional services. |
source.stores.link | string | No | Product redirect link. |
source.stores.name | string | No | Store name. |
source.stores.price | string | No | Sale price. |
web_source | array | No | Web search sources. |
web_source.favicon | string | No | Website favicon. |
web_source.snippet | string | No | Citation article snippet. |
web_source.thumbnail | string | No | Citation article cover image. |
web_source.title | string | No | Citation title. |
web_source.url | string | No | Citation original URL. |
web_source.website_name | string | No | Website name. |
web_source.stores | array | No | Store information. |
web_source.stores.delivery_fee | string | No | Delivery fee. |
web_source.stores.extensions | array | No | Additional services. |
web_source.stores.link | string | No | Product redirect link. |
web_source.stores.name | string | No | Store name. |
web_source.stores.price | string | No | Sale price. |
ads | array | No | Advertisements. |
ads.section_title | string | No | Section title. |
ads.type | string | No | Type. |
ads.title | string | No | Title. |
ads.url | string | No | Webpage URL. |
ads.google_ad_url | string | No | Advertisement link. |
ads.display_url | string | No | Display URL. |
ads.advertiser | string | No | Advertiser. |
ads.description | string | No | Description. |
ads.tracking_token | string | No | Tracking token. |
ads.slot | string | No | Ad slot number. |
ads.price | string | No | Price. |
ads.orig_price | string | No | Original price. |
ads.seller | string | No | Seller. |
ads.rating | string | No | Rating. |
ads.review_count | string | No | Number of reviews. |
ads.img | string | No | Product image URL. |
ads.site_links | array | No | Website links. |
ads.site_links.title | string | No | Title. |
ads.site_links.url | string | No | Webpage URL. |
ads.site_links.google_ad_url | string | No | Advertisement link. |