Databoard API docs

Get started using our API in <5 minutes.

Users

/api/user/edit

an endpoint to get user profile information.

['POST']

POST method

curl -d '{"first_name": "Slim", "last_name": "Jim", "bio": "a sad lonely piece of beef jerky.", "alias": "slimjim", "github_url": "", "status": "private"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}' {{session['base_url']}}/api/user/edit -k

successful response, 200

error response, 400

/api/user/read

an endpoint to get user profile information.

['POST']

POST method

curl -d '{}' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}' {{session['base_url']}}/api/user/read -k

successful response, 200

error response, 400

Organizations

/api/organization/create

an endpoint to create organizations.

['POST']

POST method

curl -d '{"org_name": "Databoard", "description": "a community of data engineers and architects.", "size": "30 employees", "status": "public", "license_type": "Databoard Standard License"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}' {{session['base_url']}}/api/organization/create -k

successful response, 201

error response, 400

/api/organization/delete

an endpoint to delete organizations.

['POST']

POST method

curl -d '{}' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/organization/delete -k

successful response, 201

error response, 400

/api/organization/edit

an endpoint to edit organization profile information.

['POST']

POST method

curl -d '{"organization_name": "new name", "organization_description": "description", "organization_status": "private", "organization_size": "30 employees", "organization_default_license": "Apache 2.0 license"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/organization/edit -k

successful response, 200

error response, 400

/api/organization/read

an endpoint to get organization profile information.

['POST']

POST method

curl -d '{}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/organization/read -k

successful response, 200

error response, 400

/api/organization/user/edit

an endpoint to edit user roles in organizations.

['POST']

POST method

curl -d '{"user_id": "{{session['user_id']}}", "new_role": "general"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/organization/user/edit -k

successful response, 201

error response, 400

/api/organization/user/join

an endpoint to request to join an organization.

['POST']

POST method

curl -d '{"organization_id": "{{session['organization_id']}}"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}' {{session['base_url']}}/api/organization/user/join -k

successful response, 201

error response, 400

/api/organization/user/remove

an endpoint to remove users from organizations.

['POST']

POST method

curl -d '{"user_id": "{{session['user_id']}}"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/organization/user/remove -k

successful response, 201

error response, 400

▦ Datasets

/api/dataset/create

an endpoint to create datasets.

['POST']

POST method

curl -d '{"dataset_name": "sample dataset name", "dataset_description": "this is a sample dataset description", "dataset_size": "10-100MB", "dataset_format": "audio", "status": "private", "license_type": "Databoard Standard License"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/create -k

successful response, 200

error response, 400

/api/dataset/delete

an endpoint to delete a dataset instance.

['POST']

POST method

curl -d '{"dataset_id": "855986cc-b49b-4f54-a57e-b535da0d0f71"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/delete -k

successful response, 200

error response, 400

/api/dataset/download

an endpoint to download datasets.

['POST']

POST method

curl "{{session['base_url']}}/api/dataset/download?user_id={{session['user_id']}}&user_auth_token={{session['user_auth_token']}}&organization_id={{session['organization_id']}}&organization_auth_token={{session['organization_auth_token']}}&dataset_id={{session['dataset_id']}}" --output {{session['dataset_id']}}.zip -k

successful response, 200

error response, 400

/api/dataset/edit

an endpoint to edit dataset profile information.

['POST']

POST method

curl -d '{"dataset_id": "{{session['dataset_id']}}", "dataset_name": "new dataset name", "dataset_description": "new dataset description", "dataset_size": "10-100MB", "dataset_license_type": "Apache 2.0 License"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/edit -k

successful response, 200

error response, 400

/api/dataset/read

an endpoint to get dataset profile information.

['POST']

POST method

curl -d '{"dataset_id": "{{session['dataset_id']}}"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/read -k

successful response, 200

error response, 400

/api/dataset/sample/create

an endpoint to upload data samples to datasets.

['POST']

POST method

curl -X POST {{session['base_url']}}/api/dataset/sample/create -F [email protected] -F dataset_id={{session['dataset_id']}} -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' -k

successful response, 201

error response, 400

/api/dataset/sample/delete

an endpoint to delete data samples from datasets.

['POST']

POST method

curl -d '{"sample_id": "{{session['sample_id']}}"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/sample/delete -k

successful response, 201

error response, 400

/api/dataset/sample/operation/create

an endpoint to add operations to dataset samples

['POST']

POST method

curl -d '{"sample_id": "{{session['sample_id']}}", "operation_type": "[operation_type]"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/sample/operation/create -k

successful response, 201

error response, 400

/api/dataset/sample/operation/delete

an endpoint to delete operations from dataset samples.

['POST']

POST method

curl -d '{"sample_id": "{{session['sample_id']}}", "operation_id": "[operation_id]"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/sample/operation/delete -k

