Schemas

Autocomplete suggestions from a platform's search box for a partial query: completed searches, accounts, hashtags and websites, in its order.

Endpoints

3 endpoints return suggestions on Google Ads Transparency Center, Instagram and TikTok.

Schema

Every endpoint above returns an array of these objects as data, with a page object. The standard meta comes with every response.

platformstring

Platform whose search box offers the suggestion.

textstring

The suggestion as the platform shows it, whitespace-trimmed: the completed search for a query suggestion, the account's name for a profile one, the domain for a website one.

typestring

query = a completed search to run; profile = an account (or community) the platform proposes, described in profile; hashtag = a hashtag, described in hashtag; website = a website the platform proposes: text is its domain (nike.com), as the platform's searches by website take it. New values may be added.

One ofqueryprofilehashtagwebsite

positioninteger

Zero-based rank of the suggestion in the list, counting every type: the platform's order (each endpoint's notes say how a list combining several of the platform's searches is ordered).

urlstring uri

Where the suggestion leads on the platform: the search results page for a query, the account's page for a profile, the hashtag's page for a hashtag, the platform's page for the website for a website.

profileobjectnullable

The account a profile suggestion names; null for every other type.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

hashtagobjectnullable

The hashtag a hashtag suggestion names, keyed as the platform's hashtag endpoints key it; null for every other type.

ShowHide 4 child fields
idstring

The hashtag's ID as the platform's hashtag endpoints key it: its native ID, or the name lowercased where the platform's pages key a hashtag by name (Instagram).

namestring

The tag without #, as the platform shows it (case kept).

urlstring uri

Canonical hashtag page URL.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 1 child field
post_countintegernullable

Posts carrying the tag, as the platform counts them; rounded on YouTube and Threads (see approximate_fields).

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 3 child fields
tiktokobjectnullable

A TikTok suggestion's own fields.

ShowHide 2 child fields
languagestringnullable

The suggestion's language as TikTok labels it, an ISO 639-1 code (en, es); null when TikTok does not say.

scorenumbernullable

TikTok's predicted click-through rate for the suggestion, 0 to 1: a relative signal among one query's suggestions; null when not given.

instagramobjectnullable

An Instagram suggestion's own fields.

ShowHide 1 child field
tag_idstringnullable

Instagram's own numeric ID of a hashtag suggestion's tag; null for every other type.

googleobjectnullable

A Google Ads Transparency Center suggestion's own fields.

ShowHide 2 child fields
country_codestringnullable

The country an advertiser suggestion's advertiser is based in, an ISO 3166-1 alpha-2 code; null for a website suggestion, or when not shown.

adsobjectnullable

The ads the center shows for an advertiser suggestion's advertiser, as Google's range (equal bounds when exact), in the region the request names where it takes one; null for a website suggestion, or when not shown.

ShowHide 2 child fields
lower_boundinteger

Inclusive lower bound.

upper_boundintegernullable

Inclusive upper bound; null when open-ended (e.g. ">1M"). Equal to lower_bound when exact.

approximate_fieldsstring[]

JSON paths of values rounded or capped by the platform (hashtag.metrics.post_count at Instagram's ceiling). [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none; [] when every list is known (a suggestion has none yet).

Last updated