Documentation | Datasets › List Datasets

Datasets

datasets

Methods

Create Dataset ->

Dataset

post/v5/datasets

Create Dataset

List Datasets -> CursorPage<

Dataset

get/v5/datasets

List Datasets

query Parameters

ending_before: string

Optional

include_archived: boolean

Optional

limit: number

Optional

(maximum: 10000, minimum: 1, default: 100)

name: string

Optional

sort_by: string

Optional

sort_order:

Optional

(default: "asc")

"asc"

"desc"

starting_after: string

Optional

tags: Array<string>

Optional

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

Dataset

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

curl https://api.egp.scale.com/v5/datasets \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "current_version_num": 0,
      "name": "name",
      "tags": [
        "string"
      ],
      "archived_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "object": "dataset"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Delete Dataset -> { id, deleted, object }

delete/v5/datasets/{dataset_id}

Delete Dataset

Update Or Restore Dataset ->

Dataset

patch/v5/datasets/{dataset_id}

Update or Restore Dataset

Get Dataset ->

Dataset

get/v5/datasets/{dataset_id}

Get Dataset

Domain types

Dataset = { id, created_at, created_by, 6 more... }