Skip to content

Attribute markdown and ask events to their space #4501

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
nolannbiron wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Attribute markdown and ask events to their space #4501

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
6ca03e5
Attribute markdown and ask events to their space
nolannbiron Aug 14, 2026
1cfc0c1
changeset
nolannbiron Aug 14, 2026
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
5 changes: 5 additions & 0 deletions .changeset/markdown-events-space-attribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gitbook": patch
---

Attribute the markdown and ask events tracked from the middleware to their space, and record the goal passed alongside a question.
19 changes: 8 additions & 11 deletions packages/gitbook/src/middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,12 +753,14 @@ function encodePathInSiteContent(
} {
let pathname = removeLeadingSlash(removeTrailingSlash(siteURLData.pathname));

// The optional fields are coerced to null, otherwise they are dropped from the JSON payload
// instead of being sent as the `string | null` the API expects.
const eventLocation: Partial<SiteInsightsEventLocation> = {
siteSection: siteURLData.siteSection,
siteSection: siteURLData.siteSection ?? null,
siteSpace: siteURLData.siteSpace,
siteShareKey: siteURLData.shareKey,
siteShareKey: siteURLData.shareKey ?? null,
space: siteURLData.space,
revision: siteURLData.revision,
revision: siteURLData.revision ?? null,
displayContext: SiteInsightsDisplayContext.Server,
};

Expand Down Expand Up @@ -881,24 +883,19 @@ function encodePathInSiteContent(
}`
: `~gitbook/markdown/${encodePagePath(pagePathWithoutMD)}`,
routeType: 'static',
// TODO: track pageId / spaceId when possible
// We don't do it at the moment as we can't easily extract it from the URL.
events: ask
? [
{
type: 'ask_question',
query: ask,
location: {
displayContext: SiteInsightsDisplayContext.Server,
},
...(goal ? { goal } : {}),
location: eventLocation,
},
]
: [
{
type: 'page_markdown_request',
location: {
displayContext: SiteInsightsDisplayContext.Server,
},
location: eventLocation,
},
],
};
Expand Down
Loading