POST /api/google/trends/regions
Price: 5 credits
Google Trends interest by region for up to 5 search terms or topics: one row per term and country, region, US metro area or city with its relative search interest (0-100). With several terms each row holds the term's share of the region's interest and marks the leading term.
Where a term is searched most, from Google Trends. Leave resolution empty for the default level: countries for worldwide, regions inside a country.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)keywords array required — Search terms or Google Knowledge Graph topic ids to compare (examples: ["bitcoin","ethereum"], ["/m/05p0rrx"]; minItems: 1; maxItems: 5)geo string — Country or subregion code; empty for worldwide (default: ""; examples: "US", "US-CA", "DE"; pattern: ^$|^[A-Za-z]{2}(-[A-Za-z0-9]{1,3})?$)time_range string — Preset time range; ignored when date_from and date_to are set (default: "past_12_months"; one of: "past_hour", "past_4_hours", "past_day", "past_7_days", "past_30_days", "past_90_days", "past_12_months", "past_5_years", "since_2004")date_from integer nullable — Start of a custom time range, unix seconds; a start more than 7 days ago is read at day granularity (examples: 1704067200; min: 1072915200)date_to integer nullable — End of a custom time range, unix seconds; a range starting more than 7 days ago is read at day granularity (examples: 1711843200; min: 1072915200)category integer — Google Trends category id, 0 for all categories (default: 0; examples: 0, 7, 20; min: 0)search_property string — Google search property the interest is measured on (default: "web"; one of: "web", "images", "news", "shopping", "youtube")resolution string nullable — Geographic level of the breakdown; country for worldwide, region inside a country, metro for US metro areas, city (one of: "country", "region", "metro", "city")count integer required — Max number of results (min: 1)@type string (default: "GoogleTrendsRegionInterest")keyword string requiredgeo_code string nullablegeo_name string requiredlatitude number nullablelongitude number nullablevalue integer nullablehas_data boolean nullableis_leading boolean required422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.X-Retry-After — Seconds to wait before retrying. Present only on 429.