Search query event spec

This document describes how to construct a request to activity collector.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
required

Pixel number assigned to a specific website or brand of an online store

string
required

Search query

string

Category of the product

string
enum
Allowed:
string

It is a hashed email address by MD5.

string

Parameter is used to indicate whether the user has given consent to the processing of their personal data in compliance with the General Data Protection Regulation (GDPR) of the European Union

string
number

Parameter passing user's consents. You can use it instead of gdpr and gdpr_consent. Set 0 if the user has given all necessary consents, otherwise set 1 - if the user has not given consent to the processing of their personal data.

string

Do not track. true/false value which means if user allowed page to track his activity. true does not allow tracking. false allows tracking.

string

While not required, it is a good practice to use the "_" parameter as an anti-cache to ensure that users are always viewing the most current version of the webpage without any caching issues. The Unix timestamp, often to the millisecond, is commonly used as the value for this parameter.

string

Anonymous local user ID. Required, if user agent does not accept third party cookies. Once redirected to a website, this value should be read from the dlapi_lu URL parameter (hash or query string).

string

Registered account user ID (if available). Recommended, if user agent does not accept third party cookies. Once redirected to a website, this value should be read from the dlapi_aid URL parameter (hash or query string).

string
enum

Source of the event: s2s - server-to-server communication, app - mobile application, paapi - Protected Audience API (Privacy Sandbox).

Allowed:
Headers
string

URL of the page that requested this event.

string

User agent string.

string

List of IP addresses through which user connects. If the header already exists, the client IP should be appended to the existing value, separated by a comma. If it does not exist, the header should be created with the client IP address.

string

Tracking identifier of an event, used for test purposes

Responses

400

Bad request

Language
URL
LoadingLoading…
Response
Choose an example:
image/gif