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",
"shopping": true
},
"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. |
shopping | boolean | No | Whether to fetch shopping data. Defaults to true. When enabled, returns product information in the products field. |
Response Fields
Note: If the response includes shopping data (the
productsfield), the API call will be charged at 2x the base rate. This is due to the additional resource overhead required for extracting and processing product information from multiple sources.💡 When the overview mode is not triggered, both
contentandrawtextfields will be empty strings.💡 To trigger the overview mode, you can try adjusting your prompt or ensuring that the keywords in your prompt are covered by Google Overview.
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 | Description |
|---|---|---|
content | string | Answer body in Markdown format. Only populated when overview mode is triggered; otherwise, it will be an empty string. |
rawtext | string | Original answer data. Only populated when overview mode is triggered; otherwise, it will be an empty string. |
metadata | object | Metadata information. |
metadata.rawUrl | string | Webpage URL. |
is_overview_shopping | boolean | Whether there is embedded shopping data. |
products | array | Product data. |
products.delivery | string | Delivery service. |
products.discount | string | Discount information. |
products.img | string | Product image URL. |
products.orig_price | string | Original price. |
products.rating | string | Rating. |
products.review_count | string | Number of reviews. |
products.seller | string | Seller. |
products.url | string | Product detail page URL. |
products.stores | array | Store information. |
products.stores.delivery_fee | string | Delivery fee. |
products.stores.extensions | array | Additional services. |
products.stores.link | string | Product redirect link. |
products.stores.name | string | Store name. |
products.stores.price | string | Sale price. |
products.ratings | string | Ratings. |
products.tag | string | Tags. |
products.title | string | Product title. |
products.total_price | string | Total price. |
source | array | Citation sources. |
source.favicon | string | Website favicon. |
source.snippet | string | Citation article snippet. |
source.thumbnail | string | Citation article cover image. |
source.title | string | Citation title. |
source.type | string | Source Type. |
source.url | string | Citation original URL. |
source.website_name | string | Website name. |
source.html_index | int | Indicates the position of the recommended product shopping card in the Markdown content. |
source.stores | array | Store information. |
source.stores.delivery_fee | string | Delivery fee. |
source.stores.extensions | array | Additional services. |
source.stores.link | string | Product redirect link. |
source.stores.name | string | Store name. |
source.stores.price | string | Sale price. |
web_source | array | Web search sources. |
web_source.favicon | string | Website favicon. |
web_source.snippet | string | Citation article snippet. |
web_source.thumbnail | string | Citation article cover image. |
web_source.title | string | Citation title. |
web_source.url | string | Citation original URL. |
web_source.website_name | string | Website name. |
web_source.stores | array | Store information. |
web_source.stores.delivery_fee | string | Delivery fee. |
web_source.stores.extensions | array | Additional services. |
web_source.stores.link | string | Product redirect link. |
web_source.stores.name | string | Store name. |
web_source.stores.price | string | Sale price. |
ads | array | Advertisements. |
ads.section_title | string | Section title. |
ads.type | string | Type. |
ads.title | string | Title. |
ads.url | string | Webpage URL. |
ads.google_ad_url | string | Advertisement link. |
ads.display_url | string | Display URL. |
ads.advertiser | string | Advertiser. |
ads.description | string | Description. |
ads.tracking_token | string | Tracking token. |
ads.slot | string | Ad slot number. |
ads.price | string | Price. |
ads.orig_price | string | Original price. |
ads.seller | string | Seller. |
ads.rating | string | Rating. |
ads.review_count | string | Number of reviews. |
ads.img | string | Product image URL. |
ads.site_links | array | Website links. |
ads.site_links.title | string | Title. |
ads.site_links.url | string | Webpage URL. |
ads.site_links.google_ad_url | string | Advertisement link. |