Pagination

Control the pagination of returned results using the skip and limit parameters.

  • Use skip to set the first item to return. For example, to start on the eleventh item, set skip=10

  • Use limit to set the maximum number of items returned. For example, to limit the number of items returned to 20 items, set limit=20

The sample code sets pagination for items with a projectId of 123456. Use the actual ID values of the project or workspace to update their pagination.

To set pagination, a projectId or a workspaceId is required. You can also set pagination specifying both a projectId and a workspaceId. This can also be combined with the sorting option to organize the results further.

Setting Pagination through Tests 

curl 'https://a.blazemeter.com/api/v4/tests?projectId=123456&skip=10&limit=2' \
      -H 'Content-Type: application/json' \
      --user 'api_key_id:api_key_secret'

Response200 OK 

{
    "limit": 2,
    "skip": 10,
    "total": 450,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": 1234567,
            "name": "Test 2",
            "isNewTest": true,
            "userId": 123456,
            "created": 1550767182,
            "updated": 1550767182,
            "creatorClientId": "gui",
            "overrideExecutions": [
                {
                    "concurrency": 20,
                    "executor": "",
                    "holdFor": "19m",
                    "locations": {
                        "us-east-1": 20
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "rampUp": "1m",
                    "steps": 0
                }
            ],
            "executions": [
                {
                    "concurrency": 20,
                    "holdFor": "19m",
                    "rampUp": "1m",
                    "steps": 0,
                    "locations": {
                        "us-east-1": 20
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "scenario": "default-scenario"
                }
            ],
            "shouldSendReportEmail": false,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "taurus",
                "executionType": "taurusCloud",
                "threads": 500,
                "testMode": "",
                "plugins": {
                    "jmeter": {
                        "version": "auto"
                    },
                    "thresholds": {
                        "thresholds": [],
                        "ignoreRampup": false,
                        "slidingWindow": false
                    }
                }
            }
        },
        {
            "id": 2345678,
            "name": "My Test",
            "isNewTest": true,
            "userId": 123456,
            "lastRunTime": 1550710526,
            "created": 1550702524,
            "updated": 1550714475,
            "creatorClientId": "gui",
            "overrideExecutions": [
                {
                    "concurrency": 60000,
                    "executor": "jmeter",
                    "holdFor": "30m",
                    "locations": {
                        "us-east-1": 60000
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "rampUp": "30m",
                    "steps": 0
                }
            ],
            "executions": [
                {
                    "concurrency": 60000,
                    "holdFor": "30m",
                    "rampUp": "30m",
                    "steps": 0,
                    "locations": {
                        "us-east-1": 60000
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "executor": "jmeter",
                    "scenario": "default-scenario-6630973"
                }
            ],
            "shouldSendReportEmail": false,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "taurus",
                "canControlRampup": false,
                "targetThreads": 300,
                "executionType": "taurusCloud",
                "scriptType": "jmeter",
                "threads": 300,
                "filename": "Dummy.jmx",
                "testMode": "",
                "plugins": {
                    "jmeter": {
                        "version": "auto"
                    },
                    "thresholds": {
                        "thresholds": [],
                        "ignoreRampup": false,
                        "slidingWindow": false
                    }
                }
            }
        }
    ]
}