...

You will learn how to integrate and use the AGILITY API to analyze network traces with ease.

Prerequisites

Please ensure that you have the necessary credentials and permissions to access the API (login ID and password) from your administrator.

Overview

The AGILITY API is designed for system integrators and developers to enable advanced analysis on network traces, specializing in root cause analysis for call flows. The API supports file formats such as .PCAP, .PCAPNG, .CAP, and .ZIP.

API base URL

Use the base URL to access the OpenAPI documentation:

...

(example: https://cv-dev.b-yond.com/cv/api/public/docs ).

Authentication

Use the OAuth2 Password Flow to request an id_token.

Request the token

Endpoint

POST /cv/auth/realms/agility/protocol/openid-connect/token

Provide your username, password, and the client_id (which is public and provided as d0d8b0d806f9) in your request.

Headers

• Content-Type: application/x-www-form-urlencoded

Body

• grant_type: password

• client_id: d0d8b0d806f9

• username: Your registered user name.

• password: Your password.

• scope: openid

Example cURL request

curl -X POST https://cv-dev.b-yond.com/cv/auth/realms/agility/protocol/openid-connect/token \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=password&client_id=d0d8b0d806f9&username=YOUR_USERNAME&password=YOUR_PASSWORD&scope=openid"

Replace YOUR_USERNAME and YOUR_PASSWORD with your credentials.

Response

Upon successful authentication, you'll receive a JSON response containing the id_token among other tokens.

...

Handling expired tokens

When an access token expires, AGILITY API will no longer accept incoming request and will redirect you to the login page. We recommend that you request a new id_token using the refresh token request if it still valid or just re-authenticate.

...

AGILITY API endpoints

Retrieve supported services

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'

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'

Fetch 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'

...