Flattened records of one dataset (export shape)
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/datasets/{dataset} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/datasets/{dataset}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/datasets/{dataset}"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"dataset": "<string>",
"columns": [
"<string>"
],
"rows": [
{
"_id": "<string>",
"_received_at": "2023-11-07T05:31:56Z",
"_source": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Datasets
Flattened records of one dataset (export shape)
Top-level alias: GET /admin/api/datasets/. An unknown-but-valid dataset name returns 200 with empty rows, not 404. Readable by any role.
GET
/
admin
/
api
/
projects
/
{pid}
/
datasets
/
{dataset}
Flattened records of one dataset (export shape)
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/datasets/{dataset} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/datasets/{dataset}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/datasets/{dataset}"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"dataset": "<string>",
"columns": [
"<string>"
],
"rows": [
{
"_id": "<string>",
"_received_at": "2023-11-07T05:31:56Z",
"_source": "<string>"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Path Parameters
Project id (UUID) belonging to the caller workspace.
Dataset name; must match ^[a-z][a-z0-9_]{0,62}$ (case-insensitive).
Pattern:
^[A-Za-z][A-Za-z0-9_]{0,62}$Response
Up to 1000 newest records, payload JSON flattened into rows with the meta columns _id, _received_at and _source prepended. columns is the union of meta columns and every payload key seen. A non-object payload becomes a single value key.