successful response, 201

error response, 400

/api/dataset/sample/operation/read

an endpoint to read sample data operations.

['POST']

POST method

successful response, 201

error response, 400

/api/dataset/sample/read

an endpoint to read data samples from datasets.

['POST']

POST method

successful response, 201

error response, 400

/api/dataset/starred/create

an endpoint to star datasets.

['POST']

POST method

curl -d '{"dataset_id": "{{session['dataset_id']}}", "user_source": "[starred user_id]", "organization_source": "[starred organization_id]"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/dataset/starred/create -k

successful response, 201

error response, 400

/api/dataset/starred/delete

an endpoint to unstar datasets.

['POST']

POST method

successful response, 201

error response, 400

/api/datasets/starred

an endpoint to get a user's or organization's starred datasets.

['POST']

POST method

successful response, 201

error response, 400

Schemas

/api/schema/create

an endpoint to create schemas that can be enforced for datasets.

['POST']

POST method

curl -d '{"schema": {"test": "integer", "user": "string", "price": "float"}}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/schema/create -k

successful response, 200

error response, 400

/api/schema/delete

an endpoint to delete schemas.

['POST']

POST method

curl -d '{"schema_id": "purposefullybadid"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/schema/delete -k

successful response, 200

error response, 400

/api/schema/edit

an endpoint to edit schemas.

['POST']

POST method

curl -d '{"schema_id": "f4121bcf-a18c-4304-ae63-0dcaaed4401e", "name": "new schema name", "description": "new schema description", "status": "public"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/schema/edit -k

successful response, 200

error response, 400

/api/schema/get

an endpoint to get dataset schemas.

['POST']

POST method

successful response, 200

error response, 400

/api/schema/starred/create

an endpoint to star schemas.

['POST']

POST method

curl -d '{"schema_id": "{{session['schema_id']}}", "user_source": "[starred user_id]", "organization_source": "[starred organization_id]"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/schema/starred/create -k

successful response, 201

error response, 400

/api/schema/starred/delete

an endpoint to unstar schemas.

['POST']

POST method

successful response, 201

error response, 400

/api/schemas/starred

an endpoint to get a user's or organization's starred datasets.

['POST']

POST method

successful response, 201

error response, 400

Surveys

/api/survey/create

an endpoint to create surveys.

['POST']

POST method

curl -d '{"name": "test survey", "description": "test survey description", "fragments": "{\"audio-772906da-0011-4406-96cf-aab00e153d18\":\"test audio fragment question\",\"date-bd543a5d-f042-4195-9337-192fe0234d02\":\"test date fragment question\",\"image-11664687-9b51-4f8a-b25a-351ef123476e\":\"test image fragment question\"}"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/survey/create -k

successful response, 200

error response, 400

/api/survey/delete

an endpoint to delete surveys.

['POST']

POST method

curl -d '{"survey_id": "{survey_id}"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/survey/delete -k

successful response, 200

error response, 400

/api/survey/edit

an endpoint to edit surveys.

['POST']

POST method

curl -d '{"survey_id": "{{survey_id}}", "name": "new survey name", "description": "new survey description", "status": "private"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/survey/edit -k

successful response, 200

error response, 400

/api/surveys/starred

an endpoint to get a user's or organization's starred datasets.

['POST']

POST method

successful response, 201

error response, 400

/api/survey/starred/create

an endpoint to star surveys.

['POST']

POST method

curl -d '{"survey_id": "{{session['survey_id']}}", "user_source": "[starred user_id]", "organization_source": "[starred organization_id]"}' -H 'Content-Type: application/json' -H 'Authorization: (u){{session['user_id']}}:{{session['user_auth_token']}}:(o){{session['organization_id']}}:{{session['organization_auth_token']}}' {{session['base_url']}}/api/survey/starred/create -k

successful response, 201

error response, 400

/api/survey/starred/delete

an endpoint to unstar surveys.

['POST']

POST method

successful response, 201

error response, 400

/api/survey/upload

an endpoint to upload survey samples (example without file).

['POST']

POST method

curl -d '{"survey_id": "b73dca41-aac0-4ed8-8105-1878d0749b9f", "fragment_id": "8a5163bf-3dd8-49ba-9174-79cf85e74741", "session_id": "24c23f80-7eae-41e4-b189-28ee939064d6", "data": "2022-06-24", "metadata": "{\"this\": \"can\", \"be\": \"any\", \"key\": \"value\", \"pair\":\"wohooo\"}"}' -H 'Content-Type: application/json' {{session['base_url']}}/api/survey/upload -k

successful response, 200

error response, 400

/api/survey/{survey_id}

an endpoint to view surveys (public).

['GET']

GET method

curl {{session['base_url']}}/api/survey/{survey_id} -k

successful response, 200

error response, 400

response colors

API Version