salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. API Governance

  3. Monitoring API Conformance

Monitoring API Conformance

After you configure governance profiles for your APIs and the resulting governance data is available, you can monitor and report on your organization’s API conformance.

Test Profile Settings Using Draft Profiles

Consider using draft profiles to test profile settings. This enables you to limit the scope of the profiles to just what you need before alerting the API owners about identified API conformance issues.

API conformance information for a selected draft profile
1 View a summary of API conformance for the selected draft profile.
2 View the APIs targeted by the draft profile. These APIs are governed, but their conformance information isn’t shown outside of the draft profile view unless they’re also targeted by an active profile.
3 Export a conformance report in CSV format for all APIs targeted by this draft profile.
4 View, edit, or duplicate profile settings.
5 Export a report of only this API’s conformance information or open the API in Exchange.

To test profile settings using draft profiles:

  1. On the API Governance console, select the Profiles tab.

  2. Select Draft.

  3. Select a profile.

  4. View conformance information.

  5. Edit the profile settings and view the API conformance results for different selections until you target the desired set of APIs and apply the optimal set of rules to them.

  6. Activate the profile to share the conformance information across Anypoint Platform so that developers can take action to resolve the conformance issues in APIs they own.

Monitor Conformance Information for Active Profiles

To view API conformance information for APIs targeted by active profiles, view the summary information in the API Governance console and in validation reports.

Screenshot of the API Governance console
1 View a summary of your governance usage and API conformance status information to more easily monitor your organization’s API conformance.
2 View, filter, search, and take action on a summary list of your active and draft governance profiles or your governed APIs.
3 Export conformance reports in CSV format.
4 Create a profile and save it as draft or active.
5 View the comprehensive governance report for an API.
6 Select from the more options menu to take relevant actions. You can export reports for a selected profile or API, view, edit, or delete a profile, notify API owners, or open an API in Exchange.
Only API Governance and organization administrators can create, edit, and delete profiles.

Use the summary on the governance console to monitor your API governance:

Governance Usage by Profile Type

Shows the usage of API Governance, including number of governed APIs, total number of APIs by profile type, and subscription limit information. Because some APIs might be in both active and draft profiles, this tile specifies how many are in draft only.

Active Profile Status

Shows profile statuses for active profiles based on the percentage of conformant APIs in the profiles:

  • Normal:

    More than 70% of APIs are conformant.

  • At Risk:

    Fewer than 70% of APIs are conformant.

Conformance Status

Shows the breakdown of conformance for the APIs targeted by your governance profiles as follows:

  • Conformant:

    The APIs pass all applied governance rulesets.

  • Not Conformant:

    The APIs fail at least one governance ruleset.

  • Not Validated:

    The APIs are not validated because they are not included in a governance profile.

Nonconformance by Severity

Shows the severity of API nonconformance to rulesets based on the percentage of all of the required rulesets that the APIs passed. The higher the severity, the fewer rulesets the APIs passed.

  • High Severity:

    0 - 40% rulesets passed

  • Medium Severity:

    41% - 80% rulesets passed

  • Low Severity:

    81% - 99% rulesets passed

API Governance Usage Reports

You can view usage reports to gain insight into your monthly usage of API Governance. See Viewing Usage Reports for API Governance.

Governance Validation Report

You can view conformance details for governed APIs in their governance validation reports in API Governance and API Manager. See Finding and Fixing Conformance Issues.

Export Conformance Information

You can export profile and API conformance information in CSV format from several places in the API Governance console.

API Conformance Information by Profile

To export profile information:

  1. On the API Governance console, select the Profiles tab.

  2. Click Export Report.

    The exported CSV file contains API conformance information for each profile in your organization. The information includes:

    • Organization ID

    • Profile IDs

    • Profile name

    • Profile type (ACTIVE or DRAFT)

    • Total APIs validated

    • Number of conformant APIs (pass)

    • Number of nonconformant APIs (fail)

    • Timestamp

    • Associated tags in Exchange

Governed APIs Targeted by Active Profiles

To export a report of all governed APIs targeted by your active profiles:

  1. On the API Governance console, select the Governed APIs tab.

  2. Click Export Report.

    The exported CSV file contains conformance information for each API targeted by the active profiles in your organization. The information includes:

    • Organization ID

    • API ID

    • API Version

    • Total number of asset versions for that API Version

    • Number of conformant APIs (pass)

    • Number of nonconformant APIs (fail)

    • Timestamp

API Conformance Information for a Specific Profile

To export a conformance report for APIs targeted by a specific active or draft profile:

  1. On the API Governance console, select the Profiles tab.

  2. Select Active or Draft.

  3. Select a profile.

  4. Click Export to CSV.

    The exported CSV file contains conformance information for each API targeted by the selected profile. The information includes:

    • Organization ID

    • API ID

    • API Version

    • Total number of asset versions for that API Version

    • Number of conformant APIs (pass)

    • Number of nonconformant APIs (fail)

    • Timestamp

Evaluate API Conformance Using the CLI

To use a command to evaluate the potential rulesets for your API project, use the governance:api:evaluate command.

Those who don’t have access to API Governance, such as developers, can use the CLI to evaluate which rulesets their APIs might be subject to validation against based on given filters. This enables developers to be proactive in understanding the potential conformance of APIs to rulesets before their APIs become governed.

Additionally, those who do have access to API Governance, such as governance officers, might use this command to plan or debug profile configurations.

governance:api:evaluate

> governance:api:evaluate [flags]

This command evaluates specified filters to determine the rulesets that would be applied to your APIs that meet that criteria.

Besides the default flags, this command also accepts:

Flag Description

--api=<api>

The API project against which you want to evaluate. The command uses the criteria in the project’s exchange.json file.

--criteria <filtertype:filtervalue>,…​

Enables you to apply filters against which to evaluate to identify rulesets. Specify a list of comma-separated filters where each filter has a type and value in the format filtertype:filtervalue.

Available filters include:

  • scope: API type, rest-api or async-api

  • tag: Tag defined for APIs in Exchange

  • category: Category defined for APIs in Exchange, where the filter value is specified in two parts as categoryName:value

  • env-type: Environment type of any, production, or sandbox

  • env-id: The ID for the environment name in API Manager. You can get this value using API Manager > Environment information. See Reviewing Environment Concepts.

    If env-type or env-id is used, the API Instance filter is set in the profile, so that only APIs that have instances are filtered.

    To deselect the API Instance filter in the profile using the CLI, update the profile using the --criteria flag with neither env-type nor env-id.

Example: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production
This command must be run with either the --criteria or the --api flag.

Example commands:

anypoint-cli-v4 governance:api:evaluate --criteria "tag:best,category:API Type:Experience API,scope:rest-api"

anypoint-cli-v4 governance:api:evaluate --api order-api-1.0.0-raml.zip
where order-api-1.0.0-raml.zip contains an API and its exchange.json file

Example output:

╔════════════════════════════════════════════════════════════════════╗
║ Ruleset GAV                                                        ║
╟────────────────────────────────────────────────────────────────────╢
║ 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.5.1 ║
╟────────────────────────────────────────────────────────────────────╢
║ 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.1 ║
╚════════════════════════════════════════════════════════════════════╝

See Also