-
Notifications
You must be signed in to change notification settings - Fork 46
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.
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
feat: add adobe analytics tracking id to redocly api block #1619
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to think about how we are attaching the specific link tracking. Not sure what exactly fires when you hit the try it button but I'm going to assume that all try it buttons will get captured with Redocly-Container
id. We'd ideally like to have the link tracking unique to every try it button. I think in this case we can replace daa-ll
with daa-lh
which sets just the section for the analytics tracking. And then re-take a look on how we can attach the call to the try it button again...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @timkim, I've replaced the attribute with daa-lh
and tested with https://developer-stage.adobe.com/redocly-test/api-full/. I think we can differentiate between the different operations and buttons clicked with the three values:
pageUrl = https://developer-stage.adobe.com/redocly-test/api-full/#operation/uploadFile
Activity Map Link = d1d1d1d1d3d1d1d3d3d1d2d1d1B1-Try it
Link Name = Redocly-Container
pageUrl = https://developer-stage.adobe.com/redocly-test/api-full/#operation/uploadFile
Activity Map Link = d1d1d1d1d3d1d1d3d3d1d2d1d4B1-Send
Link Name = Redocly-Container
pageUrl = https://developer-stage.adobe.com/redocly-test/api-full/#operation/addPet
Activity Map Link = d1d1d1d1d3d1d1d3d4d1d2d1d1B1-Try it
Link Name = Redocly-Container
pageUrl = https://developer-stage.adobe.com/redocly-test/api-full/#operation/addPet
Activity Map Link = d1d1d1d1d3d1d1d3d4d1d2d1d4B1-Send
Link Name = Redocly-Container
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@timkim I'm assuming I'll have to rewrite this once we migrate from Adobe analytics to CJA analytics.
(Hoping I'm able to hook up redocly's TryItOpen and TryItSent events using step 4 in the wiki https://wiki.corp.adobe.com/display/marketingtech/Adobe+Experience+Platform+Integration+Guide. Assuming we don't have that loading issue with gatsby and are able to make a command and trust that it dequeues when _satellite.track is ready)
Description
Add Adobe Analytics tracking ID to RedoclyAPIBlock
Related Issue
https://jira.corp.adobe.com/browse/DEVSITE-1307
Motivation and Context
The request from Adobe Experience Platform API team was to be able to track the "Try It" and "Send" button clicks on the Redocly Try It panel. Ideally, we would add the adobe analytics tracking ID directly on those buttons, but since we don't have access to those buttons, I added it to their parent div instead. This resulted in a much simpler code change.
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: