Skip to main content

Sample History

Sample History automatically saves test responses so you can revisit them later. This feature enables offline configuration, comparison between responses, and recovery from accidental data loss.

Overview

Every successful (2xx) endpoint test automatically saves a sample containing:

  • Response data (the JSON body)
  • Status code
  • Response time
  • Timestamp
  • Test type (single, full collection, or iterate)
  • Pagination info (if applicable)

Stopped tests (user-interrupted) are also saved to history as partial results with success: false, allowing you to inspect whatever data was collected before stopping.

Viewing Sample History

Location

Sample History opens as a popout from the endpoint test panel:

  1. Select an endpoint in the tree
  2. Click the History (clock) tool at the bottom of the test panel
  3. The history popout opens anchored to the bottom-right of the screen

Sample List

Each sample shows:

  • Timestamp: When the test ran (relative time like "2m ago")
  • Status indicator: Green/red bar showing success/failure
  • Type badge: Single or Full (collection)
  • Size: Response size in bytes/KB/MB
  • Pagination info: Pages and items (for full collection)

Using Samples

Activating a Sample

Click any sample to make it active:

  • Response data loads into the JSON viewer
  • Dependency mappings can extract from this data
  • Useful for configuring endpoints without live API access

The active sample shows a blue checkmark badge.

Comparing Samples

Switch between samples to compare:

  • Different response structures over time
  • Before/after API changes
  • Full vs partial collection results

Deleting Samples

Hover over a sample and click the trash icon:

  • Removes from history
  • Cannot be undone
  • If active sample is deleted, no sample is selected

Sample Storage

Limits

  • Maximum 10 samples per endpoint
  • Oldest samples are removed when limit is reached
  • Samples persist across browser sessions

Persistence

Samples are stored:

  1. In browser localStorage (immediate)
  2. On the server via API (for sharing/persistence)

When you return to a connector, samples are loaded from the server.

Test Types in History

Single Test

Standard endpoint test:

  • One request
  • Up to 3 pages of pagination
  • Tagged as "Single" in history

Full Collection

Complete data collection:

  • Runs until pagination stop condition
  • Collects all pages
  • Tagged as "Full" in history
  • Shows pages/items collected

Iterate Test

Tests endpoint for each value in an array:

  • Runs multiple requests
  • Combines responses into array
  • Tagged as "Full" (treated like full collection)
  • Shows iteration count

Stopped Tests

When a user clicks Stop during a streaming test:

  • Partial results are preserved and saved
  • Tagged with success: false in history
  • Still viewable and usable for dependency mapping

Sample Data vs Live Data

Active Sample Indicator

When viewing sample data instead of live response:

  • Banner shows "Using sample data for dependency mapping"
  • JSON viewer shows the sample content
  • Mappings extract from this cached data

When Samples Are Used

  • After activating from history
  • When loading a connector with saved samples
  • When paste sample feature is used

Live Data Priority

When you run a new test:

  • Live response replaces current view
  • New sample is saved to history
  • Previous samples remain accessible

Workflows

Offline Configuration

  1. Test endpoint while online (sample saved)
  2. Work offline later
  3. Activate sample from history
  4. Configure dependencies using cached data
  5. Test live when back online

Debugging Response Changes

  1. Notice endpoint behavior changed
  2. Compare current sample to older ones
  3. Identify what data changed
  4. Adjust mappings if needed

Preserving Good Test Data

  1. Get a good test response
  2. Sample auto-saves
  3. Later tests might return different data
  4. Reactivate original sample if needed

Sample Metadata

Each sample includes metadata viewable on hover or in detail view:

FieldDescription
TimestampWhen test was run
Status CodeHTTP response code
Response TimeRequest duration in ms
Response SizeSize in bytes
Test Typesingle, full, or iterate
Pages CollectedFor paginated responses
Items CollectedTotal items across pages
Stopped ByWhy pagination/iteration stopped

Stopped By Values

ValueMeaning
stop_conditionPagination stop condition was met (e.g., cursor empty, boolean flag)
errorAn error occurred during collection
user_stoppedUser clicked Stop during a streaming test
max_pagesSafety limit of maximum pages was reached

Best Practices

Save Before Major Changes

Before modifying:

  • Note which sample is active
  • Good samples are preserved in history
  • Can restore if new config doesn't work

Clear Old Samples

Periodically remove outdated samples:

  • Reduces clutter
  • Ensures you're using current data
  • Frees up storage

Use Full Collection Samples

For dependency mapping:

  • Full collection samples have more data
  • Better for testing iterate mode
  • More representative of production

Troubleshooting

"Sample won't load"

  1. Sample data might be corrupted
  2. Delete and re-run test
  3. Check browser storage isn't full

"Old sample doesn't match current API"

API structure changed since sample was captured:

  1. Run new test to get current structure
  2. Or keep old sample for comparison

"Samples not persisting"

  1. Check localStorage isn't disabled
  2. Verify API connectivity for server persistence
  3. Browser might be in private mode