Apidog Docs
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Automated tests
  • Apidog Support Center
  • Import/Export
    • How to import API data into Apidog?
    • How to import cURL in Apidog?
    • How to migrate Postman environments to Apidog?
  • Sending requests
    • Does Apidog support Socket.IO?
    • Why is the "+" in the parameter value decoded as a space?
    • How to send a request in Apidog?
    • How to send a graphQL request in Apidog?
    • How to send a gRPC request in Apidog?
    • How to send a SOAP/WebService request in Apidog?
    • How to send a WebSocket request in Apidog?
    • Does Apidog support pre-request/test scripts and assertions in WebSocket APIs?
    • How to send a SSE request in Apidog?
    • How to add default headers at the folder level?
    • Does Apidog support pre-request/test scripts and assertions in gRPC APIs?
    • Why am I getting a "socket hang up" error when sending a request?
    • ELANREFUSED.DNS Resolver Error
  • Designing APIs
    • How do I use variables in the path?
    • Can I use a response component as the default response?
    • How to check who has modified an endpoint?
    • How can I bulk delete endpoint folders in Apidog?
    • How can I bulk add/remove prefixes to the path of endpoints?
    • How to move a Property's level in the Schema Editor?
    • If a string property has multiple enumerated values and is used in various locations, how can this enum be consistently referenced throughout?
    • How to get Apidog resource folder ID?
    • How do I get the resource floder ID of Apidog?
    • How do I use variables in a URL path?
    • What should I do if an endpoint, document, or test scenario is accidentally deleted?
    • Does Apidog support request code for custom endpoints?
  • Debugging APIs
    • How does Apidog integrate with third-party key management systems?
    • Why does the same request work correctly in other tools (such as Postman) but not in Apidog?
    • How to fetch variable values from database in Apidog?
    • How to migrate environments from other tools to Apidog?
    • How to assert using scripts in Apidog?
    • JSONPath can only extract arrays. How can we extract a single element from within them in Apidog?
    • How to configure database operations in Apidog when different environments have different database account credentials?
    • How to get service base URL in custom script?
    • Why does Apidog report an error exceeding the maximum Node.js string length when the API response is too large?
    • What is the size limit for console printing?Why do I get an error when printing large files?
    • How to resolve DB2 database connection errors on Windows?
    • How to Generate Dynamic Values in Apidog Custom Scripts?
    • Why does the client request for the same endpoint succeed, but an error occurs when debugging on the web side: "Unable to request address"?
    • Why does Apidog report an error when the response is too large?
    • How do I use the Apidog recording endpoint?
    • When defining an endpoint response, is it allowed for the endpoint to have no response content?
    • How do I get the service baseURL in a custom script?
    • How do I view the original packet in Apidog?
    • How do I make an asynchronous request in an Apidog script?
    • What is the console print size limit? Why Do I Get an Error When I Print a Large File?
    • How do I upload a file on an endpoint request?
    • What to Do If Apidog crashes or Response Data Isn’t Showing ?
  • Mock API data
    • How to mock APIs automatically?
    • What can Apidog mocking do?
    • How to mock fixed API data in Apidog?
    • How to mock conditional data in Apidog?
    • How to enable cloud mock in Apidog?
    • How to enable self-hosted mock in Apidog?
    • Does Apidog support mocking WebSocket APIs?
    • Why Is the Browser Not Returning Content When Requesting the Mock endpoint?
  • Automated tests
    • Why do test scenarios run without issues on my local client, but errors occur when running them in the Apidog CLI or runner?
    • How to create a test scenario in Apidog?
    • How to pass data between test steps?
    • Why am I not able to successfully reference pre-step data?
    • How to use foreach loop in Apidog?
    • What are the differences between sync data from endpoints/endpoint cases?
    • How to use test data in Apidog?
    • How to retrive test data in scripts in Apidog?
    • How to run test scenarios in batch in Apidog?
    • How to schedule test tasks in Apidog?
    • How to run performance test in Apidog?
    • How can I view the actual requests and responses in the performance tests?
    • How can I export performance test reports in Apidog?
    • How to use database query results as parameters for looping API requests?
    • Capture and Validate Stripe Webhooks in ApiDog During CI/CD
    • How to resolve the "Error: unable to verify the first certificate on runner" error?
    • General Runner Docker Container "Not Found" Error.
    • How to Set the Server Host for the General Runner in Apidog Web Version?
    • Why Scheduled test scenario endedup with 0 request?
    • What should I do if the file upload parameter cannot be found in Runner or CLI?
    • How to use Runner to run a test scenario with an upload file step?
    • How do I resolve the "Error: unable to verify the first certificate on runner" error?
    • How do I access and search the runner logs to identify the issue when a problem arises with a runner?
    • What should I do if the endpoint parameter is an upload file and cannot be found in Runner or CLI?
    • Why Aren't Test Steps Automatically Synchronized When the API Use Case Changes?
    • Why Does Using Multiple Dollar Signs in a Markdown Document Cause Some Content to Not Display Correctly?
  • Publish API Docs
    • How to hide all Apidog logos in published documents?
    • When the API spec is updated, will the API doc change?
    • How to share APIs to collaborators in Apidog?
    • How to customize domain of Apidog documentations?
    • How to create multi-version documentation in Apidog?
    • Scope of sharing for Publish Docs Sites in Apidog
    • Scope of sharing for Share Doc list in Apidog
  • Markdown
    • How to use cards to link to various pages or endpoints within Apidog?
    • Why is some content not displayed correctly when using multiple $ symbols in Markdown documents?
    • How to use transparent background images in Apidog Markdown?
    • How to set the column width of a Markdown table?
    • How do I add a link to a document or endpoint within a project in an Apidog card component?
  • Branches
    • How to access the sprint branch?
  • Administration
    • How to install Apidog client silently?
    • Why am I seeing a 'No Permission' error despite having admin access?
    • How do I check the runner version number?
    • Does Apidog support win7?
    • Why does Apidog show the error "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" after installation?
  • Billing
  • Account & preferences
  • Apidog Europe
  1. Automated tests

