Add external link tracking to Fathom integration #534
Conversation
|
|
Changes look good. But before I merge this, can you install and test this version to verify it works on your end too? https://app.gitbook.com/integrations/test-fathom-update If all is good, I can get this merged in, and deployed to the production version :) |
|
Hey @addisonschultz , the tracking it self works, but I do not get a event for external site clicks. So it does not work yet. |
|
Can I simply update this PR and it will reflect the changes in my space? |
|
You can update this PR - and I'll update the integration after! |
KevinRohn
force-pushed
the
fathom-track-external-sites
branch
from
f337239
to
6255c24
Compare
|
Hi @addisonschultz, I made a mistake in the replace function call... Can you please update the integration? |
|
It should be updated now - you can install with the same link! https://app.gitbook.com/test-fathom-update |
|
@addisonschultz please update again. |
|
Done ✅ The integration looks good - is it working as expected on your end as well? |
|
Hi @addisonschultz, now it works as expected! |
| @@ -36,11 +36,27 @@ summary: | | |||
| categories: | |||
| - analytics | |||
| configurations: | |||
| space: | |||
There was a problem hiding this comment.
We don't use this space configuration key anymore - so you can omit this one from the configuration (See main right now, as it's been removed
integrations/fathom/src/index.ts
Outdated
| return new Response(script.replace('<TO_REPLACE>', siteId), { | ||
| const trackExternalLinks = | ||
| environment.siteInstallation?.configuration?.track_external_links ?? | ||
| environment.spaceInstallation?.configuration?.track_external_links ?? |
There was a problem hiding this comment.
You can omit environment.spaceInstallation... from here as well
Sure, I will do this. Please keep this PR open - I want to provide some changes to the event information. window.fathom.trackEvent('External link clicked: ' + domainName);The |
|
@addisonschultz ok, please update again for a final test |
|
Sorry for the delay! It's just been updated again |
Can you please check the Edit: |
|
Looking into it 😕 |
|
@KevinRohn can you give it a try now? We should have fixed the bug causing this! |
This PR adds an option to track external link clicks in the Fathom integration. Regarding to the issue #450
When enabled, the integration tracks clicks on links leading to external domains. It sends an event to Fathom with the format "External link clicked: domain".
index.tsto pass the new option to the scriptgitbook-manifest.yamlwith the new configurationfathomScript.raw.jsimplement external link trackingsiteIDrenamed tositeId, this naming is also for other integrationsI hope I did anything correct, because I was not able to test it without the script injection scope.
Cheers,
Kevin