Friction Aggregation Dashboard.

POST

/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_aggregation

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_aggregation \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "endTime": "example", "itemUnit": "example", "startTime": "example" }'

• F5 Distributed Cloud Console

GET Friction Aggregation chart data from shape recognize API.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

Friction Aggregation Request

Since and to times to generate the Friction Aggregation Request.

object

endTime

endTime

The time to we want the channel data Required: YES.

string format: int64

<= 1024 characters

itemUnit

itemUnit

The unit where the data is represented.

string

<= 1024 characters

startTime

startTime

The time since we want the channel data Required: YES.

string format: int64

<= 1024 characters

Example^generated

{
  "endTime": "example",
  "itemUnit": "example",
  "startTime": "example"
}

Responses

200

A successful response.

Media typeapplication/json

Fricction Aggregation Response

The data of Friction Aggregation Response Chart.

object

apiVersion

ApiVersion

The actual version of the shape recognize API.

string

<= 1024 characters

data

object

finalSuccessTotal

finalSuccessTotal

FinalSuccessTotal.

number format: double

firstSuccessTotal

firstSuccessTotal

FirstSuccessTotal.

number format: double

itemUnit

itemUnit

Item Unit

string

<= 1024 characters

noSuccessTotal

noSuccessTotal

NoSuccessTotal.

number format: double

spareables

spareables

Spareables.

Array<object>

Friction Aggregation Item

Friction Aggregation Spareable Item data to fill the chart.

object

finalSuccess

finalSuccess

FinalSuccess.

number format: double

firstSuccess

firstSuccess

FirstSuccess.

number format: double

noSuccess

noSuccess

NoSuccess

number format: double

upperBound

upperBound

UpperBound.

number format: double

totalItems

totalItems

TotalItems.

number format: double

id

Id

The ID from the Lift Response.

string

>= 1 <= 4094 <= 1024 characters

Example^generated

{
  "apiVersion": "example",
  "data": {
    "finalSuccessTotal": 1,
    "firstSuccessTotal": 1,
    "itemUnit": "example",
    "noSuccessTotal": 1,
    "spareables": [
      {
        "finalSuccess": 1,
        "firstSuccess": 1,
        "noSuccess": 1,
        "upperBound": 1
      }
    ],
    "totalItems": 1
  },
  "id": "example"
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example