Profiling

Execute

API endpoint: /api/v1/profiling/execute
Type: POST
Description: Executes profiling objects and returns results
Parameters: objects
Example body:

{
  "objects": [
    {
      "object": "rfam.family",
      "connection": "rfam_public"
    },
    {
      "object": "rfam.version",
      "connection": "rfam_public"
    }
  ]
}

Result

[
  {
    "connectionName": "Rfam_public",
    "schemaName": "Rfam",
    "objectName": "family",
    "lastExecuted": "2022-01-21 10:48:39",
    "nextExecution": "2022-01-22 10:00:00",
    "schedule": "Daily / 10:00",
    "filter": "author is not null",
    "allowedErrors": 0,
    "columns": [
      {
        "columnName": "author",
        "dataType": "tinytext",
        "rules": [
          {
            "ruleDescription": "Count of NULLs",
            "lastResult": "0",
            "previousResult": "0",
            "status": "ok",
            "lastExecuted": "2022-01-21 10:48:35",
            "threshold": 0.0
          },
          {
            "ruleDescription": "Count of unique values",
            "lastResult": "140",
            "previousResult": "140",
            "status": "ok",
            "lastExecuted": "2022-01-21 10:48:38",
            "threshold": 5.0
          }
        ],
        "values": [
          {
            "columnValue": "Griffiths-Jones SR",
            "valueCount": 1301,
            "status": "ok"
          },
          {
            "columnValue": "Eberhardt R",
            "valueCount": 513,
            "status": "ok"
          }
        ]
      }
    ]
  }
]

Objects

API endpoint: /api/v1/profiling/objects
Type: POST
Description: Returns profiling object results
Parameters: objects
Example body:

{
  "objects": [
    {
      "object": "rfam.family",
      "connection": "rfam_public"
    },
    {
      "object": "rfam.version",
      "connection": "rfam_public"
    }
  ]
}

Result

[
  {
    "connectionName": "Rfam_public",
    "schemaName": "Rfam",
    "objectName": "family",
    "lastExecuted": "2022-01-21 10:48:39",
    "nextExecution": "2022-01-22 10:00:00",
    "schedule": "Daily / 10:00",
    "filter": "author is not null",
    "allowedErrors": 0,
    "columns": [
      {
        "columnName": "author",
        "dataType": "tinytext",
        "rules": [
          {
            "ruleDescription": "Count of NULLs",
            "lastResult": "0",
            "previousResult": "0",
            "status": "ok",
            "lastExecuted": "2022-01-21 10:48:35",
            "threshold": 0.0
          },
          {
            "ruleDescription": "Count of unique values",
            "lastResult": "140",
            "previousResult": "140",
            "status": "ok",
            "lastExecuted": "2022-01-21 10:48:38",
            "threshold": 5.0
          }
        ],
        "values": [
          {
            "columnValue": "Griffiths-Jones SR",
            "valueCount": 1301,
            "status": "ok"
          },
          {
            "columnValue": "Eberhardt R",
            "valueCount": 513,
            "status": "ok"
          }
        ]
      }
    ]
  }
]

Last modified: 22 July 2024