Sweep Testing

Create sweep test configurations for parameter variation testing. Run sweeps across different input combinations.

9 endpoints

POST/testing/sweeps

Create a new sweep test configuration for testing parameter variations.

Body Parameters

Name	Type	Required	Description
name	string	required	Display name for the sweep
configId	string	required	Test configuration ID to use as the base flow
parameters	Record<string, string[]>	required	Parameter variations to sweep across. Each key is a parameter name, each value is an array of options to test.
└ {paramName}	string[]	required	Array of values to test for this parameter (e.g. "dtmfOptions": ["1","2","3"])

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"DTMF Sweep","configId":"cfg_abc123","parameters":{"dtmfOptions":["1","2","3","4","5"]}}' \
  https://api.nopaque.co.uk/testing/sweeps

Response

json

{
  "id": "sweep_abc123",
  "name": "DTMF Sweep",
  "configId": "cfg_abc123",
  "status": "created",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

GET/testing/sweeps

List all sweep test configurations in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweeps

Response

json

{
  "sweeps": [
    {
      "id": "sweep_abc123",
      "name": "DTMF Sweep",
      "status": "created",
      "createdAt": "2026-04-10T12: 00: 00Z"
    }
  ]
}

GET/testing/sweeps/{id}

Get a specific sweep test configuration by ID.

Path Parameters

Name	Type	Required	Description
id	string	required	Sweep ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweeps/sweep_abc123

Response

json

{
  "id": "sweep_abc123",
  "name": "DTMF Sweep",
  "configId": "cfg_abc123",
  "parameters": {
    "dtmfOptions": [
      "1",
      "2",
      "3",
      "4",
      "5"
    ]
  },
  "status": "created",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

PUT/testing/sweeps/{id}

Update a sweep test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Sweep ID

Body Parameters

Name	Type	Required	Description
name	string	optional	Updated display name
parameters	Record<string, string[]>	optional	Updated parameter variations. Each key is a parameter name, each value is an array of options to test.
└ {paramName}	string[]	required	Array of values to test for this parameter

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Extended DTMF Sweep"}' \
  https://api.nopaque.co.uk/testing/sweeps/sweep_abc123

Response

json

{
  "id": "sweep_abc123",
  "name": "Extended DTMF Sweep",
  "updatedAt": "2026-04-10T12: 10: 00Z"
}

DELETE/testing/sweeps/{id}

Delete a sweep test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Sweep ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweeps/sweep_abc123

Response

json

{
  "message": "Sweep deleted successfully"
}

POST/testing/sweeps/{id}/run

Start a sweep test run. Executes the test flow with each parameter variation.

Path Parameters

Name	Type	Required	Description
id	string	required	Sweep ID

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweeps/sweep_abc123/run

Response

json

{
  "id": "srun_def456",
  "sweepId": "sweep_abc123",
  "status": "running",
  "startedAt": "2026-04-10T12: 15: 00Z"
}

GET/testing/sweeps/{id}/runs

List all runs for a specific sweep test.

Path Parameters

Name	Type	Required	Description
id	string	required	Sweep ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweeps/sweep_abc123/runs

Response

json

{
  "runs": [
    {
      "id": "srun_def456",
      "status": "completed",
      "variations": 5,
      "passRate": 1
    }
  ]
}

GET/testing/sweep-runs

List all sweep runs across all sweeps in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweep-runs

Response

json

{
  "runs": [
    {
      "id": "srun_def456",
      "sweepId": "sweep_abc123",
      "status": "completed",
      "variations": 5
    }
  ]
}

GET/testing/sweep-runs/{id}

Get a specific sweep run by ID with full results per variation.

Path Parameters

Name	Type	Required	Description
id	string	required	Sweep run ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/sweep-runs/srun_def456

Response

json

{
  "id": "srun_def456",
  "sweepId": "sweep_abc123",
  "status": "completed",
  "results": [
    {
      "variation": {
        "dtmfOption": "1"
      },
      "result": "pass"
    },
    {
      "variation": {
        "dtmfOption": "2"
      },
      "result": "pass"
    }
  ],
  "completedAt": "2026-04-10T12: 20: 00Z"
}