fix(headless): missing actionCause analytics #5408
Conversation
Adds the missing `actionCause` property to the analytics section sent when calling the /generate endpoint. SVCC-5132
gleblanc-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
gleblanc-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
Pull Request ReportPR Title✅ Title follows the conventional commit spec. Live demo linksBundle Size
|
| navigatorContext, | ||
| { | ||
| actionCause: SearchPageEvents.searchboxSubmit, | ||
| } |
There was a problem hiding this comment.
So we are saying that 100% of the time we send a call to the /generate endpoint, the action cause is going to be searchbox submit. Out of curiosity, isn't the actionCause also in the state? I suppose it gets retrieved from the state when a search call is being made.
I'm asking because it might be a blind spot for us in the way we look at the data. For example, if we analyse the analytics of the /generate endpoint and see x% have no query text, we might not be able to link it to the fact that they come from a filter selection or something.
There was a problem hiding this comment.
I wasn't able to find the actionCause or eventDescription in the state, let me know if it's there.
My first thought was to use the action cause from the state but I wasn't able to find it here or higher up in the call chain.
I had a brief chat with @dmgauthier who was in the office and I proposed to him that we go this way for now, but it's really flaky but if we can have it the other way if would be much better.
There was a problem hiding this comment.
I've had confirmation that the event cause can change so this needs to be fixed.
gleblanc-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
gleblanc-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
|
Closing this for now. |
gleblanc-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
Adds the missing
actionCauseproperty to the analytics section sent when calling the /generate endpoint.SVCC-5132
Following a bug report where the
actionCauseis missing from calls.Note that right now, since this is only used when calling the /generate endpoint which is triggered by submitting to the search box, that's the event we're sending.
In the rest of the solution, it's either using specific events like this from
SearchPageEventsor taking the event description from an event description object. We don't have the event description easily accessible right now, but if in the future we also use this endpoint for other event types, we'll have to take this into account.