Skip to main content
Loading...

API docs by

List datasets

Request

List datasets.

Security
ApiKey(Required scopes: datasets.list)
Query
projectIdstring, non-empty

Filter datasets by project.

namestring, non-empty

Filter datasets to those whose name contains this value, ignoring case.

sortBystring

Field to sort datasets by. Defaults to createdAt.

Default:"createdAt"
Enum:"name""createdAt""updatedAt""episodeCount"
sortOrderstring

Sort order for the sortBy field

Enum:"asc""desc"
limitnumber, [ 0 .. 2000 ]

Maximum number of items to return

Default:2000
offsetinteger, >= 0deprecated

Number of items to skip before returning the results. Deprecated; use cursor instead. When offset is omitted or zero, results use cursor pagination and limit defaults to 2000. A limit of 0 returns no results or continuation cursor. A nonzero offset uses legacy offset pagination and does not return a cursor header. Do not combine a nonzero offset with cursor.

Default:0
cursorstring

Opaque cursor from the fg-pagination-next-cursor or, where supported, fg-pagination-previous-cursor response header.

Payload
// No request payload

Responses

List of datasets

Headers
fg-pagination-next-cursorstring

Opaque cursor to supply as cursor on the next request when more results are available.

fg-pagination-previous-cursorstring

Opaque cursor to supply as cursor to retrieve the previous page in the same display order.

Bodyapplication/json
Array [
idstringrequired

ID of the dataset.

projectIdstringrequired

ID of the project the dataset belongs to.

namestringrequired

Display name.

descriptionstring or null

Optional display description.

creatorOrgMemberIdstring or null

ID of the org member who created the dataset. Null when the dataset was created via API-key auth (in which case creatorApiKeyId is set).

creatorApiKeyIdstring or null

ID of the API key that created the dataset. Null when the dataset was created via session auth (in which case creatorOrgMemberId is set).

createdAtstring, (date-time)required

Timestamp when the dataset was created.

updatedAtstring, (date-time)required

Timestamp when the dataset was last updated.

episodeCountinteger, >= 0

Number of episodes in this dataset.

]
Response
[
  {
    "id": "string",
    "projectId": "string",
    "name": "string",
    "description": "string",
    "creatorOrgMemberId": "string",
    "creatorApiKeyId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "episodeCount": 0
  }
]