Skip to content

feat: add adobe analytics tracking id to redocly api block #1619

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

Open
melissag-ensemble wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add adobe analytics tracking id to redocly api block #1619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7732d82
feat: add adobe analytics tracking id to redocly api block
melissag-ensemble Sep 13, 2024
810c661
fix: set section for analytics tracking
melissag-ensemble Sep 13, 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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Using a theme, all of your default configuration lives in an npm package.
- [Local development limitation and workaround](#local-development-limitation-and-workaround)
- [Full width page](#full-width-page)
- [Displaying long API response descriptions](#displaying-long-api-response-descriptions)
- [Analytics and Redocly API Block](#analytics-and-redocly-api-block)
- [width (optional)](#width-optional)
- [typography (optional)](#typography-optional)
- [codeblock (optional)](#codeblock-optional)
Expand Down Expand Up @@ -1128,6 +1129,16 @@ For long descriptions, Redocly suggests to use the [x-summary](https://redocly.c
![redocly-api-block-long-description-with-x-summary](docs/images/redocly-api-block-long-description-with-x-summary.png)
![redocly-api-block-long-description-with-x-summary-yaml](docs/images/redocly-api-block-long-description-with-x-summary-yaml.png)

#### Analytics and Redocly API Block

To track clicks on the Try It button, look for:
* Link Name: Redocly-Container
* Activity Map Link: d1d1d1d1d3d1d1d3d3d1d2d1d1B1-Try it

To track clicks on the Send button, look for:
* Link Name: Redocly-Container
* Activity Map Link: d1d1d1d1d3d1d1d3d3d1d2d1d4B1-Send

#### width (optional)

```js
Expand Down
5 changes: 5 additions & 0 deletions packages/gatsby-theme-aio/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## [4.14.11](https://github.com/adobe/aio-theme/compare/@adobe/gatsby-theme-aio@4.14.10..@adobe/gatsby-theme-aio@4.14.11) (2024-09-13)

### Features
* Add Adobe Analytics tracking ID to RedoclyAPIBlock [343069f](https://github.com/adobe/aio-theme/commit/343069ff624595e9aea6152987eea28aad5c1ded)

## [4.14.10](https://github.com/adobe/aio-theme/compare/@adobe/gatsby-theme-aio@4.14.9..@adobe/gatsby-theme-aio@4.14.10) (2024-08-14)

### Features
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-theme-aio/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@adobe/gatsby-theme-aio",
"version": "4.14.10",
"version": "4.14.11",
"description": "The Adobe I/O theme for building markdown powered sites",
"main": "index.js",
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-theme-aio/src/components/RedoclyAPIBlock/index.js
View file
Open in desktop
Copy link
Collaborator

@timkim timkim Sep 13, 2024

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...

Copy link
Collaborator Author

@melissag-ensemble melissag-ensemble Sep 18, 2024

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

Copy link
Collaborator Author

@melissag-ensemble melissag-ensemble Sep 25, 2024 •
edited
Loading

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)

Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const RedoclyAPIBlock = ({
<>
{!isRedoclyLoading && (
<>
<div id="redocly_container" />
<div id="redocly_container" daa-lh="Redocly-Container" />

<script>{
`RedoclyReferenceDocs.init(
Expand Down