Get the on-site search report

GET

/cms/analytics/search

const url = 'https://api.example.com/cms/analytics/search';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.example.com/cms/analytics/search \
  --header 'API-Key: <API-Key>'

Returns on-site search analytics for a date range.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

date_from

string format: date

Start date (YYYY-MM-DD). Defaults to 30 days ago.

date_to

string format: date

End date (YYYY-MM-DD). Defaults to date_from, or yesterday.

Responses

200

On-site search visits data

400

Invalid date range

401

Admin authorization required

403

Insufficient permissions