post

/reporting/searches/_getNull

Get searches that resulted in zero results being displayed to the shopper in the window specified. Only final results returned will count toward this endpoint, which means using a sequence fallback will make this endpoint less informative.

This endpoint can take a long time to run so if your request times out the first time, try waiting a few minutes before trying the same query.

Note: If you don’t see any results, check if you are sending the events. To record null search events, there needs to be a gbTracker.sendAutoSearchEvent(event) beacon that fires on null search results. This includes any custom null search results pages you may have so it’s important to remember they need the beacon too.

Authorization

apiKey - Authorization

Request Body

1 Example

Schema

object

window

string

Possible values: day, week, month

1 validation

includeNavigationNulls

boolean

Set this to true if you want to include null searches that have any filters applied. This may be necessary for cases were every search has a hidden refinement, such as a store ID or shipping pool.

If your search events always send any kind of refinement - for example, you always refine to a certain subset of products by store or stock, you’ll need to include includeNavigationNulls and set it to true:

curl -X POST 'https://test.groupbycloud.com/wisdom/v2/reporting/searches/_getNull' \
   -H 'Authorization: b53df55c-e017-48c0-881f-cbfa6ed7b932' \
   -d '{ "includeNavigationNulls": true, "window": "week" }'

1 validation

Responses

1 Example

Schema

object

status

object

result

array[object]

serverTimestamp

string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

2 variables not set

customerid

Authorization