Follow

Get Details

Description

This API enables you to retrieve details regarding all tests included in a Multi Test and a list of previous runs for that Multi Test. This function includes parameters to identify both the user and the Multi Test.

API v4

URL

https://a.blazemeter.com/api/v4/collections/collectionID

Request Parameters

Parameter Description
Api Key Identifies the user ( --user 'id:secret' ).
How to get the API Key?
Collection ID Identifies the Multi test. How to get the Test ID?

cURL

curl -X get https://a.blazemeter.com/api/v4/collections/collectionsID -H "Content-Type: application/json" --user 'id:secret'

Python

import requests

def collectionDetails(collection_id):
	return requests.get('https://a.blazemeter.com/api/v4/collections/{0}'.format(collection_id), auth=('id','secret')) 

res
= collectionDetails(<collectionID>)
print res.json()

Example Response

Parameter Description
id The unique identifier of a specific session of a Multi test.
name The verbal identifier of the Multi Test
userID The unique identifier of the user
created The time the Multi Test was started at
updated The time the Multi Test was last updated at
Items Details and Configurations of all the tests included in the Mutli Test
masters Array of all the Multi Test's sessions previously ran
{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 100006536,
        "name": "Multi no.1",
        "collectionType": "multi",
        "userId": 639273,
        "items": [
            {
                "location": "us-east-1",
                "concurrency": 40,
                "override": {
                    "rampup": 300,
                    "iterations": -1,
                    "duration": 20,
                    "threads": null
                },
                "testId": 50537836,
                "serversCount": null,
                "configuration": {
                    "dedicatedIpsEnabled": false
                },
                "test": {
                    "id": 50537836,
                    "name": "Test no. 2",
                    "draftId": "td_2015_04_20_17_30_15_639273_4611",
                    "userId": 639273,
                    "created": 1429540247,
                    "updated": 1432818012,
                    "configuration": {
                        "location": "us-east-1",
                        "type": "jmeter",
                        "concurrency": 40,
                        "dedicatedIpsEnabled": false,
                        "plugins": {
                            "splitCSV": {
                                "enabled": false
                            },
                            "reportEmail": {
                                "enabled": false
                            },
                            "jmeter": {
                                "filename": "DummyTest.jmx",
                                "version": "2.11blazemeter",
                                "override": {
                                    "rampup": 300,
                                    "iterations": -1,
                                    "duration": 20
                                }
                            }
                        }
                    }
                }
            },
            {
                "location": "us-east-1",
                "concurrency": 40,
                "override": {
                    "rampup": 300,
                    "iterations": -1,
                    "duration": 20,
                    "threads": null
                },
                "testId": 50684140,
                "serversCount": null,
                "configuration": {
                    "dedicatedIpsEnabled": false
                },
                "test": {
                    "id": 50684140,
                    "name": "New Name3",
                    "draftId": "td_2015_04_20_17_30_15_639273_4611",
                    "userId": 639273,
                    "created": 1432818095,
                    "updated": 1433250283,
                    "configuration": {
                        "location": "lon1",
                        "type": "jmeter",
                        "concurrency": 10,
                        "dedicatedIpsEnabled": false,
                        "plugins": {
                            "splitCSV": {
                                "enabled": "false"
                            },
                            "reportEmail": {
                                "enabled": false
                            },
                            "jmeter": {
                                "filename": "DummyTest.jmx",
                                "version": "2.11blazemeter",
                                "override": {
                                    "rampup": 150,
                                    "iterations": -1,
                                    "duration": 20
                                }
                            }
                        }
                    }
                }
            }
        ],
        "created": 1432224129,
        "updated": 1432818170,
        "note": null,
        "projectId": null,
        "masters": [
            {
                "id": 15073237,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432224407,
                "created": 1432224135,
                "updated": 1432224407
            },
            {
                "id": 15073240,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432224865,
                "created": 1432224441,
                "updated": 1432224865
            },
            {
                "id": 15073248,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432226005,
                "created": 1432225172,
                "updated": 1432226005
            },
            {
                "id": 15076164,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432818697,
                "created": 1432818184,
                "updated": 1432818697
            },
            {
                "id": 15076181,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432820180,
                "created": 1432819957,
                "updated": 1432820180
            }
        ]
    }
}

 

API v2

 

URL

