Specifications overview

Created:
May 9, 2023
Updated:
October 31, 2023

Specifications can be used to group information for an API. Creating a specification on the platform allows you to view the inventory data. Learn how to Create a specification.

You can view specifications that you have uploaded in the APIs or Applications tab in the platform.

From the APIs tab:

1. Navigate to APIs in the FireTail platform.

2. Select the API you created the specification against.

3. Click the Specifications tab. All uploaded specifications for this API are displayed.

4. Click the specification you want to view.

From the Applications tab:

1. Navigate to the Applications tab on the FireTail platform

2. Select the application that contains the relevant API.

3. Select the API you created the specification against.

4. Click the Specifications tab. All the uploaded specifications for this API are displayed.

5. Select the specification you want to view.

Specifications information

The Overview tab displays the app and the API the specification data belongs to. 

Filters

You can add filters by using the menu on the left. This menu contains the list of the request methods in the specification and are grouped under their relevant folders. Click on a request to add that request as a filter. Click on it again to clear your selection if needed.

Add additional filters to the request by clicking Add filter group.

You can also add additional filter groups:

  1. Click Add filter group.
  2. Select the required element from the Type dropdown.
  3. Choose the appropriate Operator.
  4. Enter a Value.
  5. Click Submit.

To add any further conditions to this filter, click Add condition.

Edit filters

You can edit a condition within a filter, to do this:

  1. Click the condition you want to edit.
  2. Make changes to the Type, Operator and Value as required.
  3. Click Submit.

To delete a filter or condition, click the corresponding bin icon.

Filter by date

Filter information by a date range or a selected timeframe.

  • Last hour
  • Last day
  • Last month
  • Last 3 months

You can select Custom and enter a Start date and an End date to filter by.

The Polling interval indicates how often the page data reloads from the API, in minutes. Select the polling interval from the dropdown.

Graph

The graph displays the number of API requests for that app within the selected time period and reflects any other filters you have applied.

Requests table

The requests table lists the incoming requests and their details. Any filters you have applied are reflected in the table.  You can also filter the requests table by Status and Method. Click the filter icon and select how you want to filter. Click OK to apply. You can sort the table by Date created and Execution time. To sort by ascending, click the up arrow icon, to sort by descending, click the down arrow icon.

To expand on individual requests, go to the Action heading, and click View details. More information about the request including the response and request body is displayed.

Details

Navigate to the Details tab to view more information about the request method, such as the path parameters and any possible responses. Select the required request method on the left menu to view its specification.