Site.search
The search query that brought the user to the current page, when the seller knows it.
Field facts
- Path
site.search- Object
- Site
- Type
- string
- Requirement
- Optional
- Added
- OpenRTB 2.0
- Spec section
- 3.2.13
How it is used
Rarely populated today, since most search engines no longer pass query terms to the sites they send traffic to. When present it is a strong contextual signal, and it can contain personal data, so sellers should filter it.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"site": {
"search": "city council transit vote"
}
}Version history
Added in OpenRTB 2.0, and present in the latest snapshot. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.0 | string | No | No |
| 2.1 | string cu | No | No |
| 2.2 | string | No | No |
| 2.3 to 2.3.1 | string | No | No |
| 2.4 | string | No | No |
| 2.5 to 2.6-202606 | string | No | No |