How to run performance test in Apidog?

The performance testing feature is currently in Beta. If you met any problems, please join the Technical Support Discord and provide your feedback.
Performance testing involves sending large-scale service requests to an API to identify performance bottlenecks, assess stability, expose potential risks under pressure, and ensure the API can operate reliably and respond to requests under high load.
Performance Testing

Set configuration items#

Before running a performance test, you need to specify the runtime environment and optionally test data for the test scenario, as well as configure the performance test settings.

Runtime environment#

The runtime environment in the test scenario inherits from the current project's environments.

Test data#

After associating test data, virtual users will use the variables defined in the test data to execute requests. You can choose to run in either "Random Match" or "Sequential Match" mode:
Random Match: Each virtual user randomly selects a row of data from the test data to run. In this mode, all virtual users will select one test data row and execute the performance test.
Sequential Match: Each virtual user selects a row of data from the test data in order. Note: If the number of virtual users exceeds the number of test data rows, the excess virtual users will not start the performance test.

Learn more about test data.

Virtual users (Concurrent users)#

Supports up to 100 virtual users. Within the specified test time, it simulates online users running the test scenario in parallel repeatedly.

Test duration#

The total runtime of the performance test. During this period, each virtual user will continuously loop through all APIs in the test scenario.

Ramp-up duration#

Users typically access a service gradually over time, rather than instantly. To simulate this, set a ramp-up time to gradually increase the number of parallel users over the first X minutes (X is the preset value). If X is set to 0, all virtual users start immediately at the beginning of the test.

Running the performance test#

After triggering the performance test, an intuitive visualization panel will display key metrics such as Total Requests, Avg Throughput, Avg Response Time, Maximum/Minimum Response Time, and Errors for each API.
Performance Test Visualization
Only one performance test can be run for a project at a time. If a higher-priority test needs to be conducted, click the "Terminate" button in the top right corner.

Viewing the test process#

During the performance test, you can hover over the test chart to view the test details for each time period in real-time.
Test Details
Click "Error" to check failed requests for the API and analyze possible causes. You can also filter API requests in the filter bar.
Error Analysis
Due to the large volume of API requests in a performance test, only failed requests are categorized and displayed statistically. Detailed error information and request details for each API are not recorded. If you encounter unexpected errors, run a "Functional Test" first and resolve all issues before running a "Performance Test."

Viewing test reports#

Click the "Test Reports" tab to view historical test reports for the current test scenario.
Test Reports

FAQ#

Q: How can I export performance test reports?
A: Performance testing is currently in the beta stage, and Apidog does not yet support exporting performance test reports. You can only view the results within the Apidog client.
Q: How can I view the actual requests and responses in the performance tests?
A: Apidog's performance testing does not provide the ability to view the actual requests and responses.
This is because performance testing focuses on evaluating the API's behavior under high load, and these APIs should have already 100% passed functional testing. Any issues are likely caused by server performance, not the request/response content.
Therefore, viewing the actual requests and responses would not help troubleshoot performance-related problems. Therefore, the performance testing feature in Apidog does not provide the functionality to view the actual requests and responses.
Modified at 2024-11-20 11:53:50
Previous
How to schedule test tasks in Apidog?
Next
How can I view the actual requests and responses in the performance tests?
Built with