Collections

PruTAN helps you organize your API requests with collections. You can create collections and add requests to them to share with your team or reuse later. You can also export PruTAN collections and import collections from PruTAN, OpenAPI, cURL, and Postman.

You can access collections by clicking the "Collections" icon on the side panel's Collection submenu.

Creating a New Collection

To create a new collection, click on the "Add new" button in the collections section and enter the name of the collection. You can also create a sub-collection by clicking on the "Add new" button on the desired collection and entering the name of the sub-collection.

Duplicating a Collection

Create a copy of an existing collection to modify or test different configurations without affecting the original.

1. Click on the collection you want to duplicate.
2. Click on the three-dot menu in the collection's options.
3. Select "Duplicate" from the dropdown menu. A new collection with the suffix "- Duplicate" will be created.

Saving Requests to Collections

To add a new request to your collection, click on the "Save" button on the request page and select the collection you want to add it to. Click on the dropdown menu next to the save button and select "Save as" to save the request to a new location.

Organizing Collections

To edit a collection, click on the "Edit" button in the collection's three-dot menu.

To add a request to a collection, click on the "New request" button in the collection's options to save the current request to the collection.

Deleting Collections

To delete a collection, click on the "Delete" button in the collection's options.

Importing and Exporting Collections

You can import and export collections from PruTAN, OpenAPI, Postman, and other formats.

To import a collection, click on the "Import" button in the collections section and select the collection type you want to import.

To export a collection, click on the "Export" button in the collection's options and select the format you want to export.

Permissions

If the collection is being created in Hostbox or Interceptor, it also requires permissions that are set by the Workspace owner in the profile's section under the Team tab.

Suite Execution

To execute all requests within an API collection, PruTAN offers a suite execution feature. This is particularly useful for scenarios where requests need to execute in sequence as part of a workflow.

Steps to execute a suite and view suite analytics:

1. Click on the collection's three-dot menu.
2. Click on Run Collection and select/deselect scripts before clicking the Run button.
3. Click on the View Analytics button, which will redirect to the Suite Analytics page.

Generating Reports

Suite Analytics can generate two types of downloadable reports: PDF Report and Excel Report.

• PDF Report: A printable, formatted summary of the suite run including pass/fail summary, and key metrics.
• Excel Report: A compact spreadsheet organized into three sheets: Suite name, Detailed Request History, and Pass Fail Summary.
  • Suite name: Run metadata and high-level summary (Region, environment, duration etc.).
  • Detailed Request History: Each request rows with detailed exceution data.
  • Pass Fail Summary: Aggregated counts and charts for quick visualization.

Steps to generate a report:

1. Open Suite Analytics for the completed suite run.
2. Navigate to Generate Report button.
3. Click the Export (or Generate Report) menu/button.
4. Choose PDF Report or Excel Report.
5. The file will be prepared and downloaded automatically.