Maeris logo
Get started for free

API Test Results and Analysis

Learn how to interpret and analyze API test results in Maeris to understand test execution, identify issues, and improve your API tests.

Overview

After running your API tests, Maeris provides detailed results that show request/response details, assertion outcomes, performance metrics, and execution history. Understanding these results is crucial for maintaining reliable API tests.

Test Execution Results

Result Status

  • Passed: All assertions passed and request completed successfully
  • Failed: One or more assertions failed or request returned unexpected status
  • Error: Request failed to execute (network error, timeout, etc.)
  • Skipped: Request was skipped due to conditional logic or previous failures

Request and Response Details

Each test result includes comprehensive information about the request that was sent and the response that was received.

Request Information

  • HTTP method and URL
  • Request headers
  • Request body (if applicable)
  • Query parameters
  • Environment variables used

Response Information

  • HTTP status code
  • Response headers
  • Response body (formatted JSON, XML, etc.)
  • Response size
  • Response time

Assertion Results

View detailed results for each assertion, including which ones passed, which ones failed, and why they failed.

Assertion Details

  • Assertion Name: Description of what was being validated
  • Status: Passed or Failed
  • Expected Value: What the assertion expected
  • Actual Value: What was actually received
  • Error Message: Detailed error message for failed assertions

Performance Metrics

Performance metrics help you understand how your APIs are performing and identify potential bottlenecks.

Key Metrics

  • Response Time: Total time taken for the request to complete
  • Connection Time: Time to establish connection
  • DNS Lookup Time: Time for DNS resolution
  • Time to First Byte: Time until first byte received
  • Total Time: End-to-end request time

Analyzing Results

Interpreting Failed Tests

  1. Check Status Code: Verify if the API returned the expected status code

    Unexpected status codes often indicate API changes or errors

  2. Review Failed Assertions: Look at which assertions failed and why

    Compare expected vs actual values to understand the issue

  3. Examine Response Body: Check the actual response to see what was returned

    Response might have changed structure or values

  4. Check Request Details: Verify that the request was sent correctly

    Ensure headers, body, and parameters are correct

  5. Review Error Messages: Read error messages for clues about what went wrong

Test History and Trends

Maeris maintains a history of test executions, allowing you to track changes over time and identify trends.

History Features

  • View past test runs and their results
  • Compare results across different runs
  • Track performance trends over time
  • Identify when tests started failing
  • See changes in response times

Exporting and Sharing Results

Export test results to share with team members, include in reports, or archive for future reference.

  • Export results as JSON, CSV, or HTML
  • Share results with team members
  • Include results in CI/CD reports
  • Archive results for compliance

Best Practices

  • Review Results Regularly: Check test results frequently to catch issues early
  • Investigate Failures Promptly: Don't ignore failing tests—investigate and fix them
  • Monitor Performance Trends: Watch for gradual performance degradation
  • Use History: Compare current results with historical data
  • Document Issues: Add notes to results explaining failures or anomalies
  • Set Up Alerts: Configure notifications for test failures
  • Share Insights: Share important findings with your team

Next Steps