RIriveterhq
Dataset CRUD

summarize columns

Changed on

Per-column counts over every row of the dataset, without the rows: for an output column, its cells by state (pending, stale, failed, not_found, ok, manual; a fill in flight shows on GET /datasets/{id} runs, its cells still count under the state they hold) and its most common values; for an input column, the rows with a value and its most common values. values holds the top_values most common (default 20, max 100) as { value, count }; distinct_values and filled count every value. A string value longer than 200 characters is cut in values. columns picks the columns; absent, every column is summarized. Built with one aggregate query per column, so a 10,000-row dataset answers in well under a second.

get/datasets/{id}/summary

Request

Path parameters

idstring required

The dataset id (ds_...)

Query parameters

columnsstring

Column names, comma-separated (input or output columns; Company,CEO). Only those columns are answered. Absent: every column. An unknown name is a 400 that lists the dataset's columns.

top_valuesinteger

How many of a column's most common values to list

Response

The summary

row_countinteger

Example response

{
  "row_count": 1000,
  "columns": [
    {
      "name": "Company",
      "kind": "input",
      "filled": 1000,
      "distinct_values": 1000,
      "values": [
        {
          "value": "Apple",
          "count": 1
        },
        {
          "value": "Stripe",
          "count": 1
        }
      ]
    },
    {
      "name": "Phone type",
      "kind": "output",
      "states": {
        "pending": 12,
        "stale": 0,
        "failed": 3,
        "not_found": 185,
        "ok": 800,
        "manual": 0
      },
      "filled": 800,
      "distinct_values": 2,
      "values": [
        {
          "value": "Mobile",
          "count": 610
        },
        {
          "value": "Direct dial",
          "count": 190
        }
      ]
    }
  ]
}

Changes

  • fac56b649559Revision changes
    • info

      api tag Dataset CRUD added

    • info

      api tag Datasets removed

  • dcb4d45ade1aRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status