adobe / adobe/spacecat-api-service

API to configure report(s) in bulk for given a list of sites

Open
#227 0 comments 0 reactions 0 assignees View on GitHub
automation enhancement
Dominant language
JavaScript
Stars
10
Forks
15
Avg merge
1d 9h
Merged PRs (30d)
150

Description

**Is your feature request related to a problem? Please describe.**
Since we are using a phased approach for enabling auditing (specifically ahrefs-related) and reporting, we need an easy way non-engineers can configure reporting for sites or organizations, as they come into our pipeline.
Sometimes a customer can have tens of specific sites in an organization for which we need to enable reporting on a single channel, while for the rest of the sites reporting shouldn't be done. This requires us to perform tens of get - patch API calls manually.

**Describe the solution you'd like**
An API that, given:
- a list of sites (baseURLs, not encoded)
- organizationId
- list of report types
- slack channel ID and optionally user IDs
- byOrg or not
Configures reporting for all those sites accordingly.

**Describe alternatives you've considered**
Scripting that would actually do the same, but outside the API, and could be error-prone, like https://github.com/iuliag/spacecat-automation-tools

**Asks that could have been solved by the feature**
https://cq-dev.slack.com/archives/C05A45JBP9N/p1710871764208859

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing GET and PATCH reporting API operations referenced in the issue and the current site or organization configuration flow. Define the bulk request and verify that it applies the listed report types, Slack channel, optional users, and byOrg setting only to the supplied sites, with behavior matching the existing configuration APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.