Conversion Dashboard.

POST

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

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

• F5 Distributed Cloud Console

GET conversion chart data from shape recognize API.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

ConversionRequest

Since and to times to generate the Conversion request.

object

agent

agent

Agent data Required: YES.

string

<= 1024 characters

endTime

endTime

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

string format: int64

<= 1024 characters

tenant

tenant

Tenant data Required: YES.

string

>= 6 characters <= 1024 characters

Example^generated

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

Responses

200

A successful response.

Media typeapplication/json

ConversionResponse

The data of Conversion Response Chart.

object

apiVersion

apiVersion

The actual version of the shape recognize API.

string

<= 1024 characters

data

object

avgDailyConversion

avgDailyConversion

Avarage Daily Conversion.

number format: double

avgMonthlyConversion

avgMonthlyConversion

Avarage Monthly Conversion.

number format: double

itemUnit

itemUnit

The system unit to represent the data.

string

<= 1024 characters

items

items

The collection of data to be filled into the chart.

Array<object>

Conversion Item

Conversion Item that represent the data to chart.

object

OBSOLETE2_date

OBSOLETE2_date

The date of the data to display in chart.

integer format: int32

OBSOLETE_date

OBSOLETE_date

The date of the data to display in chart.

string format: int64

<= 1024 characters

count

count

The quantity data to display.

number format: double

date

date

The date of the data to display in chart.

number format: double

kind

kind

See if the chart is after or before extension.

string

>= 12 characters <= 1024 characters

projectionAnnualConversion

projectionAnnualConversion

Projection Annual Conversion.

number format: double

projectionStartTime

projectionStartTime

Projection Start Time.

number format: double

totalItems

totalItems

Total items to be filled into the chart.

integer format: int32

yearToDateConversion

yearToDateConversion

Year to date conversion.

number format: double

id

id

The ID from the Conversion Response.

string

>= 1 <= 4094 <= 1024 characters

Example^generated

{
  "apiVersion": "example",
  "data": {
    "avgDailyConversion": 1,
    "avgMonthlyConversion": 1,
    "itemUnit": "example",
    "items": [
      {
        "OBSOLETE2_date": 1,
        "OBSOLETE_date": "example",
        "count": 1,
        "date": 1
      }
    ],
    "kind": "example",
    "projectionAnnualConversion": 1,
    "projectionStartTime": 1,
    "totalItems": 1,
    "yearToDateConversion": 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