/
AGILITY API Endpoints

AGILITY API Endpoints

Owned by Charles Abondo
Last updated: Feb 18, 2025 by Albert Khoury Aouad
9 min read

Services

Get service list

Endpoint

GET /cv/api/v1/services

Use this endpoint to fetch a list of supported services.

Parameters

  • page: Specify the page number. (Default: 1)

  • size: Specify the number of results per page. (Default: 50; Maximum: 100)

Example request

curl -X 'GET' \ 'https://cv-dev.b-yond.com/cv/api/v1/services/?page=1&size=50' \ -H 'accept: application/json' \ -H 'Authorization: Bearer YOUR_ID_TOKEN'

Analysis

Start a new analysis

Endpoint

POST /cv/api/v1/analysis/file

This endpoint allows you to initiate an analysis using a supported network trace file.

Request body

  • uploadFile: Upload your network trace file here (the file should be available locally).

  • serviceKeys: (Optional) List of service keys for the analysis. If you're unsure, leave this empty for service auto-discovery.

Example request

curl -X 'POST' \ 'https://cv-dev.b-yond.com/cv/api/v1/analysis/file' \ -H 'accept: application/json' \ -H 'Authorization: Bearer YOUR_ID_TOKEN' \ -H 'Content-Type: multipart/form-data' \ -F 'uploadFile=@myfile.pcap' \ -F 'serviceKeys=volte'

Get analysis results

Endpoint

GET /cv/api/v1/analysis/{analysis_id}/summary

After initiating an analysis, use this endpoint to retrieve the results.

Parameters

  • analysis_id: The ID of the analysis (received from the previous step).

  • page: (Optional) Specify the page number. (Default: 1)

  • size: (Optional) Specify the number of results per page. (Default: 50; Maximum: 1000)

Example request

curl -X 'GET' \ 'https://cv-dev.b-yond.com/cv/api/v1/analysis/8599e936-19ee-4b13-a9ad-44fecadad9fe/summary?page=1&size=50' \ -H 'accept: application/json' \ -H 'Authorization: Bearer YOUR_ID_TOKEN'

Get all analyses

Endpoint

GET /cv/api/v1/analysis

Return all analyses based on the filter criteria

Parameters

  • datetimeFrom: (Optional) Look for analyses created after the given datetime (UTC)
    Format: YYYY-MM-DDTHH:MM:SS.

  • datetimeTo: (Optional) Look for analyses created before the given datetime (UTC)
    Format: YYYY-MM-DDTHH:MM:SS

  • containsInFilePath: (Optional) Specify a given string in the file path.

  • finalStatus: (Optional) Comma separated list of values of final status:

    • SUCCESS: true

    • FAILURE: false

    • WARNING: warning

    • PENDING: pending

    • TIMEOUT: timeout

  • results: (Optional) Look for analyses where at least one its call flow predictions matches the given results. This should be passed as a comma separated list of values:

    • SUCCESS: success

    • FAILURE: failure

    • WARNING: warning

    • UNKNOWN: unknown

  • orderAsc: (Optional) Sort the results by created date in ascending order (Default: false).

  • page: (Optional) Specify the page number. (Default: 1).

  • size: (Optional) Specify the number of results per page. (Default: 50; Maximum: 100).

Example request

Get analysis file

Endpoint

GET /cv/api/v1/analysis/{analysis_id}/file

Return the original file that was used for the analysis.

Parameters

  • analysis_id: The ID of the analysis (received from the previous step).

Example request

 

Webhooks

Webhooks allow you to monitor events on your AGILITY account, enabling your integrations to automatically trigger reactions. Click here for more information.

Register webhooks

Webhook registration endpoint.

Endpoint

POST /cv/api/v1/webhooks

Request body

  • url: The URL of your webhook endpoint.

  • events: A list of events you want to subscribe to. Use ["*"] to subscribe to all events.

  • description: (Optional): A brief description of your webhook.

  • enabled: (Optional): Set to true to enable the webhook immediately.

  • subscribe_to_all_users: (Optional): Set to true to subscribe all users to events.

Example request

Get all subscriptions

Return all webhook subscriptions based on filter criteria.

Endpoint

GET /cv/api/v1/webhooks

Parameters

  • listAll: (Optional) (Default: false)

  • filterEnabled: (Optional) (Default: false)

  • orderAsc: (Optional) Sort the results by created date in ascending order (Default: false).

  • page: (Optional) Specify the page number. (Default: 1).

  • size: (Optional) Specify the number of results per page. (Default: 50; Maximum: 100).

