Retrieve information about zero-result searches

GET 
/metrics/zero-result-searches

Retrieve information about zero-result searches

Request

Query Parameters

from date

The date to search from (inclusive)

to date

The date to search up to (inclusive)

Header Parameters

X-SaleCycle-Id stringrequired

Your SaleCycle API Subscription key

Responses

200

Successful operation

application/json

Schema

Schema

data object[]required
Array [
searchTerm string
zeroHitCount integer
]
meta object
timeRange object
from date-time
to date-time

Example (from schema)

{
  "data": [
    {
      "searchTerm": "Fabricated Jelly",
      "zeroHitCount": 1
    }
  ],
  "meta": {
    "timeRange": {
      "from": "2024-07-29T15:51:28.071Z",
      "to": "2024-07-29T15:51:28.071Z"
    }
  }
}

400

Validation Error

application/json

Schema

Schema

errors object[]required
Array [
status stringrequired
title stringrequired
detail stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

Loading...