Lift Dashboard.

POST

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

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/lift \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "endTime": "example", "itemUnit": "example", "startTime": "example" }'

• F5 Distributed Cloud Console

GET lift chart data from shape recognize API.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

Lift Request

Since and to times to generate the Lift Request.

object

endTime

endTime

The time to we want the lift 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 lift data Required: YES.

string format: int64

<= 1024 characters

Example^generated

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

Responses

200

A successful response.

Media typeapplication/json

LiftResponse

The data of Lift Response Chart.

object

apiVersion

ApiVersion

The actual version of the shape recognize API.

string

<= 1024 characters

data

object

avgAbsoluteLift

avgAbsoluteLift

Avarage Absolute Lift.

number format: double

avgRelativeLift

avgRelativeLift

Avarage Relative Lift.

number format: double

itemUnit

itemUnit

Item Unit

string

<= 1024 characters

items

items

Items in a collection or array

Array<object>

Lift Item

Lift Item that represent the data to chart.

object

OBSOLETE2_date

OBSOLETE2_date

Configuration parameter for OBSOLETE2 date

integer format: int32

OBSOLETE_date

OBSOLETE_date

Configuration parameter for OBSOLETE date

string format: int64

<= 1024 characters

absolute

object

control

control

Control data.

number format: double

extended

extended

Extended data.

number format: double

date

date

Configuration parameter for date

number format: double

relative

object

control

control

Control data.

number format: double

extended

extended

Extended data.

number format: double

totalItems

totalItems

Total Items.

integer format: int32

id

Id

The ID from the Lift Response.

string

>= 1 <= 4094 <= 1024 characters

Example^generated

{
  "apiVersion": "example",
  "data": {
    "avgAbsoluteLift": 1,
    "avgRelativeLift": 1,
    "itemUnit": "example",
    "items": [
      {
        "OBSOLETE2_date": 1,
        "OBSOLETE_date": "example",
        "absolute": {
          "control": 1,
          "extended": 1
        },
        "date": 1,
        "relative": {
          "control": 1,
          "extended": 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