# Entity details page

Each entity has a dedicated details page that centralizes all related data, helping developers stay focused by reducing context switching. To open an entity's details page, click its name either while browsing a catalog or from the **Catalogs > All entities** page. From here you can quickly access key information:

* **Active incidents** - Any ongoing incidents are surfaced at the top of the page for immediate visibility.
* **Sidebar** - [Customize which metadata](#configuring-the-entity-metadata-sidebar) appears here by pinning the information most relevant to you. Supported data includes on-call schedules, owners, Slack or Microsoft Teams channels, groups, repositories, entity relationships, doc links, project management, custom data, and code quality.

{% hint style="success" %}
During an incident, the entity details page surfaces everything you need in one place: the active incident, owners and on-call contacts, the relevant Slack channel, affected dependencies, and recent deploys.
{% endhint %}

{% hint style="info" %}
Fields only appear in the overview if data is available. For example, the **Slack channels** field won't display unless you have the Slack integration configured.
{% endhint %}

## Locating an entity's unique identifiers

The [Cortex tag](/ingesting-data-into-cortex/entities-overview/entities.md#cortex-tag) and the [Cortex ID](/ingesting-data-into-cortex/entities-overview/entities.md#cortex-id) are displayed below the entity's name.

<div align="left" data-with-frame="true"><img src="/files/Bk3B3XWmSABGIfdLTKeW" alt="The entity&#x27;s unique identifiers appear below its name." width="400"></div>

## Configuring the entity's sidebars

Each entity details page includes two sidebars—the entity details sidebar on the left and the entity metadata sidebar on the right—each serving a distinct purpose.

### Configuring the entity details sidebar

The entity details sidebar appear on the left side of every entity page. It provides a deeper view into the entity's recent deploys, events, security vulnerabilities, monitoring metrics, and more, giving you the context needed to resolve incidents quickly.

The entity details sidebar contains the following information about the entity:

#### Overview categories

* **Relationships** - See how an entity connects to the rest of your catalog including domain hierarchy, team hierarchy, dependencies, and any custom relationship types you've defined. See [Defining relationship types](/ingesting-data-into-cortex/entities-overview/entities/defining-relationship-types.md) and [Viewing relationships on an entity page](/ingesting-data-into-cortex/entities-overview/entities/defining-relationship-types.md#view-relationships-on-entity-pages).
* **API explorer** - Pulls from [API documentation](/ingesting-data-into-cortex/entities-overview/entities/external-docs.md) added to your entity.
* **Events** - A list of recent events sourced from [deploys](/ingesting-data-into-cortex/entities-overview/entities/deploys.md), [AWS ECS](/ingesting-data-into-cortex/integrations/aws.md), [Azure DevOps](/ingesting-data-into-cortex/integrations/azuredevops.md), [GitHub](/ingesting-data-into-cortex/integrations/github.md), [GitLab](/ingesting-data-into-cortex/integrations/gitlab.md), [Kubernetes](/ingesting-data-into-cortex/integrations/kubernetes.md), [Opsgenie](/ingesting-data-into-cortex/integrations/opsgenie.md), [PagerDuty](/ingesting-data-into-cortex/integrations/pagerduty.md), [Sentry](/ingesting-data-into-cortex/integrations/sentry.md), and [Snyk](/ingesting-data-into-cortex/integrations/snyk.md).
* **Links & docs** - [Documentation links](/ingesting-data-into-cortex/entities-overview/entities/external-docs.md) you have added to the entity, along with documentation pulled from the related repository.
* **Owners** - See the teams who own the entity, the related Slack or Microsoft Teams channels, and a list of team members. Learn more about [defining entity owners](/ingesting-data-into-cortex/entities-overview/entities/ownership.md).
* **Entity YAML** - View the [entity YAML](/ingesting-data-into-cortex/entities-overview/entities.md#defining-entities-via-yaml-file) that defines the selected entity.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>If you have <a href="/pages/KBttn6YUdEgixQGROHKf#step-1-disable-ui-editing">GitOps editing</a> enabled for this entity, and you have the <code>View GitOps logs</code> permission, this page displays the source of the YAML file and a preview of the latest GitOps log.</p></div>

#### Cortex features

* **Scorecards** - A list of any [Scorecards](/standardize/scorecards.md) that are in progress where this entity is being scored. Additionally, see the average score, median score, and a graph showing the entity's scores over time.
  * Above the *Scorecard* section, you can choose which scores to include in calculations if the entity is in a hierarchy:
    * **Domains** - Click **This entity only** to view only the scores that apply to the domain you are viewing. Select **Include entity's children** to include both the parent domain and its child entities in the score calculations.
    * **Entities with a custom relationship type** - Click **This entity only** to view only the scores that apply to the entity you are viewing. Click **\[Relationship type] only** to include both the parent and its child entities in the score calculations.
    * **Teams** - Click **This entity only** to view the scores that apply only to the team you are viewing. Click **Include entity's children** to include scores for the team, the team's children, entities owned by the team, and entities owned by the team's children.
* **Initiatives** - A list of all active [Initiatives](/improve/initiatives.md) for this entity, including the Scorecard's current level and the due date of the Initiative.
* **Workflows** - A list of [Workflows](/streamline/workflows.md) that include this entity.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>If you are a designated approver for any pending Workflows, they will appear at the top of this page. You can also view recently run Workflows and trigger any related Workflows from here.</p></div>

#### Connections

The *Connections* section displays integration data grouped by context. Once you configure integrations, data appears in the following sections on the entity page:

* **CI/CD** - Pulls from [deploys API](/ingesting-data-into-cortex/entities-overview/entities/deploys.md), [Azure DevOps](/ingesting-data-into-cortex/integrations/azuredevops.md), [Bitbucket](/ingesting-data-into-cortex/integrations/bitbucket.md), [Buildkite](/ingesting-data-into-cortex/integrations/buildkite.md), [CircleCI](/ingesting-data-into-cortex/integrations/circleci.md), [GitHub](/ingesting-data-into-cortex/integrations/github.md), and [GitLab](/ingesting-data-into-cortex/integrations/gitlab.md).
* **Cloud** - Pulls from [AWS](/ingesting-data-into-cortex/integrations/aws.md) and [Kubernetes](/ingesting-data-into-cortex/integrations/kubernetes.md).
* **Code quality** - Pulls from [Codecov](/ingesting-data-into-cortex/integrations/codecov.md) and [SonarQube](/ingesting-data-into-cortex/integrations/sonarqube.md).
* **Custom data & metrics** - Pulls from [custom data](/ingesting-data-into-cortex/entities-overview/entities/custom-data.md) and [Eng Intelligence custom metrics](/improve/eng-intelligence/custom-metrics.md).
* **Dashboard** - Pulls from [charts](/ingesting-data-into-cortex/entities-overview/entities/external-docs.md#embed-dashboards) configured in the entity's YAML file for [Datadog](/ingesting-data-into-cortex/integrations/datadog.md), [Grafana](/ingesting-data-into-cortex/integrations/grafana.md), and [New Relic](/ingesting-data-into-cortex/integrations/newrelic.md).
* **Error tracking** - Pulls from [BugSnag](/ingesting-data-into-cortex/integrations/bugsnag.md), [Rollbar](/ingesting-data-into-cortex/integrations/rollbar.md), and [Sentry](/ingesting-data-into-cortex/integrations/sentry.md).
* **Feature flags** - Pulls from [LaunchDarkly](/ingesting-data-into-cortex/integrations/launchdarkly.md).
* **Observability** - Pulls from [Coralogix](/ingesting-data-into-cortex/integrations/coralogix.md), [Datadog](/ingesting-data-into-cortex/integrations/datadog.md), [Dynatrace](/ingesting-data-into-cortex/integrations/dynatrace.md), [Google Observability Cloud](/ingesting-data-into-cortex/integrations/google.md), [Lightstep](/ingesting-data-into-cortex/integrations/lightstep.md), [New Relic](/ingesting-data-into-cortex/integrations/newrelic.md), [Prometheus](/ingesting-data-into-cortex/integrations/prometheus.md), [Splunk Observability Cloud](/ingesting-data-into-cortex/integrations/splunk-observability.md) (formerly SignalFX), and [Sumo Logic](/ingesting-data-into-cortex/integrations/sumologic.md).
* **On-call & incidents** - On-call information from [Opsgenie](/ingesting-data-into-cortex/integrations/opsgenie.md), [PagerDuty](/ingesting-data-into-cortex/integrations/pagerduty.md), [Splunk On-Call](/ingesting-data-into-cortex/integrations/splunk-oncall.md) (formerly VictorOps), and [xMatters](/ingesting-data-into-cortex/integrations/xmatters.md), and incidents pulled from [incident.io](/ingesting-data-into-cortex/integrations/incidentio.md), [PagerDuty](/ingesting-data-into-cortex/integrations/pagerduty.md), [FireHydrant](/ingesting-data-into-cortex/integrations/firehydrant.md), and [Rootly](/ingesting-data-into-cortex/integrations/rootly.md).
* **Packages** - Pulls from the [packages API](/api/readme/packages.md) and any packages automatically discovered from your configured git repositories.
* **Project management** - Pulls from [Azure DevOps](/ingesting-data-into-cortex/integrations/azuredevops.md), [ClickUp](/ingesting-data-into-cortex/integrations/clickup.md), [GitHub](/ingesting-data-into-cortex/integrations/github.md), [GitLab](/ingesting-data-into-cortex/integrations/gitlab.md), and [Jira](/ingesting-data-into-cortex/integrations/jira.md).
* **Security** - Pulls from [Apiiro](/ingesting-data-into-cortex/integrations/apiiro.md), [Checkmarx](/ingesting-data-into-cortex/integrations/checkmarx.md), [Codecov](/ingesting-data-into-cortex/integrations/codecov.md), [GitHub](/ingesting-data-into-cortex/integrations/github.md), [GitLab](/ingesting-data-into-cortex/integrations/gitlab.md), [Mend](/ingesting-data-into-cortex/integrations/mend.md), [Semgrep](/ingesting-data-into-cortex/integrations/semgrep.md), [Snyk](/ingesting-data-into-cortex/integrations/snyk.md), [SonarQube](/ingesting-data-into-cortex/integrations/sonarqube.md), [Veracode](/ingesting-data-into-cortex/integrations/veracode.md), and [Wiz](/ingesting-data-into-cortex/integrations/wiz.md).
* **Version control** - Pulls from [Azure DevOps](/ingesting-data-into-cortex/integrations/azuredevops.md), [Bitbucket](/ingesting-data-into-cortex/integrations/bitbucket.md), [GitHub](/ingesting-data-into-cortex/integrations/github.md), and [GitLab](/ingesting-data-into-cortex/integrations/gitlab.md).

#### Plugins

The *Plugins* section displays [plugins](/streamline/plugins.md) that are relevant to this entity.

### Configuring the entity metadata sidebar

The entity metadata sidebar appears on the right side of every entity page. You can control which metadata categories are displayed, reorder them, and apply the same layout across multiple entity types at once.

#### Expanding or collapsing the metadata sidebar

Click the **arrow icon** in the bottom-right corner to expand or collapse the metadata sidebar.

<div align="left" data-with-frame="true"><img src="/files/B0vSTwUs66DgX7xEI43O" alt="The arrow icon in the bottom-right corner of the page." width="400"></div>

#### Customizing the metadata sidebar

Users who are admins or who have the `Edit Entity Types` permission can customize the metadata sidebar.

1. In the bottom-right corner of the metadata sidebar, click the **Configure entity sidebar** icon.

   <div align="left" data-with-frame="true"><img src="/files/2okzb7JdlzJ4bGEjf5Bn" alt="The Configure Entity icon icon in the bottom-right corner of the page." width="400"></div>
2. To reorder a category, hover over the **grip icon** and drag it to the desired position. To hide a category, click the **eye icon** next to it. Repeat as necessary.

   <div align="left" data-with-frame="true"><img src="/files/eRMiOZrZZ06XBwzVjYEP" alt="The Grip icon next to an entity." width="250"></div>
3. From the *Apply layout to entity types* drop-down menu, select which entity types to apply this configuration to.

   <div align="left" data-with-frame="true"><img src="/files/E68PrA7T1R5M28VagrR4" alt="The Apply layout to entity types drop-down 
   menu in the bottom-right corner of the page." width="250"></div>
4. Click **Apply to workspace**.

## Customizing entity page tabs <a href="#pinning-plugins" id="pinning-plugins"></a>

Users with the `Edit Entities` permission can pin, reorder, and hide plugins on an entity page. Plugins pinned this way appear as tabs at the top of the page, either on a single entity or across all entities of the same type.

Before a plugin can be pinned, it must be configured to include the relevant entity type in its context. For example, to pin a plugin on a Teams entity page, include the `team` entity type when registering the plugin in Cortex.

{% hint style="info" %}
System-level tabs are always visible by default but can be reordered. Most entity types only have the **Overview** tab, though some have more. For example, Teams entity pages include both the **Overview** and **Entities** tabs. Applicable plugins are also visible by default and are appended to any existing tab configuration.
{% endhint %}

Tab configurations saved at the individual entity level take precedence over configurations saved at the entity-type level. For example, if you customize tabs on the *Engineering* Teams page and later save a different tab configuration for all `team` entities, the *Engineering* page keeps its original configuration.

**To pin and reorder plugins**:

1. Navigate to the entity.
2. On the entity details page, click the **gear icon**.

   <div align="left" data-with-frame="true"><img src="/files/yus6BjEvgL4ig8VSCDlk" alt="The Gear icon near the upper-right corner of the page." width="400"></div>

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>When there are too many pinned tabs to fit across the page, the <strong>gear icon</strong> moves into the <em>Overflow</em> menu. Click the <strong>Overflow menu icon</strong> to access it.</p></div>

   The *Edit tabs* panel opens.
3. To reorder a plugin, hover over the **grip icon** and drag it to the desired position. To hide a plugin, click the **eye icon** next to it. Repeat as necessary.

   <div align="left" data-with-frame="true"><img src="/files/nUhEdHmYlJfmkv4xZh8H" alt="The Grip icon next to a plugin." width="250"></div>

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>There is no limit to the number of plugins you can pin to an entity page. If you have more pinned plugins than can fit across the page, the remaining tabs are accessible via the <em>Overflow</em> menu.</p></div>
4. To apply the layout to all entities of the same type, select the **Apply to entities of type service** checkbox.
5. Click **Save**. The plugin is pinned to the top of the entity details page.

   <div align="left" data-with-frame="true"><img src="/files/lCMnkJxyVjw7ZKOhoHhD" alt="The pinned plugin tabs." width="400"></div>


---

# Agent Instructions: 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:

```
GET https://docs.cortex.io/ingesting-data-into-cortex/entities-overview/entities/details.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.