Example request

Get subscription by ID

Get webhook subscription by id

Endpoint

GET/cv/api/v1/webhooks/{subscription_id}

Parameters

  • subscription_id:

Example request

Update subscription

Update webhook subscription.

Endpoint

PUT /cv/api/v1/webhooks/{subscription_id}

Parameters

  • subscription_id:

Example request

Delete subscription

Delete webhook subscription

Endpoint

DELETE/cv/api/v1/webhooks/{subscription_id}

Parameters

  • subscription_id:

Example request

Roll secret subscription

Roll signing secrets

Endpoint

PUT /cv/api/v1/webhooks/{subscription_id}/roll-secret

Parameters

  • subscription_id:

Example request

Check subscription URL

Test webhook URL access.

Endpoint

POST /cv/api/v1/webhooks/{subscription_id}/test

Parameters

  • subscription_id:

Example request

Get webhook failure log

Get failures logs for a given webhook subscription.

Endpoint

GET/cv/api/v1/webhooks/{subscription_id}/failures

Parameters

  • subscription_id:

  • page: (Optional) Specify the page number. (Default: 1).

  • size: (Optional) Specify the number of results per page. (Default: 50; Maximum: 100).

Example request

 

Network Topology

The Network Topology API provides a structured way to access details about the connections between network elements within your environment. It captures information about the source and destination network topology, IPs, Ports, the protocols in use, and the specific interfaces facilitating these connections.

API Endpoint

Endpoint: /api/v1/network/topology

Method: GET

Parameters

  • analysis_id (path parameter): The unique identifier for the analysis. This is a required parameter.

    • Type: string

    • Description: The unique identifier of the network topology analysis to retrieve.

  • callflowKey (query parameter): An optional parameter to filter the results based on a specific call flow key.

    • Type: string

    • Description: A key used to filter the network topology information by a particular call flow.

 

Intent-Based Diagnostics Endpoints

The Intent-Based Diagnostics feature is not enabled by default. It is only available to customers who have purchased this feature.

The Intent-Based Diagnostics feature in AGILITY allows users to perform detailed network diagnostics through various pre-configured scenarios. It enables the evaluation of variety of scenarios defined by 3GPP and ETSI while allowing users to bring their own scenarios

Find Available Scenarios

Endpoint

GET /v1/intent-based-diagnostic/evaluation-scenarios

Description

This endpoint lists all evaluation scenarios, including system scenarios (pre-built by AGILITY) and extended scenarios (user-created by modifying system scenarios).

Parameters

  • name: Filter by scenario name (partial match).

  • category: Filter by scenario category.

  • scenarioType: Filter by type (SYSTEM or EXTENDED). A System Scenario is provided out of the box and cannot be modified. An Extended Scenario is created by users by extending a System Scenario and overriding its parameters.

  • createdByCurrentUser: Filter scenarios created by the current user.

  • editedByCurrentUser: Filter scenarios last edited by the current user.

  • lastModifiedDateFrom: Filter scenarios modified on or after a specific date.

  • lastModifiedDateTo: Filter scenarios modified on or before a specific date.

  • customTestCaseId: Filter scenarios by custom test case ID. It is used to link a given input file automatically to a scenario when using the autoloader. 

  • page: Page number (default: 1).

  • size: Page size (default: 50).

Example Request

Submit a New Evaluation

Endpoint:

POST /v1/intent-based-diagnostic/evaluations/file

Description

This endpoint submits a network trace file for evaluation against a specific scenario.

Request Body

  • Headers:

    • userId (required): The ID of the user submitting the request.

  • Payload:

    • uploadFile: The trace file (.PCAP, .PCAPNG, .CAP, or .ZIP).

    • scenarioId (required): The ID of the scenario to evaluate.

    • parameterValuesOverride (optional): Custom parameters to override scenario defaults.

Example Request

Check Evaluation Status and Retrieve Results

Endpoint:

GET /v1/intent-based-diagnostic/evaluations/{id}

Description

Retrieve the status and results of an evaluation by its ID.

Path Parameters

  • id (required): The evaluation ID returned from the POST /evaluations/file endpoint.

Query Parameters

  • multicallflowSupport: If true, segregates results by callflow sets.

  • userId: the user identifier requesting this operation

Example Request

Response Model

Top-Level Fields

Field

Type

Description

Field

Type

Description

id

string

Unique identifier of the evaluation.

scenario_id

integer

Identifier of the evaluation scenario.

analysis_id

string

