> For the complete documentation index, see [llms.txt](https://docs.sealights.io/knowledgebase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/user-story-coverage/configuration/project-analytics-scope.md).

# Project analytics scope

Define which SeaLights coverage data appears in published analytics. This scope drives the data sent to Jira, Azure DevOps, and Confluence.

### Scope model

Project analytics scope is defined by four settings areas:

* `coverage_app_list` — which SeaLights apps and branches to query.
* `repo_list` — how repositories map to those apps and branches.
* `test_stages` — which raw SeaLights stages appear in the output.
* `grouped_test_stages` — how several stages roll up into higher-level views.

### Which section answers which question

* **Which SeaLights apps and branches should the report pull from?** — use **Coverage app list**.
* **How do repositories map to SeaLights apps and branches?** — use **Repository list**.
* **Which raw test stages should appear in the output?** — use **Test stages**.
* **How do I create rolled-up coverage views like overall coverage?** — use **Grouped test stages**.

### How these settings work together

{% stepper %}
{% step %}

### Define coverage sources

`coverage_app_list` defines where coverage is collected from.
{% endstep %}

{% step %}

### Map repositories

`repo_list` connects repositories to the correct SeaLights apps and branches.
{% endstep %}

{% step %}

### Choose raw stages

`test_stages` defines the stage-level metrics in the output.
{% endstep %}

{% step %}

### Create rollups

`grouped_test_stages` creates rollups like `overall` for target systems.
{% endstep %}
{% endstepper %}

### Coverage app list

Use `coverage_app_list` to match SeaLights application names and branches.

```json
{
  "coverage_app_list": [
    {
      "app_regex": "my-app",
      "branch_regex": "main",
      "integration_build": false
    },
    {
      "app_regex": "my-integration-build",
      "branch_regex": "develop",
      "integration_build": true
    }
  ]
}
```

#### Key fields

* `app_regex` — required SeaLights app matcher.
* `branch_regex` — required SeaLights branch matcher.
* `integration_build` — optional integration-build toggle.

### Repository list

Use `repo_list` to map repositories to SeaLights apps.

```json
{
  "repo_list": [
    {
      "repoName": "frontend-app",
      "baseUrl": "git@github.com:mycompany/",
      "branchName": "main",
      "SealightsAppName": "frontend",
      "SealightsBranchName": "main",
      "ignore": false
    }
  ]
}
```

#### Key fields

* `repoName` — required repository name.
* `baseUrl` — required git base URL.
* `branchName` — required repository branch.
* `SealightsAppName` — required SeaLights app name.
* `SealightsBranchName` — required SeaLights branch name.
* `ignore` — optional skip flag.

### Test stages

Use `test_stages` to define the raw stages from SeaLights.

```json
{
  "test_stages": [
    {
      "name": "Unit_Tests",
      "reportJsonKey": "unit_tests",
      "reportTitle": "Unit Tests"
    },
    {
      "name": "Integration_Tests",
      "reportJsonKey": "integration_tests",
      "reportTitle": "Integration Tests"
    }
  ]
}
```

#### Key fields

* `name` — stage name from the SeaLights report.
* `reportJsonKey` — JSON key in generated output.
* `reportTitle` — display name in reports.

### Grouped test stages

Use `grouped_test_stages` to aggregate several stages.

```json
{
  "grouped_test_stages": [
    {
      "name": "Overall",
      "reportJsonKey": "overall",
      "reportTitle": "Overall Coverage",
      "stages": ["Unit_Tests", "Integration_Tests", "E2E_Tests"],
      "show_gate": true,
      "severity": 2
    }
  ]
}
```

#### Key fields

* `name` — group identifier.
* `reportJsonKey` — JSON key for the grouped result.
* `reportTitle` — display name.
* `stages` — stage names included in the group.
* `show_gate` — optional gate display.
* `severity` — optional gate severity.

### Scope design tips

* Start with exact names before using broad regex.
* Keep repository, branch, and SeaLights names aligned.
* Use grouped stages for higher-level summaries.
* Use `integration_build: true` only for real integration-build flows.

Use [Deployment patterns](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/examples.md) for scope examples and [FAQ](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/faq.md) for repository and test stage questions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/user-story-coverage/configuration/project-analytics-scope.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.