Last updated Feb 23, 2024

Monitor API metrics

API metrics help identify issues with and optimize the performance of APIs being used by apps. This helps ensure apps are delivering expected results. When monitoring API metrics, we recommend using filters to refine the results.

To view API metrics:

  1. Access the developer console.
  2. Select the Forge app that you want to view metrics for.
  3. Select Metrics in the left menu.
  4. Select API in the left menu.

The image below shows API metrics, as well as all sites that your Forge app is currently installed on, and where there has been at least one invocation in the selected time period. If there hasn't been any invocation or if the app isn't using any APIs, the charts won't show any data.

Metrics screen

API metrics

The following metrics are available for monitoring in the developer console:

API status codes

HTTP response status codes are indicators of whether or not a specific HTTP request has been successfully completed. When monitoring API performance, you can scan the volume of the most frequent responses for each status code. The data resolution of each chart depends on the time interval you've selected.

You can see a summary of the following status codes in the developer console:

  • 2xx - Success
    • Indicates client requests that are successfully received, understood, and processed by the server.
    • The chart shows the total volume of successful API responses against the selected time interval.
  • 3xx - Redirection
    • Indicates that the client must take additional action to complete the request.
    • These are often used when the requested resource has moved to a different location.
  • 4xx - Client errors
    • Indicates that there's an issue with the client's request, such as invalid credentials or a mistyped URL that's resulting in a non-existing page. These issues must be fixed on the client's side before retrying the request.
    • The chart shows a breakdown of the volume of the most frequent client error responses against the selected time interval.
  • 5xx - Server errors
    • Indicates that the server is experiencing errors or is unable to fulfill a valid request. These issues must be fixed on the server's side before retrying the request.
    • The chart shows a breakdown of the volume of the most frequent server error responses against the selected time interval.

API response time

API response time is the total amount of time that it takes for an API to receive a request, process the request, and send a response back to the client. Response time starts as soon as the client initiates the request and ends as soon as the client receives a reponse from the server.

Percentiles are often used when measuring API response time. Percentiles provide a different view of your API performance data. Data is sorted in a descending order and is measured at specific percentage points.

When monitoring API response time, you can see a summary of the following percentiles involving the response times of all HTTP requests being processed by your Forge app:

  • P50 - Median
    • Indicates the value of the response time that's faster or equal to 50% of all API responses.
    • This is the typical performance of your API and is not skewed by extreme values.
  • P95 - 95th percentile
    • Indicates the value of the response time that's faster or equal to 95% of all API responses.
    • If the P95 value is 170 ms, this means that the API response times of 95% of the requests your app receives is less than or equal to 170 ms.
    • This helps give an understanding of what the slowest 5% of users may be experiencing with their response times.
  • P99 - 99th percentile
    • Indicates the value of the response time that's faster or equal to 99% of all API responses.
    • If the P99 value is 170 ms, this means that the API response times of 99% of the requests your app receives is less than or equal to 170 ms.
    • This helps give an understanding of what the slowest 1% of users may be experiencing with their response times.

You can also scan the latency of the 50th percentile, 95th percentile, and 99th percentile response times of HTTP requests in the API response time chart. The data resolution of the chart depends on the time interval you've selected.

Filters

Use these filters to refine your metrics:

  • Environment: Narrows down the metrics for a specific app environment for your app.

  • Date: Narrows down the metrics based on your chosen time interval. Choose from a range of predefined values, such as the Last 24 hours, or choose a more specific time interval using the Custom option.

  • Sites: Narrows down the metrics based on the sites that your app is installed onto, for example, <your-site>.atlassian.net. You can select multiple sites.

  • API source: Narrows down the metrics based on the origin of the APIs being used. Choose from Atlassian product APIs, non-Atlassian APIs, or All APIs.

  • Metrics are only shown for sites with at least one invocation in the past 14 days.
  • All dates are in Coordinated Universal Time (UTC).
  • Each chart's data resolution depends on the time interval you've selected. For example 'Last 24 hours' shows data at a 30-minute resolution, and 'Last hour' shows data at a 1-minute resolution.
  • Metrics may not always be accurate because undelivered metrics data isn’t back-filled and data sampling might be used for some metrics.

You can bookmark the URL on your browser to access metrics based on specific filtering criteria for quick access.

You must use data in accordance with the privacy rights that you've obtained from your user. For more information, see the Atlassian Developer Terms and Forge Terms.

Rate this page: