Explore API Models

Once you generate an API model, there are many ways to explore it. In this guide, we'll show you how to:

Browse your endpoints

Akita lists each endpoint + operation, along with the number of trace events (request/response pairs), and the P99 latency for the events witnessed.

Each row expands to show the fields in the request and responses to this endpoint + operation, as well as the location and properties of the field—was it in the request or response; a header, cookie, body, etc.; and was the data in one or more data formats, like email, date/time, or phone numbers.

For even more details, you can show the OpenAPI3 spec for the endpoint by clicking "Show OpenAPI3 Spec".

Search and filter your endpoints

You can use the search bar to do a keyword search over endpoints (paths). Start typing, and a list of matching endpoints will appear below the search bar. Hit "enter" to search, and you'll see the endpoints update in the table below.

You can quick-filter by host and HTTP method using the filters to the right of the search bar.

Click the filter button on the right for more advanced filters. These filters count the number of endpoints with different properties, like the kind of authentication header present (if any), data formats present in the endpoint's requests/responses, response codes, and so on. Use the filters to drill down into your API. For example, you can use the "none" authentication filter to see all endpoints that do not use an authentication header.

You can also search for fields within an endpoint, which filters endpoints to only show those with matching fields.

Save and share

Filters and search terms are reflected in the URL, so you will see the same filters and searches if you bookmark or copy and paste the URL. Members of your Akita team (see Managing Teams) can access any URLs you send them.

Export OpenAPI3

You can download an OpenAPI3 specification from your API model using the "Download OpenAPI3" link at the top of the filters dropdown.


Did this page help you?