API Explorer: /schedules/history

To return a list of test schedules, an accountId, a projectId, a workspaceId, a collectionId, a testId, OR a scheduleId is required. The sample code returns a list for schedule history for a testId of 1234567. Use the actual ID values for the project, workspace, collection, test, or schedule to return the history of your schedules.

You can return a schedule history specifying either a projectId, a workspaceId, a collectionId, a testId, or any combination of the workspace, project, and either testId or collectionId or scheduleId. The returned list contains the schedule history of the test runs that meet the parameters provided.

List Schedule History Parameters

Parameters

• workspaceId integer

  required

  The workspaceId you want to use to get the test schedule history

• accountId integer

  required

  The accountId you want to use to get the test schedule history

• projectId integer

  required

  The projectId you want to use to get the test schedule history

• testId integer

  required

  The testId you want to use to get the list of test schedule history

• collectionId integer

  required

  The collectionId you want to use to get the test schedule history

• scheduleId integer

  required

  The scheduleId you want to use to get the test schedule history

• fromDate integer

  The timestamp from where to start the test schedule history

• toDate integer

  The timestamp at which to end the test schedule history

Also see: Pagination and Sorting

curl 'https://a.blazemeter.com/api/v4/schedules/history?testId=1234567' \
    --user 'api_key_id:api_key_secret'

List Schedule History Response Attributes

Attributes

• idstring

  The historyId for the test run history

• runAtinteger

  The timestamp when the schedule ran

• successboolean

  Denotes if the test ran or not

• namestring

  The name of the test that was run

• scheduleIdstring

  The scheduleId for the created schedule

• scheduleTypestring

  Type of schedule

• scheduleCronExpressionstring

  The cron schedule used for the test

• projectIdinteger

  The projectId of the project

• workspaceIdinteger

  The workspaceId of the workspace for the test

• accountIdinteger

  The accountId of the account

• testIdinteger

  The testId of the test

• testCollectionIdinteger

  The collectionId of the multi test

• masterIdinteger

  The masterId of the master

• createdinteger

  The timestamp when the master was created

• updatedinteger

  The timestamp when the master was updated

{
    "limit": 10,
    "skip": 0,
    "total": 1,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": "5c83f8919fee716a488b4567",
            "runAt": 1552152723,
            "success": true,
            "name": "My New Test",
            "scheduleId": "5c83f8840bd290041e05351d",
            "scheduleType": "testRun",
            "scheduleCronExpression": "32 17 * * 6",
            "projectId": 123456,
            "workspaceId": 123429,
            "accountId": 123456,
            "testId": 1234567,
            "masterId": 12345678,
            "created": 1552152721,
            "updated": 1552152723
        }
    ]
}