Collections overview

May 9, 2023
May 15, 2023

Collections can be used to group information for an API. Creating a collection on the platform allows you to view the inventory data.

Navigate to the Collections tab on the FireTail platform to view all the collections that you have created for that organisation. Learn how to Create a collection. Select the collection you want to view.

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


You can add filters by using the menu on the left. This menu contains the list of the request methods in the collection 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.

You can also add additional filters:

  1. Click Add Filters.
  2. Select the required element from the Field dropdown.
  3. Choose the appropriate Operator.
  4. Enter a Value.
  5. Click Save.

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 Field, Operator and Value as required.
  3. Click Save.

To delete a condition from a filter:

  1. Click the condition you want to delete
  2. Click Delete.

To delete a filter, click the bin icon next to the filter.

Filter by date

Filter information by a date range or a selected timeframe. Enter a Start date and an End date, or select from the following:

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


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. 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 More Details. More information about the request including the response and request body is displayed.


Navigate to the Specification 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.