Datasets

Datasets are project-scoped collections of episodes. Each dataset has an editable working version you can add to, remove from, commit, discard, or restore from an earlier committed version.

All recordings in a dataset must be imported to the same Primary Site.

Datasets are in beta today. Contact us for early access.

Operations

Create a dataset

Request

Create a new dataset in the specified project, optionally pre-populated with an initial set of episodes.

Security

ApiKey(Required scopes: datasets.create)

Bodyapplication/jsonrequired

projectIdstring, non-emptyrequired

ID of the project the dataset belongs to.

namestring, [ 1 .. 100 ] charactersrequired

Display name. Must be unique within the project (case-insensitive) among datasets.

descriptionstring or null, [ 1 .. 500 ] characters

Optional display description.

episodeIdsArray of strings, <= 2000 items(EpisodeIdList)

Optional initial set of episodes to add to the dataset.

Payload

{
  "projectId": "string",
  "name": "string",
  "description": "string",
  "episodeIds": [
    "string"
  ]
}

Responses

The created dataset

Bodyapplication/json

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.

addedintegerrequired

Number of episodes inserted.

updatedintegerrequired

Number of episodes whose selected version changed in the dataset's draft.

removedintegerrequired

Number of episodes removed from the dataset's draft.

alreadyPresentintegerrequired

Number of episodes in the add request that were not inserted because an equivalent episode was already in the dataset, or appeared in the same request.

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,
  "added": 0,
  "updated": 0,
  "removed": 0,
  "alreadyPresent": 0
}