Retrieve a list of datasets

GET 
https://api.pharia.example.com/v1/studio/data/repositories/:repositoryID/datasets

Lists all datasets within a specified repository, with options to filter by creation date and labels. Use this endpoint to browse datasets and locate relevant data collections by repository.

Request

Path Parameters

repositoryID stringrequired

The unique identifier of the repository containing the datasets.

Query Parameters

created_after string

Filters datasets created after the specified date (in ISO 8601 format).

created_before string

Filters datasets created before the specified date (in ISO 8601 format).

label string[]

Filters datasets by one or more labels. Use this to narrow down results to datasets tagged with specific labels.

page integer

The page number to retrieve, used for paginated responses.

size integer

The number of items to include per page in the response.

Responses

200

OK

application/json

Schema

Schema

datasets object[]
A list of files retrieved for the current page.
Array [
datasetIdstring
Unique identifier for the dataset.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
repositoryIdstring
Unique identifier of the repository to which this dataset belongs.
Example: cb26237c-3beb-40f3-8e13-77d862f722b5
namestring
The name assigned to the dataset for easy identification.
Example: dataset_name
labelsstring[]
List of labels associated with the dataset for categorization or tagging.
Example: ["label"]
metadatastring
Additional metadata for the dataset in a key-value format.
Example: {"key":"value"}
licensestring
The license of the uploaded dataset defines the permissions, restrictions, and obligations governing its use.
Example: {"id":"OAL-1.0","url":"https://github.com/Aleph-Alpha/.github/blob/main/oal.pdf"}
versionstring
The current version of the dataset, allowing version tracking.
Example: 55a62ef9-dd9c-4e5d-9b93-0361bae4db37
totalDatapointsinteger
The total number of data points within the dataset.
Example: 0
updatedAtstring
The timestamp of the last update made to the dataset in ISO 8601 format.
Example: 2024-07-04
createdAtstring
The timestamp when the dataset was initially created in ISO 8601 format.
Example: 2024-07-04
]
pageinteger
The current page number in the paginated list.
Example: 0
sizeinteger
The number of datasets displayed per page.
Example: 1
totalinteger
The total number of datasets available.
Example: 1

Example (auto)

{
  "datasets": [
    {
      "datasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "repositoryId": "cb26237c-3beb-40f3-8e13-77d862f722b5",
      "name": "dataset_name",
      "labels": [
        "label"
      ],
      "metadata": {
        "key": "value"
      },
      "license": {
        "id": "OAL-1.0",
        "url": "https://github.com/Aleph-Alpha/.github/blob/main/oal.pdf"
      },
      "version": "55a62ef9-dd9c-4e5d-9b93-0361bae4db37",
      "totalDatapoints": 0,
      "updatedAt": "2024-07-04",
      "createdAt": "2024-07-04"
    }
  ],
  "page": 0,
  "size": 1,
  "total": 1
}

400

Bad Request

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

401

Unauthorized

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

404

Not Found

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

500

INTERNAL SERVER ERROR

application/json

Schema

Schema

messagestring
Example: A descriptive error message based on the specific status code encountered, detailing the issue and possible causes.

Example (auto)

{
  "message": "A descriptive error message based on the specific status code encountered, detailing the issue and possible causes."
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.pharia.example.com/v1/studio/data/repositories/:repositoryID/datasets");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.pharia.example.com/v1/studio/data

Parameters

repositoryID — pathrequired

created_after — query

created_before — query

label — query

page — query

size — query

ResponseClear

Click the Send API Request button above and see the response here!