Skip to navigation
ObservePostman API Catalog

Create and manage API scorecards

View as Markdown

Create and manage scorecards to measure API quality across different metrics. You can choose from a variety of metrics, for example, runtime health, test quality, and spec quality. Set thresholds for each metric to determine when an API is healthy, needs attention, or is critical.

Once you create a scorecard, you can apply it to any API in your catalog to see how that API scores based on the defined metrics and thresholds.

Create a custom scorecard

To create a custom scorecard, do the following:

  1. Go to API Catalog > Scorecards.

  2. Click Create Scorecard and complete the Basics step.

    • Name (required)
    • Description
    • Default Filters to pre-filter which services the scorecard applies to, using the following options:

  3. Click Next to go to the Categories & Metrics step, where you can add metrics to the scorecard. Add at least one category with a metric to continue. You can choose from a variety of metrics, including runtime health, test quality, and spec quality. For each metric, you can set thresholds for healthy, needs attention, and critical statuses. Then, preview your scorecard to see how it will look when applied to an API.

    Scorecard preview

  4. Click Next to go to the Weights & Thresholds step, where you can assign weights to different categories and set overall score thresholds for the scorecard.

    Scorecard weights and thresholds

  5. Click Next to go to the Review Summary step, where you can review your scorecard settings before creating it. You can click Back to go back and make changes, or click Create to finish creating the scorecard.

Filter by environment

Use the environment selector in the top-right corner of a scorecard to choose which system environment’s data the scorecard shows. The selector defaults to All system environments.

All system environments doesn’t combine data from every environment. The scorecard uses its saved default environment. If it has none, it uses your first production environment. The scorecard lists only services linked to that environment, so a service linked only to another environment, such as Development, doesn’t appear.

If a listed service has no data in that environment, its missing data counts as 0. The service gets a low score and shows as Critical instead of blank.

The search and Governance Group filters change only which services appear in the table. The summary cards stay based on the environment and tag filters.

To see those services, select the specific environment they report data to, for example Development.

When you open a service from a scorecard, the service shows no score if it’s missing any of the scorecard’s saved default tags.