API Dashboard
Overview
The API Dashboard is the Speakeasy platform homepage and your aggregated view of all the APIs currently being managed by Speakeasy. Each row represents an API, which is a top level resource (e.g. Orders, Transactions, Users etc.) grouping the individual endpoints (which can have many methods and operations) that you are serving to your customers. The Dashboard gives you an overview of the the aggregated number of request, and error rate for the resources endpoints.
From the API dashboard, you are able to navigate to endpoint-specific stats, request logs, and other features.
How can you use the API Dashboard?
- Track traffic in the dashboard
- View API Metrics
- Add and Manage API Metadata
- Manage the evolution of your APIs
View Aggregated Request Metrics
Track your API traffic
After you have integrated the Speakeasy SDK into your services, the Dashboard will start showing APIs and API Endpoints that have been detected from the incoming traffic from your SDK integration. The name, version, and customer key of the API shown are the values you provided when configuring your SDK integration.
View API Metrics
The homepage. This gives you a quick overview of your APIs key metrics: availability, number of requests, changes in traffic volume, and error rates. Organize your APIs as they grow by adding simple key value metadata.
A detailed overview of all the API endpoints managed under a single API Version. Navigate to the request viewer and other features for each endpoint.
Add and Manage API Metadata
Click on the icon next to any API to add a simple key value metadata pair to help manage your API. These metadata labels can be used to programmatically filter through API Endpoints using our Speakeasy API. Some examples where labels are useful:
- Setting availability labels: LIVE, DEPRECATED, MIGRATED
- Managing service discovery by clients that are accessing your different API versions.
Upload Existing OpenAPI Schema
The API dashboard can be used for tracking incoming traffic against your API's existing OpenAPI 3.0.x Schema. The Speakeasy platform will try to associate any incoming traffic from an API with a Schema that has been uploaded to the API dashboard.
The schema can be uploaded before or after you start tracking traffic with the SDK.
If uploaded before you will upload the Schema using the ApiID and Version you intended to configure in the SDK for any incoming traffic. Once uploaded you will then see the API and API Endpoints present in your schema but no metrics will be visible until the SDK starts sending traffic for the same ApiID and Version.
If uploaded after traffic is already being received from the SDK you will select a pre-existing ApiID and Version to upload a schema for and then the Speakeasy dashboard will associate your Schema with any pre-existing API Endpoints that have already been received.
Associating a Schema with your traffic can help with detecting drift between your deployed code and your OpenAPI schema which may be the source of truth for your documentation. Read more about how Speakeasy can help you keep track of this drift.