Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix perso event names #2554

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Fix perso event names #2554

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71c6d20
triggername → triggerName
adriendupuis Nov 28, 2024
3389367
Remove unneeded space from end of line
adriendupuis Nov 28, 2024
e087fc5
Fix recommendationItems JSON syntax
adriendupuis Nov 28, 2024
c553a15
Move recommendationItems JSON to included file
adriendupuis Nov 28, 2024
0f77e76
tracking_api.md: Fix suspicious typo in trigger message example
adriendupuis Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/personalization/api_reference/tracking_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,8 @@
Example of a recommendation response:

``` json
"recommendationItems": [
{
"recommendationItems": [
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should provide a full response here, in an external file, not an extract. And, if needed, highlight lines related to the topic.

{
"relevance": 23,
"itemType": 1,
Expand All @@ -372,7 +373,10 @@
"links" : {
"clickRecommended" : "//event.perso.ibexa.co/clickrecommended/johndoe/1/100175717?scenario=also_clicked&modelId=37",
"rendered" : "//event.perso.ibexa.co/rendered/johndoe/1/100175717"
},
}
}

Check warning on line 377 in docs/personalization/api_reference/tracking_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/api_reference/tracking_api.md#L377 

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output 
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/personalization/api_reference/tracking_api.md", "range": {"start": {"line": 377, "column": 6}}}, "severity": "WARNING"}
]
}
```

| Field name | Description |
Expand All @@ -387,7 +391,7 @@
A trigger message includes requests for a Triggeropened and Clicktriggered event.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use the properties of the trigger message below, triggerOpenedLink and clickTriggered?

The first is executed once, when the end user opens a trigger message (for example, embedded into a newsletter).
The second is called each time the user follows a link to see the recommended item.
Both requests provide the `triggername` parameter, which passes a unique alphanumerical identifier of the trigger that initiated the message.
Both requests provide the `triggerName` parameter, which passes a unique alphanumerical identifier of the trigger that initiated the message.

Example of a trigger message:

Comment on lines 378 to 379
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is again a JSON sample without consideration for parse errors.
I didn't find a test or other reference for this one.

Expand Down Expand Up @@ -444,7 +448,7 @@
|`scenario`|Name of the scenario, where recommendations originated from. This parameter is required.|URL-encoded alphanumeric|

The scenario parameter identifies the originating scenario to gain detailed statistics about the scenario that motivated the user to click on a recommendation.
This information comes with the recommendation from the recommendation controller. 
This information comes with the recommendation from the recommendation controller.

The event is used for providing statistics about how often users accepted the recommendations of the configured recommendation scenario or considered them as valuable.

Expand Down