Skip to content
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

Jump to bottom

Implement analytics site integration hook (SITES-20864) #237

Open
iuliag opened this issue Mar 25, 2024 · 0 comments
Open

Implement analytics site integration hook (SITES-20864) #237

iuliag opened this issue Mar 25, 2024 · 0 comments
Labels
analytics Analytics related issue enhancement New feature or request

Comments

@iuliag
Copy link
Contributor

iuliag commented Mar 25, 2024 •
edited
Loading

Is your feature request related to a problem? Please describe.
After the automated setup triggered by a customer for integrating analytics for a specific site, completes, they need to be notified about the data collection scripts to embed into their site and the new reporting available to them.

Describe the solution you'd like
After the customer triggers the analytics integration for a specific site by using #236, when the automated setup completes, that service/UI will call the hook API specified at #188, with the artifacts of the setup.

SpaceCat needs to:

  • store the artifacts of the setup in the config of the site, under config.integrations.analytics
  • notify the customer on their channel about:
    • the data collection scripts they need to embed into their site and how to do that (link to public documentation or list the steps in the message)
    • the new reporting available to them
    • (tbd) the rest of the artifacts of the setup

Additional context
Requires:
@iuliag iuliag added enhancement New feature or request analytics Analytics related issue labels Mar 25, 2024
@iuliag iuliag mentioned this issue Mar 28, 2024
Merged
iuliag added a commit that referenced this issue Apr 3, 2024
@iuliag
feat(api-spec): analytics site integration API spec (#188)
18a90b6 
Implements: SITES-20862

After the setup for an analytics solution is completed for the site represented by the base URL, the new hook will be called with the different artifacts details. SpaceCat will use these in its automations such as:
- notifying users about the new reporting available
- opening a PR to embed the data collection scripts into the site
- importing RUM data into the analytics solution (Adobe Analytics or Customer Journey Analytics)

The SpaceCat site id will be used as a shared identifier between SpaceCat and Omnivore, as it's more stable than the baseURL.
SpaceCat will initially start using siteId, dataCollection and reporting, as required by the Slack-based flow.
Implementation will be done via #237
@iuliag iuliag changed the title Implement analytics site integration hook Implement analytics site integration hook (SITES-20864) Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
analytics Analytics related issue enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@iuliag