Search: eventSearch

This API captures search-related events on the website, tracking the search terms entered by users and the results returned. It provides businesses with insights into customer search behavior, helping them optimize their search functionality.

API Endpoint and Method

URL

Copy

https://rcdp-us-east-1.algonomy.com/callback/rest/events/{APP_API_KEY}/eventSearch

Example URL

Copy

https://rcdp-us-east-1.algonomy.com/callback/rest/events/BESQILOBZCGHVLZTCNTGJMYGQEARWVZVCUPYVUGNCZPJRSUDAR/eventSearch

HTTP Method

POST

Parameters

Parameter	Type	Required or Optional	Description
searchFacet	String	Optional	Specifies the search location. Example: "Category"
searchString	String	Required	Specifies the search string entered by the user. Example: "Canned Juices"
searchResults	Integer	Optional	Specifies the number of search results returned. Example: 30
searchResponseTime	Integer	Optional	Specifies the search response time in milliseconds. Example: 2000

Request Body Schema

Copy

1
2
3
4
5
6
7
8
9
{
  "eventData": {
    "searchFacet": "String",
    "searchString": "String",
    "searchResults": "integer",
    "searchResponseTime": "integer"
  }
}

Example Request

Copy

1
2
3
4
5
6
7
8
9
{
  "eventData": {
    "searchFacet": "Category",
    "searchString": "Canned Juices",
    "searchResults": 30,
    "searchResponseTime": 2000
  }
}

Example Response

Copy

1
2
3
4
5
{
  "message": "Search event captured successfully",
  "statusCode": 200
}

HTTP Response Codes

Response Code	Description
202 Accepted	The request has been received and validated, but processing is asynchronous and not yet complete.