Unique identifier of the network analysis related to this evaluation.

filename

string

The name of the uploaded network trace file used in the evaluation.

status

string

The current status of the evaluation.

  • pending: The evaluation is queued.

  • processing: The evaluation is in progress.

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

  • error: The evaluation errored out.

executed_by

string

The user that initiated the evaluation.

parameter_values_override

object

Optional overrides for scenario parameters provided at evaluation time.

results

object

The main evaluation results, including Context Creation Steps (Given) and Assertion Steps (When/Then)

created_on

string (ISO 8601)

Timestamp when the evaluation was created.

updated_on

string (ISO 8601)

Timestamp of the last update to the evaluation.

results Object

Field

Type

Description

Field

Type

Description

name

string

Name of the evaluation scenario.

result

string

Overall result of the evaluation (passed or failed).

context_creation_result

object

Details of the context creation steps.

callflow_sets_results

array

List of AssertionSteps (When/Then) results per callflow set

step_names

array

Ordered list of step names executed in the evaluation.

context_creation_result Object

Field

Type

Description

Field

Type

Description

result

string

Result of the context creation process.

context_creation_steps_results

array

Step-by-step results of context creation.

detected_callflow_sets

array

Callflow sets detected by the context creation steps during the evaluation. These callflow sets are hteo nes that will be asserted on using the Assertion Steps (When/Then)

callflow_sets_results Object

Field

Type

Description

Field

Type

Description

callflow_set

object

The callflow set details including name, analysis_id and callflow_keys.

A callflow set groups AGILITY flows that are evaluated together as one unit.

result

string

Result of the assertion steps for this callflow set. passed or failed or error if the steps failed to compute.

assertion_steps_results

array

Step-by-step results for assertions.

assertion_steps_results Object

Field

Type

Description

Field

Type

Description

name

string

Name of the assertion step.

result

string

Result of the assertion step (passed or failed).

evidences

array

List of evidences supporting the step evaluation.

evidences Object

Field

Type

Description

Field

Type

Description

analysis_id

string

Identifier of the related network analysis.

callflow_keys

array

List of unique keys representing analyzed callflows.

frames

object

Collection of SIP messages related to the assertion step.

frames Object (Within evidences)

Field

Type

Description

Field

Type

Description

frame_number

integer

The frame bumber in the network trace.

message

string

The message itself.

message_type

string

Indicates whether the message is a request or response.

src_ne

string

Source network element.

dst_ne

string

Destination network element.

response_code

string

Response code, if applicable.

response_description

string

Response Description if applicable.

attributes

object

Additional message attributes, that are relevant in the context of the assertion step evidence.

Search Evaluations

Endpoint

GET /v1/intent-based-diagnostic/evaluations

Description

Page-based pagianted endpoint that returns all Intent Based Evaluations based on filter criteria.

Parameters

Headers:

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

Query Parameters:

  • datetimeRanges: Filter by predefined datetime ranges.

  • datetimeFrom: Filter evaluations created after this datetime.

  • datetimeTo: Filter evaluations created before this datetime.

  • containsInFilename: Filter by filename containing this string.

  • evaluationStatus: Filter by evaluation status.

  • scenarioIds: Filter by scenario IDs.

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

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

  • multicallflowSupport: Enable multicallflow support.

  • page: Page number (default: 1).

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

 

Example Request

 

Response Model

The response obtained is an array of Evaluations that match the serach criteria.

Top-Level Fields

Field

Type

Description

Field

Type

Description

items

array

A list of evaluations that meet the specified criteria. For detailed information regarding the schema of each item, please refer to this section.

total

integer

The total count of evaluations that matched the search criteria.

page

integer

The current page number being viewed. This API is designed to support pagination.

size

integer

The requested size of each page.

pages

integer

The total number of pages available, typically calculated as ceil(total / items).

Related content

Use the AGILITY API
Use the AGILITY API
AGILITY Documentation
More like this
How to Add, Edit, or Delete custom_test_case_id for evaluation scenario
How to Add, Edit, or Delete custom_test_case_id for evaluation scenario
AGILITY Documentation
Read with this
Utiliser l'API AGILITY
Utiliser l'API AGILITY
AGILITY - Base de connaissances
More like this
Access your analyses
Access your analyses
AGILITY Documentation
Read with this
Add AGILITY Webhook Integration
Add AGILITY Webhook Integration
AGILITY Documentation
More like this
AGILITY Command Line (CLI) Tool Reference
AGILITY Command Line (CLI) Tool Reference
AGILITY Documentation
Read with this