Get dataset statistics

GET 
/v2/datasets/:datasetId/statistics

Returns statistics for given dataset.

Provides only field statistics.

Request

Path Parameters

datasetId string required
Dataset ID or username~dataset-name.

Example: WkzbQMuFYuamGv3YF

Status 200

{
  "data": {
    "fieldStatistics": {
      "name": {
        "nullCount": 122
      },
      "price": {
        "min": 59,
        "max": 89
      }
    }
  }
}

Schema

• data object required

  • fieldStatistics object,null

    When you configure the dataset fields schema, we measure the statistics such as min, max, nullCount and emptyCount for each field. This property provides statistics for each field from dataset fields schema.
    
    See dataset field statistics documentation for more information.

    • property name* DatasetFieldStatistics

      • min number | null nullable

        Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object.

      • max number | null nullable

        Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object.

      • nullCount integer | null nullable

        How many items in the dataset have a null value for this field.

      • emptyCount integer | null nullable

        How many items in the dataset are undefined, meaning that for example empty string is not considered empty.

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)