View & Replay API Traffic
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
- Drill down to a specific endpoint's request success and error trends
- Manage the evolution of your APIs
- Add and Manage API Metadata
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.
View API Endpoint Metrics
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
View Request Logs
To start capturing your API request and responses in the Request Viewer make sure to integrate the appropriate Speakeasy SDKdocs into your API server. Once your API is streaming API request and response to Speakeasy they will show up in the Request Viewer.
Once API Request and Response data is streaming in they'll be available under the
Requests tab on the left nav. This will take you to the Request Viewer home page. The Request viewer will show new requests as they come in real time. By default 30 days of historical data is accessible on demand.
Click on a request to see the complete Request Body and headers and Responses for each Request. Export requests by their OpenAPI schema or into a Postman Collection.
You can also use our easy point and click filters to drill down by Customer, Labels, Request Api Endpoint, Status and more. Save these filters for future use.
Clicking on the Replay Request button will open a Dialog where you can modify the details of the request you want to replay.
From the Replay Request Dialog you can modify the request before replaying it in various ways:
- Modify the URL of the request, either redirecting it to a new server, or correcting a URL that was captured incorrectly due to proxying or other reasons or just sending it to another endpoint.
- Modify/Add or Remove any Query Parameters to the request.
- Modify/Add or Remove any Headers to the request.
- Modify/Add or Remove a Request body on the request.
Copy as CURL
In the Request Replay dialog there is also a Button to Copy as CURL that will allow you to copy a CURL command with the defined parameters for your request and run this from your favorite Posix terminal.
Download Postman Collection
Clicking on the Download Postman Collection option in the context menu will download a Postman Collection .json file that you can import into your Postman workspace to send requests from Postman to replay your request.