Keyword Search

Reports that a user ran a freestyle keyword search.


  • name: Human-readable name, not used to identify an event type
  • properties: A container for the event properties as specified in the following table:
dyTypeMust be "keyword-search-v1"String
keywordsThe search stringString

Example: Implementation via script

DY.API("event", {
  name: "Keyword Search",
  properties: {
    dyType: "keyword-search-v1",
    keywords: "contact info"

Example: Implementation via Experience API (server-side)

  "name": "Keyword Search",           
  "properties": {
    "dyType": "keyword-search-v1",
    keywords: "black umbrella"


Go to the API reference for the Events endpoint to learn more.