Documentation

Overview Test groups allow you to control global variables like "global" headers, schedules, endpoint base url etc. of all of your endpoints, at once.
It also let's you organize your endpoint's working queue and variable value transfer from endpoint-to-endpoint.

You can think test groups as base of the endpoint tests.
Creating test groups Creating a test group is really easy. Just go to your dashboard and click the "Create New Test Group" button at the top. Once you click the button, the system will automatically create a new test group named "new test group" and redirect you to edit page of that test group. There you can edit your group details.

Note that some of the packages contain test group limits and your Organization's test group usage shouldn't be exceeded its limit in order to create a new test group.
Group details Group details are the base settings of a group. They affect every single endpoint that group contains. The three main group details are explained below.

  • Group Name: Group name is custom. You can name your group anything you like, it's just for making your groups identifiable.
  • Group Base URL: Base URL is the common part of your endpoint's URLs. All of the endpoint tests you will create on this group will use this base URL and add their name to it. For example, your base URL can be "https://apispotter.com/api/v9/" and your "login" endpoint will add its name to end of it, as "http://apispotter.com/api/v9/login".
  • Group Schedule: You can select the running schedule of this group here. It determinates how often your test group will run all of its endpoints.
Group headers Group headers are the headers sent with every request of endpoints that marked to include group headers. You can create a header in an endpoint test individually (we call them "local headers"), but if you need a header that needs to be included in multiple endpoints, you can create a group header and mark your endpoints to include group headers.

Note that local headers you create on an endpoint will overwrite any group header with the same key.
Group schedules Group schedules determinate how often your endpoints will run and be reported. Your options might change depending on your organization's package. At every scheduled turn, all of your endpoints run as you queued them, and the reports will be created. If anything goes wrong while running a scheduled task, ApiSpotter lets you know, of course.

Currently available schedule types:
  • Daily: Your endpoints run every day at 00:00
  • 12 Hours: Your endpoints run twice a day.
  • 6 Hours: Your endpoints run every six hours.
  • 1 Hour: Your endpoints run at the start of every hour.
  • 30 Minutes: Your endpoints run every thirty minutes in a day.
  • 1 Minute: Your endpoints run every single minute of a day.

* Dates given in UTC time.

*Schedules only available on paid packages. They cannot be used on any expired plan.
*Your organization must not exceed its request limit in order to run schedules.
*Trial plan contains schedules.