Datasets

get
Get Dataset(s)

https://api.akk.io/v1/datasets
Get all datasets in your organization, or optionally get a specific dataset
Request
Response
Request
Query Parameters
id
optional
string
(Optional): If dataset ID is included, only the specific dataset is returned
api_key
required
string
Your api key, accessible from https://app.akk.io/team-settings
Response
200: OK
Example response with and without specific IDs
Without id
With ID
Without id
{
"status": "success",
"datasets": [
{
"id": "7pmPB4MXU390Bs0Axxnd",
"name": "Telco-Customer-Churn.csv"
},
{
"id": "83BxRLqOADMfgEPTZI7v",
"name": "Historic Conversions.csv"
},
{
"id": "9eEQ4Rp92y9Z6Cws4Sot",
"name": "titanic-sheet-titanic"
}
]
}
With ID
{
"status": "success",
"name": "titanic-sheet-titanic",
"rows": 887,
"fields": [
{
"type": "category",
"name": "Survived"
},
{
"type": "category",
"name": "Pclass"
},
{
"name": "Name",
"type": "string"
},
{
"name": "Sex",
"type": "category"
},
]
}
404: Not Found
{
"status": "missing or invalid API key"
}

post
Create Dataset

https://api.akk.io/v1/datasets
Creates a dataset with a given name
Request
Response
Request
Body Parameters
name
required
string
The name of the dataset to be created
api_key
required
string
Your API key, accessible from https://app.akk.io/team-settings
Response
200: OK
{
"status": "success",
"dataset_id": "YOUR_DATASET_ID",
"dataset_name": "YOUR_DATASET_NAME"
}

post
Update Dataset Fields

https://api.akk.io/v1/datasets
Add rows to a given dataset
Request
Response
Request
Body Parameters
fields
required
array
An array of field objects. (format for fields: [{'name': 'field name 1', 'type': 'integer'}, {...}, ...]) Valid types are: integer, float, text, category, date, id, unknown
id
required
string
The ID of the dataset
api_key
required
string
Your API key, accessible from https://app.akk.io/team-settings
Response
200: OK
{
"status": "success"
}

post
Add Rows To Dataset

https://api.akk.io/v1/datasets
Request
Response
Request
Body Parameters
rows
required
array
List of rows in form [{'field name 1': 'value 1', 'field name 2': 0}, {...}, ...]
id
required
string
The ID of the dataset to add rows to
api_key
required
string
Your API key, accessible from https://app.akk.io/team-settings
Response
200: OK
{
"status": "success"
}

delete
Delete Dataset

https://api.akk.io/v1/datasets
Deletes a given dataset from a given ID
Request
Response
Request
Body Parameters
api_key
required
string
Your API key, accessible from https://app.akk.io/team-settings
id
required
string
The ID of the dataset
Response
200: OK
{
"status": "success"
}