https://a.blazemeter.com:443/api/latest/collections/collectionID/full

Request Parameters

Parameter Description
Api Key Identifies the user ( --user 'id:secret' ). How to get the API Key?
Collection ID Identifies the Multi test. How to get the Test ID?

cURL

curl -X get https://a.blazemeter.com:443/api/latest/collections/collectionsID/full -H "Content-Type: application/json" --user 'id:secret'

Python

import requests

def collectionDetails(collection_id):
	return requests.get('https://a.blazemeter.com/api/latest/collections/{0}/full'.format(collection_id), headers={"x-api-key": "65f7f52eb362c4ec2e31"})

users = { user:'id:secret'
}

res = collectionDetails(<collectionID>) print res.json()

Example Response

Parameter Description
id The unique identifier of a specific session of a Multi test.
name The verbal identifier of the Multi Test
userID The unique identifier of the user
created The time the Multi Test was started at
updated The time the Multi Test was last updated at
Items Details and Configurations of all the tests included in the Mutli Test
masters Array of all the Multi Test's sessions previously ran
{
    "api_version": 2,
    "error": null,
    "result": {
        "id": 100006536,
        "name": "Multi no.1",
        "collectionType": "multi",
        "userId": 639273,
        "items": [
            {
                "location": "us-east-1",
                "concurrency": 40,
                "override": {
                    "rampup": 300,
                    "iterations": -1,
                    "duration": 20,
                    "threads": null
                },
                "testId": 50537836,
                "serversCount": null,
                "configuration": {
                    "dedicatedIpsEnabled": false
                },
                "test": {
                    "id": 50537836,
                    "name": "Test no. 2",
                    "draftId": "td_2015_04_20_17_30_15_639273_4611",
                    "userId": 639273,
                    "created": 1429540247,
                    "updated": 1432818012,
                    "configuration": {
                        "location": "us-east-1",
                        "type": "jmeter",
                        "concurrency": 40,
                        "dedicatedIpsEnabled": false,
                        "plugins": {
                            "splitCSV": {
                                "enabled": false
                            },
                            "reportEmail": {
                                "enabled": false
                            },
                            "jmeter": {
                                "filename": "DummyTest.jmx",
                                "version": "2.11blazemeter",
                                "override": {
                                    "rampup": 300,
                                    "iterations": -1,
                                    "duration": 20
                                }
                            }
                        }
                    }
                }
            },
            {
                "location": "us-east-1",
                "concurrency": 40,
                "override": {
                    "rampup": 300,
                    "iterations": -1,
                    "duration": 20,
                    "threads": null
                },
                "testId": 50684140,
                "serversCount": null,
                "configuration": {
                    "dedicatedIpsEnabled": false
                },
                "test": {
                    "id": 50684140,
                    "name": "New Name3",
                    "draftId": "td_2015_04_20_17_30_15_639273_4611",
                    "userId": 639273,
                    "created": 1432818095,
                    "updated": 1433250283,
                    "configuration": {
                        "location": "lon1",
                        "type": "jmeter",
                        "concurrency": 10,
                        "dedicatedIpsEnabled": false,
                        "plugins": {
                            "splitCSV": {
                                "enabled": "false"
                            },
                            "reportEmail": {
                                "enabled": false
                            },
                            "jmeter": {
                                "filename": "DummyTest.jmx",
                                "version": "2.11blazemeter",
                                "override": {
                                    "rampup": 150,
                                    "iterations": -1,
                                    "duration": 20
                                }
                            }
                        }
                    }
                }
            }
        ],
        "created": 1432224129,
        "updated": 1432818170,
        "note": null,
        "projectId": null,
        "masters": [
            {
                "id": 15073237,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432224407,
                "created": 1432224135,
                "updated": 1432224407
            },
            {
                "id": 15073240,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432224865,
                "created": 1432224441,
                "updated": 1432224865
            },
            {
                "id": 15073248,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432226005,
                "created": 1432225172,
                "updated": 1432226005
            },
            {
                "id": 15076164,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432818697,
                "created": 1432818184,
                "updated": 1432818697
            },
            {
                "id": 15076181,
                "name": "Multi no.1",
                "userId": 639273,
                "ended": 1432820180,
                "created": 1432819957,
                "updated": 1432820180
            }
        ]
    }
}
Have more questions? Submit a request

0 Comments

Article is closed for comments.