List Factory Risk Profiles

GET 
/api/v1/analytics/factory-risk-profile

List Factory Risk Profiles

Request

Query Parameters

limit integer

Possible values: >= 1 and <= 100

Default value: 10

Limit result of list

date_type string

Possible values: [process_computed_date]

The type of the filtered date. Case-sensitive.

date_from daterequired

Start date of the query range in yyyy-mm-dd format

offset integer

Default value: 0

date_to daterequired

End date of the query range in yyyy-mm-dd format

Responses

200

OK

application/json

Schema

Schema

data

object[]

nullable

Array [

factoryInformation

object

nullable

Details of the factory

localInformation

object[]

nullable

List of all connected Local Factories

Array [

localOrganizationId stringnullable

Local Custom ID of the Factory

]

organizationId integernullable

The Global organization Id of the Factory

latestProcessComputedDate datenullable

The last activity date of the latest score for eitherFRP score update or risk label/configuration change

latestRiskDate datenullable

Date of the latest Risk Score of the factory

latestRiskLabel stringnullable

Label of the latest Risk Score of the factory

latestRiskScore numbernullable

Latest Risk Score of the factory within the specified time period

latestRiskSetting stringnullable

Setting of the latest Risk Score of the factory

]

limit integerrequired

Possible values: >= 1 and <= 100

offset integerrequired
total integerrequired

Example (from schema)

{
  "data": [
    {
      "factoryInformation": {
        "localInformation": [
          {
            "localOrganizationId": "F323333"
          }
        ],
        "organizationId": 291524
      },
      "latestProcessComputedDate": "2020-07-01",
      "latestRiskDate": "2020-07-01",
      "latestRiskLabel": "low",
      "latestRiskScore": 20.18,
      "latestRiskSetting": "Auto by AI"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...