Skip to content

Conversation

@mmiermans
Copy link
Contributor

@mmiermans mmiermans commented Jun 6, 2023

Goal

Add a utm_source query parameter to the URL to:

  1. Allow publishers to attribute traffic coming from NewTab.
  2. Attribute Pocket sign-ups to NewTab.

I'd love feedback/perspectives on:

  • Whether this is a reasonable short-term solution.

Implementation Decisions

  • Kirill requested that the utm_source value is distinct from existing feeds, but it may be the same value for ES, FR, IT. Before we migrate existing markets over to this API, the utm_source value should be unique per ScheduledSurface. DIS-803

Deployment steps

  • FOR POCKET DEVELOPERS ONLY - Post in #changelog:

NewTab recommendation urls for France, Italy, Spain now have a utm_source parameter that's set to pocket-newtab-bff, such that publishers can attribute the traffic we send their way, and we can track sign-ups. #51

References

JIRA ticket:

Slack thread:

@mmiermans mmiermans requested review from a team as code owners June 6, 2023 23:41
@mmiermans mmiermans requested review from cmharlow and nina-py June 6, 2023 23:41
@mmiermans mmiermans force-pushed the feature/DIS-802-utm-source branch from 2c7c82d to 93e3056 Compare June 7, 2023 00:18
Copy link
Contributor

@jpetto jpetto left a comment

Choose a reason for hiding this comment

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

lgtm. do we need to handle the case where the url already has a utm_source query param? or is that overly cautious? (i can't remember if corpusItem has that data removed or not...)

@mmiermans mmiermans force-pushed the feature/DIS-802-utm-source branch from d1a30e9 to a7ddf63 Compare June 7, 2023 19:41
@mmiermans mmiermans force-pushed the feature/DIS-802-utm-source branch from a7ddf63 to e33d217 Compare June 7, 2023 19:42
@mmiermans
Copy link
Contributor Author

Good call-out @jpetto. There are 148 items in the Corpus that contain utm_source in the url.

I added a test to ensure utm_source is overridden by the Firefox API proxy.

@mmiermans mmiermans merged commit 1cfa41a into main Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants