Discovery

In Discovery, you have an overview of the main information about your APIs.
This API catalog supports multiple gateways, allowing greater control and organization of your ecosystem.

Quick Links

See how to:

Totals

At the top of the Discovery screen, you will find a dashboard with metrics from your catalog, based on the applied filters.

discovery totalizers

  • Number of APIs: Displays the total number of APIs in the catalog.
    Click the card to see a graphical representation of the total APIs categorized by provider.
    pie chart

  • Uncategorized APIs: Total number of APIs without an associated tag.

  • APIs recently imported: Total number of APIs imported into the catalog in the last 7 days. See how to change the period.

  • APIs recently updated: Total number of APIs in the catalog updated in the last 7 days. See how to change the period:

    To change the period for APIs recently imported or APIs recently updated:

    APIs recently imported

    1. Click the gear icon on the card.

    2. Select the desired period:

      • Yesterday: Previous day.

      • Last 7 days: Last 7 days.

      • Last 15 days: Last 15 days.

      • Last 31 days: Last 31 days.

    3. Click OK.

APIs listing

Imported APIs are listed in a table with the following columns:

API catalog

  • PROVIDER: Icon identifying the gateway provider (examples: Sensedia, AWS, etc.)

  • NAME: API name.

  • VERSION: Current version.

  • OWNER: Click three-dot menu and select one of the options:

    • View owner: View the API owner, which can be a team or user.

    • View shared with: View who the APIs are shared with.

  • MATURITY: API maturity score, which can be:

    Icon Level Range

    icon representing basic maturity level

    Basic

    0 to 29%

    icon representing intermediate maturity level

    Intermediate

    30 to 79%

    icon representing advanced maturity level

    Advanced

    80 to 94%

    icon representing excellent maturity level

    Excellent

    95 to 100%
    Get the full maturity report and AI-generated recommendations, with the option to download the Swagger with the applied recommendations.

  • ISSUES: Indicates the presence of issues that may impact API quality and the ecosystem. Identifies elements that can be modified to improve aspects such as organization and performance.
    Common Issues types:

    • Consistency: Related to API consistency and organization. Indicates violations of best practices in OpenAPI contracts. Ensures that contracts are complete and consistent, aligning development and documentation with organizational rules.

    • Efficiency: Related to resource usage. Indicates redundancies and optimization opportunities but does not cover performance aspects.

      An empty field in the ISSUES column immediately after import does not necessarily indicate the absence of issues.
      After import, APIs need processing, and the time to generate Issues can vary from minutes to hours, depending on the number of APIs and the size of imported contracts.

  • TAGS: Tags (labels). See how tags work.

  • ACTIONS:

    • icon visualize: View details about the corresponding item, such as general data, revisions, and associated environments.

    • icon tags: Add tags to the corresponding item or manage existing ones.

Searching for an API

To see all filtering options, click the icon expand icon.

You can search APIs by:

search bar

  • Name: API name.

  • Tags: Select or type the tag name. See how tags work.
    Use the Tag Mode field to define the tag search criteria:

    • Any of selected: APIs with at least one of the selected tags (default).

    • All of selected: APIs with all selected tags.

    • None of selected: APIs without the selected tags.

    • No tag applied: Displays APIs without tags.

  • Version: API version.

  • Description: API description field content.

  • Provider: Gateway provider (examples: Sensedia, AWS, etc.).

  • Connections: Name of the connection.

  • Owners: API owner (team or user).

  • Shared with: Team or user the API is shared with. You can use one or more teams or users for the search.

  • Imported At: API import date.

  • Updated At: Last API update date.

After entering values in the desired fields, click SEARCH to perform the search or CLEAR to clear the fields.

Categorization by Tags

Tag categorization allows you to classify and group catalog APIs using customizable labels, making API management easier and faster. This feature lets you search for APIs in the same category using their tags.

Associate a Tag with an API

There are two ways to associate a tag with a catalog API:

  • Tags icon image of a tag

    1. In the API listing on the Discovery screen, click the image of a tag icon for the API you want to categorize (associate a tag with).

    2. If the selected API does not yet have an associated tag, click ADD.

    3. In the Tag Name field, enter the name of the tag you want to associate (new or previously registered).

      • A tag name must be between 2 and 30 characters long.

      • Only lowercase alphanumeric characters and "-" are allowed.

      • The tag name cannot start or end with "-".

    4. Click + (or press ENTER on your keyboard) to associate the tag.

      tag screen with emphasis on the + button to add

      If you click OK without clicking + (or pressing enter), the tag will not be associated/created.

    5. If you want to add another tag, repeat the last two steps. Each API can have up to 50 associated tags.

    6. Click OK to close the window.

  • View details icon icon visualize

    1. In the API listing on the Discovery screen, click the image of a magnifying glass over a document icon in the ACTIONS column for the API you want to categorize (associate a tag with).

    2. Click the image of a tag icon next to Tags in the BASIC INFO panel.

    3. Follow steps 3 to 6 described above.

Remove Tags from an API

There are two ways to disassociate one or more tags from a catalog API:

  • Tags icon image of a tag

    1. In the API listing on the Discovery screen, click the icon tags button corresponding to the API from which you want to remove the tag(s).

    2. In the window that opens, locate the tag you want to disassociate from the API.

    3. Click the X button for that tag to remove it.

      tag screen with emphasis on the x button to remove

    4. If you want to remove another tag from this API, repeat the last two steps.

    5. Click OK to close the window.

You can also disassociate tags from the API details screen:

  1. On the details screen of the desired API, click the icon pencil button in the Tags field of the BASIC INFO panel.

  2. Follow steps 2 to 5 described above.

Editing API Information

To edit API information, click the image of a magnifying glass over a document icon.

In the BASIC INFO panel, you can edit:

  • Owner: To edit the API owner (user or team), click Owner image representing a person and select the desired option.

  • Shared with: To edit who the API is shared with, click Shared with image representing two people and select one or more users.

Bulk Editing

Use the BULK EDIT feature to apply the same information to multiple APIs in a single action.

To do this, follow these steps:

  1. In the API listing on the Discovery screen, select the APIs to be edited.
    To select all, click the checkbox next to PROVIDER in the row displaying the column titles.

  2. Click the BULK EDIT button.

    screen showing the API list and the bulk edit option

  3. You can edit the Owner and Shared with.

    bulk edit screen

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]