Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • pending: The evaluation is queued.

  • processing: The evaluation is in progress.

  • completed: The evaluation has finished, and results are available.

Search Evaluations

Endpoint

GET /v1/intent-based-diagnostic/evaluations

Description

Return all Intent Based Evaluations based on filter criteria.

Parameters

Headers:

  • userId (required): The username of the user making the request.

Query Parameters:

  • datetimeRanges (optional): Filter by predefined datetime ranges.

  • datetimeFrom (optional): Filter evaluations created after this datetime.

  • datetimeTo (optional): Filter evaluations created before this datetime.

  • containsInFilename (optional): Filter by filename containing this string.

  • evaluationStatus (optional): Filter by evaluation status.

  • scenarioIds (optional): Filter by scenario IDs.

  • createdOnAsc (optional): Sort by creation date in ascending order (default: false).

  • listAll (optional): List all evaluations (default: false).

  • multicallflowSupport (optional): Enable multicallflow support.

  • page (query, optional): Page number (default: 1).

  • size (query, optional: Page size (default: 50, max: 100).

Response Example

Code Block
{
  "items": [
    {
      "id": "evaluation-uuid",
      "scenario_id": 123,
      "analysis_id": "analysis-uuid",
      "filename": "test.pcap",
      "status": "completed",
      "executed_by": "user123",
      "created_on": "2024-01-01T00:00:00Z",
      "updated_on": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50,
  "pages": 1
}