Authenticate with an API key

Endpoints that require a signed-in user also accept a personal API key. Create one under Account → API keys, then send it in thex-api-key header. The key is shown only once when it is created.

curl -H "x-api-key: jii_..." https://<backend-host>/api/v1/experiments

Keys act as the user who created them and have that user's permissions.
Missing or revoked keys return 401; malformed keys return 403.
Each key is rate limited to 100 requests per minute by default.
Keys may expire and can be revoked immediately from the API keys tab.
Keys are stored hashed; treat them like passwords and rotate leaked keys.

List Experiments

GET/api/v1/experiments

Query Parameters

filter?"member"

Deprecated alias for scope=related

Value in

"member"

scope?string

Which slice of the accessible set to return

Value in

"related"
"all"

status?string

Filter experiments by their status

Value in

"active"
"stale"
"archived"
"published"

search?string

Search term for experiment name

page?integer

1-based page number

Range1 <= value

pageSize?integer

Rows per page

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "status": "active",    "visibility": "private",    "embargoUntil": "2019-08-24T14:15:22Z",    "anonymizeContributors": true,    "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",    "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "organizationName": "string",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "ownerFirstName": "string",    "ownerLastName": "string",    "membersCount": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "data": {      "columns": [        {          "name": "string",          "type_name": "string",          "type_text": "string"        }      ],      "rows": [        {          "property1": null,          "property2": null        }      ],      "totalRows": 0,      "truncated": true    },    "locations": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "latitude": -90,        "longitude": -180,        "country": "string",        "region": "string",        "municipality": "string",        "postalCode": "string",        "addressLabel": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ]  }]

Create Experiment

POST/api/v1/experiments

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The name of the experiment

Length1 <= length <= 255

description?string

Optional description of the experiment

status?string

Initial status of the experiment

Value in

"active"
"stale"
"archived"
"published"

visibility?string

Experiment visibility setting

Value in

"private"
"public"

organizationId?string

Optional owning organization; defaults to the creator's personal org

Formatuuid

embargoUntil?string

Embargo end date and time (ISO datetime string, will be stored as UTC in database)

Formatdate-time

members?array<>

Optional collaborators to seed: each listed user receives a contributing grant on the new experiment. Higher tiers are handed out through the sharing endpoints.

locations?array<>

Optional array of locations associated with the experiment

workbookId?string

Optional workbook ID to associate with the experiment

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "status": "active",  "visibility": "private",  "embargoUntil": "2019-08-24T14:15:22Z",  "anonymizeContributors": true,  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "ownerFirstName": "string",  "ownerLastName": "string",  "membersCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "data": {    "columns": [      {        "name": "string",        "type_name": "string",        "type_text": "string"      }    ],    "rows": [      {        "property1": null,        "property2": null      }    ],    "totalRows": 0,    "truncated": true  },  "locations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "latitude": -90,      "longitude": -180,      "country": "string",      "region": "string",      "municipality": "string",      "postalCode": "string",      "addressLabel": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Get Experiment

GET/api/v1/experiments/{id}

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "status": "active",  "visibility": "private",  "embargoUntil": "2019-08-24T14:15:22Z",  "anonymizeContributors": true,  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "ownerFirstName": "string",  "ownerLastName": "string",  "membersCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "data": {    "columns": [      {        "name": "string",        "type_name": "string",        "type_text": "string"      }    ],    "rows": [      {        "property1": null,        "property2": null      }    ],    "totalRows": 0,    "truncated": true  },  "locations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "latitude": -90,      "longitude": -180,      "country": "string",      "region": "string",      "municipality": "string",      "postalCode": "string",      "addressLabel": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Update Experiment

PATCH/api/v1/experiments/{id}

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Updated experiment name

Length1 <= length <= 255

description?string

Updated experiment description

status?string

Updated experiment status

Value in

"active"
"stale"
"archived"
"published"

embargoUntil?string

Updated embargo end date and time (ISO datetime string, will be stored as UTC in database). Only editable while the experiment is still private.

Formatdate-time

anonymizeContributors?boolean

When true, the API rewrites contributor name/avatar/id to deterministic pseudonyms before responding

locations?array<>

Updated locations associated with the experiment

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "status": "active",  "visibility": "private",  "embargoUntil": "2019-08-24T14:15:22Z",  "anonymizeContributors": true,  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "ownerFirstName": "string",  "ownerLastName": "string",  "membersCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "data": {    "columns": [      {        "name": "string",        "type_name": "string",        "type_text": "string"      }    ],    "rows": [      {        "property1": null,        "property2": null      }    ],    "totalRows": 0,    "truncated": true  },  "locations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "latitude": -90,      "longitude": -180,      "country": "string",      "region": "string",      "municipality": "string",      "postalCode": "string",      "addressLabel": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Delete Experiment

DELETE/api/v1/experiments/{id}

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Get Experiment Access

GET/api/v1/experiments/{id}/access

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/access"

{  "experiment": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "status": "active",    "visibility": "private",    "embargoUntil": "2019-08-24T14:15:22Z",    "anonymizeContributors": true,    "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",    "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "organizationName": "string",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "ownerFirstName": "string",    "ownerLastName": "string",    "membersCount": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "data": {      "columns": [        {          "name": "string",          "type_name": "string",          "type_text": "string"        }      ],      "rows": [        {          "property1": null,          "property2": null        }      ],      "totalRows": 0,      "truncated": true    },    "locations": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "latitude": -90,        "longitude": -180,        "country": "string",        "region": "string",        "municipality": "string",        "postalCode": "string",        "addressLabel": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ]  },  "hasAccess": true,  "isAdmin": true,  "capabilities": {    "canContribute": true,    "canUpdate": true,    "canManage": true,    "canShare": true,    "canLeave": true,    "canTransfer": true  }}

Set Visibility

PATCH/api/v1/experiments/{id}/visibility

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

visibility*string

Value in

"private"
"public"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/visibility" \  -H "Content-Type: application/json" \  -d '{    "visibility": "private"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "visibility": "private"}

Get Experiment Tables

GET/api/v1/experiments/{id}/tables

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/tables"

[  {    "identifier": "string",    "tableType": "static",    "displayName": "string",    "totalRows": 0,    "defaultSortColumn": "string",    "errorColumn": "string"  }]

Get Experiment Data

GET/api/v1/experiments/{id}/data

Path Parameters

id*string

ID of the experiment

Formatuuid

Query Parameters

page?integer

Page number for pagination

Range1 <= value

pageSize?integer

Number of rows per page

Range1 <= value <= 100

tableName*|

Table name: 'raw_data', 'device', macro UUID, or upload_table_id

columns?string

Specific columns to fetch. If provided with tableName, fetches full data for these columns only

orderBy?string

Column name to order results by

orderDirection?string

Sort direction for ordering

Value in

"ASC"
"DESC"

filters?string

JSON-encoded array of filter conditions applied as a WHERE clause

aggregation?string

JSON-encoded GROUP BY + aggregate functions

limit?integer

Hard cap on returned rows for filtered/aggregated reads. Ignored when page/pageSize are used.

Range0 <= value <= 100000

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data?tableName=raw_data"

[  {    "name": "string",    "catalog_name": "string",    "schema_name": "string",    "data": {      "columns": [        {          "name": "string",          "type_name": "string",          "type_text": "string"        }      ],      "rows": [        {          "property1": null,          "property2": null        }      ],      "totalRows": 0,      "truncated": true    },    "page": 0,    "pageSize": 0,    "totalPages": 0,    "totalRows": 0  }]

Get Distinct Column Values

GET/api/v1/experiments/{id}/data/distinct

Path Parameters

id*string

ID of the experiment

Formatuuid

Query Parameters

tableName*|

Table to scan

column*string

Column whose distinct values to return

Length1 <= length

limit?integer

Hard cap on returned values (default 200, max 1000).

Range0 <= value <= 1000

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/distinct?tableName=raw_data&column=string"

{  "values": [    "string"  ],  "truncated": true}

List Exports

GET/api/v1/experiments/{id}/data/exports

Path Parameters

id*string

ID of the experiment

Formatuuid

Query Parameters

tableName*string

Name of the table

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/exports?tableName=string"

{  "exports": [    {      "exportId": "85382188-14c3-47fd-b4ab-d4b86ccda514",      "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",      "tableName": "string",      "format": "csv",      "status": "queued",      "filePath": "string",      "rowCount": 0,      "fileSize": 0,      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",      "createdAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    }  ]}

Initiate Export

POST/api/v1/experiments/{id}/data/exports

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tableName*string

Name of the table to export

format*string

Export format

Value in

"csv"
"ndjson"
"json-array"
"parquet"
"xlsx"

anonymizeContributors?boolean

Per-export override of the experiment's anonymise-contributors setting. Falls back to the experiment's stored value when omitted.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/exports" \  -H "Content-Type: application/json" \  -d '{    "tableName": "string",    "format": "csv"  }'

{  "status": "string"}

Download Export

GET/api/v1/experiments/{id}/data/exports/{exportId}

Path Parameters

id*string

ID of the experiment

Formatuuid

exportId*string

ID of the export

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/exports/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

List Uploads

GET/api/v1/experiments/{id}/data/uploads

Path Parameters

id*string

ID of the experiment

Formatuuid

Query Parameters

uploadTableId?string

Formatuuid

uploadTableName?string

Length1 <= length <= 63

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/uploads"

{  "uploads": [    {      "uploadId": "string",      "experimentId": "string",      "uploadTableId": "string",      "uploadTableName": "string",      "sourceKind": "ambyte",      "status": "pending",      "fileCount": 0,      "rowCount": 0,      "createdBy": "string",      "createdAt": "string",      "completedAt": "string",      "errorMessage": "string"    }  ]}

Add Annotation

POST/api/v1/experiments/{id}/data/annotations

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tableName*string

rowId*string

Length1 <= length

annotation*

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/annotations" \  -H "Content-Type: application/json" \  -d '{    "tableName": "string",    "rowId": "string",    "annotation": {      "type": "comment",      "content": {        "type": "comment",        "text": "string"      }    }  }'

{  "rowsAffected": 0}

Add Annotations Bulk

POST/api/v1/experiments/{id}/data/annotations/bulk

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tableName*string

rowIds*array<>

Items1 <= items

annotation*

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/annotations/bulk" \  -H "Content-Type: application/json" \  -d '{    "tableName": "string",    "rowIds": [      "string"    ],    "annotation": {      "type": "comment",      "content": {        "type": "comment",        "text": "string"      }    }  }'

{  "rowsAffected": 0}

Update Annotation

PATCH/api/v1/experiments/{id}/data/annotations/{annotationId}

Path Parameters

id*string

ID of the experiment

Formatuuid

annotationId*string

ID of the annotation

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

content*|

Updated content

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/annotations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "content": {      "type": "comment",      "text": "string"    }  }'

{  "rowsAffected": 0}

Delete Annotation

DELETE/api/v1/experiments/{id}/data/annotations/{annotationId}

Path Parameters

id*string

ID of the experiment

Formatuuid

annotationId*string

ID of the annotation

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/annotations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "rowsAffected": 0}

Delete Annotations Bulk

POST/api/v1/experiments/{id}/data/annotations/bulk-delete

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tableName*string

Name of the data table

rowIds*array<>

Rows IDs to delete

Items1 <= items

type*string

Type of annotations to delete

Value in

"comment"
"flag"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/annotations/bulk-delete" \  -H "Content-Type: application/json" \  -d '{    "tableName": "string",    "rowIds": [      "string"    ],    "type": "comment"  }'

{  "rowsAffected": 0}

Get Experiment Locations

GET/api/v1/experiments/{id}/locations

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/locations"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "latitude": -90,    "longitude": -180,    "country": "string",    "region": "string",    "municipality": "string",    "postalCode": "string",    "addressLabel": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Add Experiment Locations

POST/api/v1/experiments/{id}/locations

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

locations*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/locations" \  -H "Content-Type: application/json" \  -d '{    "locations": [      {        "name": "string",        "latitude": -90,        "longitude": -180      }    ]  }'

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "latitude": -90,    "longitude": -180,    "country": "string",    "region": "string",    "municipality": "string",    "postalCode": "string",    "addressLabel": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Update Experiment Locations

PUT/api/v1/experiments/{id}/locations

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

locations*array<>

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/locations" \  -H "Content-Type: application/json" \  -d '{    "locations": [      {        "name": "string",        "latitude": -90,        "longitude": -180      }    ]  }'

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "latitude": -90,    "longitude": -180,    "country": "string",    "region": "string",    "municipality": "string",    "postalCode": "string",    "addressLabel": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Search Places

GET/api/v1/locations/search

Query Parameters

query*string

Length1 <= length

maxResults?number

Range1 <= value <= 50

Default10

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/locations/search?query=string"

[  {    "label": "string",    "latitude": 0,    "longitude": 0,    "country": "string",    "region": "string",    "municipality": "string",    "postalCode": "string"  }]

Geocode Location

GET/api/v1/locations/geocode

Query Parameters

latitude*number

Range-90 <= value <= 90

longitude*number

Range-180 <= value <= 180

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/locations/geocode?latitude=-90&longitude=-180"

[  {    "label": "string",    "latitude": 0,    "longitude": 0,    "country": "string",    "region": "string",    "municipality": "string",    "postalCode": "string"  }]

List Experiment Contributors

GET/api/v1/experiments/{id}/contributors

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/contributors"

{  "contributors": [    {      "userId": "string",      "firstName": "string",      "lastName": "string",      "avatarUrl": "string"    }  ],  "collaboratorCount": 0}

List Experiment Devices

GET/api/v1/experiments/{id}/devices

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/devices"

[  {    "device": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "thingName": "string",      "serialNumber": "string",      "name": "string",      "deviceType": "multispeq",      "status": "pending"    },    "addedBy": "e7b73b51-b147-4481-bcc4-0ec1394b652e",    "addedAt": "2019-08-24T14:15:22Z"  }]

Remove Experiment Device

DELETE/api/v1/experiments/{id}/devices/{deviceId}

Path Parameters

id*string

ID of the experiment

Formatuuid

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

List Experiment Metadata

GET/api/v1/experiments/{id}/metadata

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/metadata"

[  {    "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",    "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",    "metadata": {      "property1": null,      "property2": null    },    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create Experiment Metadata

POST/api/v1/experiments/{id}/metadata

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

metadata*

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/metadata" \  -H "Content-Type: application/json" \  -d '{    "metadata": {      "name": "string",      "columns": [        {          "id": "string",          "name": "string",          "type": "string"        }      ],      "rows": [        {          "_id": "string",          "property1": null,          "property2": null        }      ],      "identifierColumnId": "string",      "experimentQuestionId": "string"    }  }'

{  "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "metadata": {    "property1": null,    "property2": null  },  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update Experiment Metadata

PUT/api/v1/experiments/{id}/metadata/{metadataId}

Path Parameters

id*string

ID of the experiment

Formatuuid

metadataId*string

ID of the metadata record

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

metadata*

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/metadata/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "metadata": {      "name": "string",      "columns": [        {          "id": "string",          "name": "string",          "type": "string"        }      ],      "rows": [        {          "_id": "string",          "property1": null,          "property2": null        }      ],      "identifierColumnId": "string",      "experimentQuestionId": "string"    }  }'

{  "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "metadata": {    "property1": null,    "property2": null  },  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete Experiment Metadata

DELETE/api/v1/experiments/{id}/metadata/{metadataId}

Path Parameters

id*string

ID of the experiment

Formatuuid

metadataId*string

ID of the metadata record

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/metadata/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Get Flow

GET/api/v1/experiments/{id}/flow

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/flow"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "graph": {    "nodes": [      {        "id": "string",        "type": "question",        "name": "string",        "content": {          "kind": "yes_no",          "text": "string",          "required": false        },        "isStart": false,        "position": {          "x": 0,          "y": 0        }      }    ],    "edges": [      {        "id": "string",        "source": "string",        "target": "string",        "label": "string",        "sourceHandle": "string"      }    ]  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create Flow

POST/api/v1/experiments/{id}/flow

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nodes*array<>

Items1 <= items

edges*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/flow" \  -H "Content-Type: application/json" \  -d '{    "nodes": [      {        "id": "string",        "type": "question",        "name": "string",        "content": {          "kind": "yes_no",          "text": "string"        }      }    ],    "edges": [      {        "id": "string",        "source": "string",        "target": "string"      }    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "graph": {    "nodes": [      {        "id": "string",        "type": "question",        "name": "string",        "content": {          "kind": "yes_no",          "text": "string",          "required": false        },        "isStart": false,        "position": {          "x": 0,          "y": 0        }      }    ],    "edges": [      {        "id": "string",        "source": "string",        "target": "string",        "label": "string",        "sourceHandle": "string"      }    ]  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update Flow

PUT/api/v1/experiments/{id}/flow

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nodes*array<>

Items1 <= items

edges*array<>

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/flow" \  -H "Content-Type: application/json" \  -d '{    "nodes": [      {        "id": "string",        "type": "question",        "name": "string",        "content": {          "kind": "yes_no",          "text": "string"        }      }    ],    "edges": [      {        "id": "string",        "source": "string",        "target": "string"      }    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "graph": {    "nodes": [      {        "id": "string",        "type": "question",        "name": "string",        "content": {          "kind": "yes_no",          "text": "string",          "required": false        },        "isStart": false,        "position": {          "x": 0,          "y": 0        }      }    ],    "edges": [      {        "id": "string",        "source": "string",        "target": "string",        "label": "string",        "sourceHandle": "string"      }    ]  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Attach Workbook

POST/api/v1/experiments/{id}/workbook/attach

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

workbookId*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/workbook/attach" \  -H "Content-Type: application/json" \  -d '{    "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c"  }'

{  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "version": 0}

Detach Workbook

POST/api/v1/experiments/{id}/workbook/detach

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/workbook/detach"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "status": "active",  "visibility": "private",  "embargoUntil": "2019-08-24T14:15:22Z",  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "ownerFirstName": "string",  "ownerLastName": "string",  "membersCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "data": {    "columns": [      {        "name": "string",        "type_name": "string",        "type_text": "string"      }    ],    "rows": [      {        "property1": null,        "property2": null      }    ],    "totalRows": 0,    "truncated": true  },  "locations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "latitude": -90,      "longitude": -180,      "country": "string",      "region": "string",      "municipality": "string",      "postalCode": "string",      "addressLabel": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Upgrade Workbook Version

POST/api/v1/experiments/{id}/workbook/upgrade

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/workbook/upgrade"

{  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "version": 0}

Set Workbook Version

POST/api/v1/experiments/{id}/workbook/version

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

versionId*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/workbook/version" \  -H "Content-Type: application/json" \  -d '{    "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"  }'

{  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "workbookVersionId": "4d884985-5ac3-4007-8e9b-7b1d17fd2860",  "version": 0}

List Experiment Dashboards

GET/api/v1/experiments/{id}/dashboards

Path Parameters

id*string

ID of the experiment

Formatuuid

Query Parameters

limit?integer

Range0 <= value <= 100

Default50

offset?integer

Range0 <= value

Default0

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/dashboards"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",    "name": "string",    "description": "string",    "layout": {      "columns": 12,      "rowHeight": 80,      "gap": 16    },    "widgets": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "layout": {          "col": 0,          "row": 0,          "colSpan": 1,          "rowSpan": 1        },        "type": "visualization",        "config": {          "visualizationId": "f1fb5e6b-e1a9-4239-a299-7daa4bf3992d",          "showTitle": true,          "showDescription": false,          "title": "string",          "description": "string"        }      }    ],    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdByName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create Experiment Dashboard

POST/api/v1/experiments/{id}/dashboards

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

layout?

widgets?array<|||>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/dashboards" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "name": "string",  "description": "string",  "layout": {    "columns": 12,    "rowHeight": 80,    "gap": 16  },  "widgets": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "layout": {        "col": 0,        "row": 0,        "colSpan": 1,        "rowSpan": 1      },      "type": "visualization",      "config": {        "visualizationId": "f1fb5e6b-e1a9-4239-a299-7daa4bf3992d",        "showTitle": true,        "showDescription": false,        "title": "string",        "description": "string"      }    }  ],  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get Experiment Dashboard

GET/api/v1/experiments/{id}/dashboards/{dashboardId}

Path Parameters

id*string

ID of the experiment

Formatuuid

dashboardId*string

ID of the dashboard

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "name": "string",  "description": "string",  "layout": {    "columns": 12,    "rowHeight": 80,    "gap": 16  },  "widgets": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "layout": {        "col": 0,        "row": 0,        "colSpan": 1,        "rowSpan": 1      },      "type": "visualization",      "config": {        "visualizationId": "f1fb5e6b-e1a9-4239-a299-7daa4bf3992d",        "showTitle": true,        "showDescription": false,        "title": "string",        "description": "string"      }    }  ],  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update Experiment Dashboard

PATCH/api/v1/experiments/{id}/dashboards/{dashboardId}

Path Parameters

id*string

ID of the experiment

Formatuuid

dashboardId*string

ID of the dashboard

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 255

description?string

layout?

widgets?array<|||>

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "name": "string",  "description": "string",  "layout": {    "columns": 12,    "rowHeight": 80,    "gap": 16  },  "widgets": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "layout": {        "col": 0,        "row": 0,        "colSpan": 1,        "rowSpan": 1      },      "type": "visualization",      "config": {        "visualizationId": "f1fb5e6b-e1a9-4239-a299-7daa4bf3992d",        "showTitle": true,        "showDescription": false,        "title": "string",        "description": "string"      }    }  ],  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete Experiment Dashboard

DELETE/api/v1/experiments/{id}/dashboards/{dashboardId}

Path Parameters

id*string

ID of the experiment

Formatuuid

dashboardId*string

ID of the dashboard

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

List Experiment Visualizations

GET/api/v1/experiments/{id}/visualizations

Path Parameters

id*string

ID of the experiment

Formatuuid

Query Parameters

chartFamily?string

Value in

"basic"
"scientific"
"3d"
"statistical"

limit?integer

Range0 <= value <= 100

Default50

offset?integer

Range0 <= value

Default0

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/visualizations"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",    "chartFamily": "basic",    "chartType": "line",    "config": {      "property1": null,      "property2": null    },    "dataConfig": {      "tableName": "string",      "dataSources": [        {          "tableName": "string",          "columnName": "string",          "role": "x",          "seriesName": "string",          "alias": "string",          "traceType": "line",          "axis": "primary",          "aggregate": "sum",          "errorColumn": "string"        }      ],      "filters": [        {          "column": "string",          "operator": "equals",          "value": "string"        }      ],      "aggregation": {        "groupBy": [          {            "column": "string",            "timeBucket": "minute"          }        ],        "functions": [          {            "column": "string",            "function": "sum",            "alias": "string",            "secondColumn": "string"          }        ]      }    },    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdByName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create Experiment Visualization

POST/api/v1/experiments/{id}/visualizations

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

chartFamily*string

Value in

"basic"
"scientific"
"3d"
"statistical"

chartType*string

Value in

"line"
"scatter"
"bar"
"pie"
"area"
"dot-plot"
"bubble"
"lollipop"
"box-plot"
"histogram"
"violin-plot"
"density-plot"
"ridge-plot"
"histogram-2d"
"density-plot-2d"
"spc-control-chart"
"heatmap"
"contour"
"carpet"
"ternary"
"parallel-coordinates"
"wind-rose"
"radar"
"polar"
"correlation-matrix"
"alluvial"

config?

dataConfig*

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/visualizations" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "chartFamily": "basic",    "chartType": "line",    "dataConfig": {      "tableName": "string",      "dataSources": [        {          "tableName": "string",          "columnName": "string",          "role": "x"        }      ]    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "chartFamily": "basic",  "chartType": "line",  "config": {    "property1": null,    "property2": null  },  "dataConfig": {    "tableName": "string",    "dataSources": [      {        "tableName": "string",        "columnName": "string",        "role": "x",        "seriesName": "string",        "alias": "string",        "traceType": "line",        "axis": "primary",        "aggregate": "sum",        "errorColumn": "string"      }    ],    "filters": [      {        "column": "string",        "operator": "equals",        "value": "string"      }    ],    "aggregation": {      "groupBy": [        {          "column": "string",          "timeBucket": "minute"        }      ],      "functions": [        {          "column": "string",          "function": "sum",          "alias": "string",          "secondColumn": "string"        }      ]    }  },  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get Experiment Visualization

GET/api/v1/experiments/{id}/visualizations/{visualizationId}

Path Parameters

id*string

ID of the experiment

Formatuuid

visualizationId*string

ID of the visualization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/visualizations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "chartFamily": "basic",  "chartType": "line",  "config": {    "property1": null,    "property2": null  },  "dataConfig": {    "tableName": "string",    "dataSources": [      {        "tableName": "string",        "columnName": "string",        "role": "x",        "seriesName": "string",        "alias": "string",        "traceType": "line",        "axis": "primary",        "aggregate": "sum",        "errorColumn": "string"      }    ],    "filters": [      {        "column": "string",        "operator": "equals",        "value": "string"      }    ],    "aggregation": {      "groupBy": [        {          "column": "string",          "timeBucket": "minute"        }      ],      "functions": [        {          "column": "string",          "function": "sum",          "alias": "string",          "secondColumn": "string"        }      ]    }  },  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update Experiment Visualization

PATCH/api/v1/experiments/{id}/visualizations/{visualizationId}

Path Parameters

id*string

ID of the experiment

Formatuuid

visualizationId*string

ID of the visualization

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

chartFamily*string

Value in

"basic"
"scientific"
"3d"
"statistical"

chartType*string

Value in

"line"
"scatter"
"bar"
"pie"
"area"
"dot-plot"
"bubble"
"lollipop"
"box-plot"
"histogram"
"violin-plot"
"density-plot"
"ridge-plot"
"histogram-2d"
"density-plot-2d"
"spc-control-chart"
"heatmap"
"contour"
"carpet"
"ternary"
"parallel-coordinates"
"wind-rose"
"radar"
"polar"
"correlation-matrix"
"alluvial"

config?

dataConfig*

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/visualizations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "chartFamily": "basic",    "chartType": "line",    "dataConfig": {      "tableName": "string",      "dataSources": [        {          "tableName": "string",          "columnName": "string",          "role": "x"        }      ]    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "chartFamily": "basic",  "chartType": "line",  "config": {    "property1": null,    "property2": null  },  "dataConfig": {    "tableName": "string",    "dataSources": [      {        "tableName": "string",        "columnName": "string",        "role": "x",        "seriesName": "string",        "alias": "string",        "traceType": "line",        "axis": "primary",        "aggregate": "sum",        "errorColumn": "string"      }    ],    "filters": [      {        "column": "string",        "operator": "equals",        "value": "string"      }    ],    "aggregation": {      "groupBy": [        {          "column": "string",          "timeBucket": "minute"        }      ],      "functions": [        {          "column": "string",          "function": "sum",          "alias": "string",          "secondColumn": "string"        }      ]    }  },  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete Experiment Visualization

DELETE/api/v1/experiments/{id}/visualizations/{visualizationId}

Path Parameters

id*string

ID of the experiment

Formatuuid

visualizationId*string

ID of the visualization

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/visualizations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

List Join Requests

GET/api/v1/experiments/{id}/join-requests

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",    "user": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "firstName": "string",      "lastName": "string",      "email": "string",      "avatarUrl": "string"    },    "message": "string",    "status": "pending",    "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",    "decidedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create Join Request

POST/api/v1/experiments/{id}/join-requests

Path Parameters

id*string

ID of the experiment

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message?string

Optional short message to the project admins

Lengthlength <= 250

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "user": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string"  },  "message": "string",  "status": "pending",  "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",  "decidedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get My Join Request

GET/api/v1/experiments/{id}/join-requests/me

Path Parameters

id*string

ID of the experiment

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests/me"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "user": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string"  },  "message": "string",  "status": "pending",  "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",  "decidedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Approve Join Request

POST/api/v1/experiments/{id}/join-requests/{requestId}/approve

Path Parameters

id*string

ID of the experiment

Formatuuid

requestId*string

ID of the join request

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests/497f6eca-6276-4993-bfeb-53cbbbba6f08/approve"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "user": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string"  },  "message": "string",  "status": "pending",  "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",  "decidedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Reject Join Request

POST/api/v1/experiments/{id}/join-requests/{requestId}/reject

Path Parameters

id*string

ID of the experiment

Formatuuid

requestId*string

ID of the join request

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests/497f6eca-6276-4993-bfeb-53cbbbba6f08/reject"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "user": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string"  },  "message": "string",  "status": "pending",  "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",  "decidedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Cancel Join Request

DELETE/api/v1/experiments/{id}/join-requests/{requestId}

Path Parameters

id*string

ID of the experiment

Formatuuid

requestId*string

ID of the join request

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiments/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

List Transfer Requests

GET/api/v1/transfer-requests

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/transfer-requests"

[  {    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "userEmail": "user@example.com",    "sourcePlatform": "string",    "projectIdOld": "string",    "projectUrlOld": "http://example.com",    "status": "pending",    "requestedAt": "2019-08-24T14:15:22Z"  }]

Create Transfer Request

POST/api/v1/transfer-requests

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectIdOld*string

Length1 <= length <= 255

projectUrlOld*string

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/transfer-requests" \  -H "Content-Type: application/json" \  -d '{    "projectIdOld": "string",    "projectUrlOld": "http://example.com"  }'

{  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",  "userEmail": "user@example.com",  "sourcePlatform": "string",  "projectIdOld": "string",  "projectUrlOld": "http://example.com",  "status": "pending",  "requestedAt": "2019-08-24T14:15:22Z"}

Project Transfer

POST/api/v1/webhooks/project-transfer

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

experiment*

protocol?

macro?

questions?array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/webhooks/project-transfer" \  -H "Content-Type: application/json" \  -d '{    "experiment": {      "name": "string",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"    }  }'

{  "success": true,  "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",  "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",  "macroId": "ec059dca-f11f-4b38-b136-ad49d8b47afe",  "macroFilename": "string",  "macroName": "string",  "flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",  "message": "string"}

Get Time

GET/health/time

Response Body

`application/json`

curl -X GET "https://example.com/health/time"

{  "utcTimestampMs": 0,  "utcTimestampSec": 0,  "iso": "string"}

Get Credentials

GET/api/v1/iot/credentials

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/iot/credentials"

{  "accessKeyId": "string",  "secretAccessKey": "string",  "sessionToken": "string",  "expiration": "2019-08-24T14:15:22Z"}

Get Upload Url

POST/api/v1/iot/upload-url

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

experimentId*string

UUID of the experiment to associate this upload with

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/iot/upload-url" \  -H "Content-Type: application/json" \  -d '{    "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006"  }'

{  "uploadUrl": "http://example.com",  "key": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Get Device Registry

POST/api/v1/iot/devices/registry

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

thingNames*array<string>

Items1 <= items <= 500

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/iot/devices/registry" \  -H "Content-Type: application/json" \  -d '{    "thingNames": [      "string"    ]  }'

{  "devices": [    {      "thingName": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "serialNumber": "string",      "deviceType": "multispeq",      "status": "pending",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"    }  ],  "success": true}

Ensure Mobile Device

POST/api/v1/devices/mobile

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

installId*string

Persisted per-install identifier; doubles as the serial

Formatuuid

name?string

Device model, e.g. iPhone 15

Length1 <= length <= 255

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/devices/mobile" \  -H "Content-Type: application/json" \  -d '{    "installId": "b233bfe0-f705-4889-ae25-bbc86d012048"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "thingName": "string",  "thingArn": "string",  "serialNumber": "string",  "name": "string",  "deviceType": "multispeq",  "status": "pending",  "certificateId": "string",  "certificateArn": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List Iot Devices

GET/api/v1/devices

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "thingName": "string",    "thingArn": "string",    "serialNumber": "string",    "name": "string",    "deviceType": "multispeq",    "status": "pending",    "certificateId": "string",    "certificateArn": "string",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "visibility": "private",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "connectivity": {      "connected": true,      "lastSeenAt": "2019-08-24T14:15:22Z"    }  }]

Register Iot Device

POST/api/v1/devices

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

serialNumber*string

Physical device identifier, e.g. MAC address

Match^[a-zA-Z0-9_.,@/:#=[\]-]+$

Length1 <= length <= 255

name?string

Length1 <= length <= 255

deviceType*string

IotDevice class, maps to the ingest topic sensorType

Value in

"multispeq"
"ambyte"
"minipar"
"generic"
"ambit"

organizationId?string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/devices" \  -H "Content-Type: application/json" \  -d '{    "serialNumber": "string",    "deviceType": "multispeq"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "thingName": "string",  "thingArn": "string",  "serialNumber": "string",  "name": "string",  "deviceType": "multispeq",  "status": "pending",  "certificateId": "string",  "certificateArn": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get Iot Fleet Monitoring

GET/api/v1/devices/monitoring

Query Parameters

from*string

Formatdate-time

to*string

Formatdate-time

bucket*string

Value in

"hour"
"day"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/monitoring?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&bucket=hour"

{  "devices": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "lastDataAt": "2019-08-24T14:15:22Z"    }  ],  "throughput": [    {      "bucketStart": "2019-08-24T14:15:22Z",      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "count": 0    }  ],  "events": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "eventType": "string",      "eventTimestamp": "2019-08-24T14:15:22Z",      "disconnectReason": "string"    }  ],  "pipelineUnavailable": true}

Bulk Register Iot Devices

POST/api/v1/devices/bulk

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

devices*array<>

Items1 <= items <= 100

deviceType*string

Value in

"multispeq"
"ambyte"
"minipar"
"generic"
"ambit"

organizationId?string

Formatuuid

group?|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/devices/bulk" \  -H "Content-Type: application/json" \  -d '{    "devices": [      {        "serialNumber": "string"      }    ],    "deviceType": "multispeq"  }'

{  "devices": [    {      "serialNumber": "string",      "device": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "thingName": "string",        "thingArn": "string",        "serialNumber": "string",        "name": "string",        "deviceType": "multispeq",        "status": "pending",        "certificateId": "string",        "certificateArn": "string",        "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",        "visibility": "private",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "error": "string"    }  ],  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",  "groupError": "string"}

Get Iot Device

GET/api/v1/devices/{deviceId}

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "thingName": "string",  "thingArn": "string",  "serialNumber": "string",  "name": "string",  "deviceType": "multispeq",  "status": "pending",  "certificateId": "string",  "certificateArn": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "connectivity": {    "connected": true,    "lastSeenAt": "2019-08-24T14:15:22Z"  },  "capabilities": {    "canContribute": true,    "canUpdate": true,    "canManage": true,    "canShare": true,    "canLeave": true,    "canTransfer": true  }}

Delete Iot Device

DELETE/api/v1/devices/{deviceId}

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Get Iot Device Activity

GET/api/v1/devices/{deviceId}/activity

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/activity"

{  "lastDataAt": "2019-08-24T14:15:22Z",  "pipelineUnavailable": true}

Get Device Firmware History

GET/api/v1/devices/{deviceId}/firmware-history

Path Parameters

deviceId*string

Formatuuid

Query Parameters

from*string

Formatdate-time

to*string

Formatdate-time

bucket*string

Value in

"hour"
"day"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/firmware-history?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&bucket=hour"

{  "versions": [    {      "version": "string",      "firstSeen": "2019-08-24T14:15:22Z",      "lastSeen": "2019-08-24T14:15:22Z",      "count": 0    }  ]}

Get Device Monitoring

GET/api/v1/devices/{deviceId}/monitoring

Path Parameters

deviceId*string

Formatuuid

Query Parameters

from*string

Formatdate-time

to*string

Formatdate-time

bucket*string

Value in

"hour"
"day"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/monitoring?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&bucket=hour"

{  "bucket": "hour",  "events": [    {      "eventType": "connected",      "eventTimestamp": "2019-08-24T14:15:22Z",      "disconnectReason": "string",      "sessionIdentifier": "string"    }  ],  "sessions": [    {      "start": "2019-08-24T14:15:22Z",      "end": "2019-08-24T14:15:22Z",      "openStart": true,      "durationSeconds": 0,      "disconnectReason": "string"    }  ],  "uptimePercent": 0,  "truncated": true,  "throughput": [    {      "bucketStart": "2019-08-24T14:15:22Z",      "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",      "count": 0    }  ],  "battery": [    {      "bucketStart": "2019-08-24T14:15:22Z",      "averageBattery": 0    }  ],  "payload": {    "totalMeasurements": 0,    "withGps": 0,    "withBattery": 0,    "workbookRuns": 0,    "firmwareMix": [      {        "version": "string",        "count": 0      }    ],    "protocolMix": [      {        "protocolId": "string",        "count": 0      }    ],    "workbookMix": [      {        "workbookVersionId": "string",        "workbookId": "string",        "workbookVersion": 0,        "count": 0      }    ],    "macroMix": [      {        "macroId": "string",        "count": 0      }    ]  },  "firmwareHistory": [    {      "version": "string",      "firstSeen": "2019-08-24T14:15:22Z",      "lastSeen": "2019-08-24T14:15:22Z",      "count": 0    }  ],  "recentMeasurements": [    {      "timestamp": "2019-08-24T14:15:22Z",      "experimentId": "string",      "protocolId": "string",      "workbookVersionId": "string",      "deviceVersion": "string",      "battery": 0,      "latitude": 0,      "longitude": 0,      "sample": "string"    }  ]}

Issue Iot Credentials

POST/api/v1/devices/{deviceId}/credentials

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials"

{  "certificateId": "string",  "certificateArn": "string",  "certificatePem": "string",  "publicKey": "string",  "privateKey": "string"}

Revoke Iot Credentials

DELETE/api/v1/devices/{deviceId}/credentials

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "thingName": "string",  "thingArn": "string",  "serialNumber": "string",  "name": "string",  "deviceType": "multispeq",  "status": "pending",  "certificateId": "string",  "certificateArn": "string",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Rotate Iot Credentials

POST/api/v1/devices/{deviceId}/credentials/rotate

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials/rotate"

{  "certificateId": "string",  "certificateArn": "string",  "certificatePem": "string",  "publicKey": "string",  "privateKey": "string"}

Onboard Device

POST/api/v1/devices/{deviceId}/onboard

Path Parameters

deviceId*string

ID of the device

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

experimentIds?array<>

Experiments to bind the device to. An empty list re-issues the config.

Itemsitems <= 100

Default[]

includeWorkbook?boolean

When false, the config carries only the connection and topic contract.

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboard" \  -H "Content-Type: application/json" \  -d '{}'

{  "thingName": "string",  "deviceType": "multispeq",  "endpoint": "string",  "experiments": [    {      "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",      "experimentName": "string",      "topicPrefix": "string",      "workbookVersion": 0,      "procedures": [        {          "type": "protocol",          "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",          "name": "string",          "family": "multispeq",          "code": null        }      ]    }  ]}

List Device Experiments

GET/api/v1/devices/{deviceId}/experiments

Path Parameters

deviceId*string

ID of the device

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/experiments"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "status": "active",    "addedAt": "2019-08-24T14:15:22Z"  }]

List Device Observed Experiments

GET/api/v1/devices/{deviceId}/experiments/observed

Path Parameters

deviceId*string

Formatuuid

Query Parameters

from*string

Formatdate-time

to*string

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/experiments/observed?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"

{  "experiments": [    {      "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",      "count": 0,      "lastAt": "2019-08-24T14:15:22Z"    }  ]}

List Iot Device Groups

GET/api/v1/device-groups

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/device-groups"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "visibility": "private",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "memberCount": 0  }]

Create Iot Device Group

POST/api/v1/device-groups

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

Lengthlength <= 2000

organizationId?string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/device-groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get Iot Device Group

GET/api/v1/device-groups/{groupId}

Path Parameters

groupId*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "memberCount": 0,  "capabilities": {    "canContribute": true,    "canUpdate": true,    "canManage": true,    "canShare": true,    "canLeave": true,    "canTransfer": true  }}

Update Iot Device Group

PATCH/api/v1/device-groups/{groupId}

Path Parameters

groupId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 255

description?|null

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "visibility": "private",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete Iot Device Group

DELETE/api/v1/device-groups/{groupId}

Path Parameters

groupId*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Onboard Iot Device Group

POST/api/v1/device-groups/{groupId}/onboard

Path Parameters

groupId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

experimentIds?array<>

Itemsitems <= 100

Default[]

deviceIds?array<>

Member subset to onboard; omitted means every member

Items1 <= items <= 100

includeWorkbook?boolean

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboard" \  -H "Content-Type: application/json" \  -d '{}'

{  "devices": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "config": {        "thingName": "string",        "deviceType": "multispeq",        "endpoint": "string",        "experiments": [          {            "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",            "experimentName": "string",            "topicPrefix": "string",            "workbookVersion": 0,            "procedures": [              {                "type": "protocol",                "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",                "name": "string",                "family": "multispeq",                "code": null              }            ]          }        ]      },      "error": "string"    }  ]}

Issue Iot Device Group Credentials

POST/api/v1/device-groups/{groupId}/credentials

Path Parameters

groupId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deviceIds?array<>

Member subset; omitted means every member

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials" \  -H "Content-Type: application/json" \  -d '{}'

{  "devices": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "thingName": "string",      "credentials": {        "certificateId": "string",        "certificateArn": "string",        "certificatePem": "string",        "publicKey": "string",        "privateKey": "string"      },      "error": "string"    }  ]}

Rotate Iot Device Group Credentials

POST/api/v1/device-groups/{groupId}/credentials/rotate

Path Parameters

groupId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deviceIds?array<>

Member subset; omitted means every member

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials/rotate" \  -H "Content-Type: application/json" \  -d '{}'

{  "devices": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "thingName": "string",      "credentials": {        "certificateId": "string",        "certificateArn": "string",        "certificatePem": "string",        "publicKey": "string",        "privateKey": "string"      },      "error": "string"    }  ]}

Revoke Iot Device Group Credentials

POST/api/v1/device-groups/{groupId}/credentials/revoke

Path Parameters

groupId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deviceIds?array<>

Member subset; omitted means every member

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials/revoke" \  -H "Content-Type: application/json" \  -d '{}'

{  "devices": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "error": "string"    }  ]}

Get Iot Device Group Monitoring

GET/api/v1/device-groups/{groupId}/monitoring

Path Parameters

groupId*string

Formatuuid

Query Parameters

from*string

Formatdate-time

to*string

Formatdate-time

bucket*string

Value in

"hour"
"day"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/monitoring?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&bucket=hour"

{  "members": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "name": "string",      "serialNumber": "string",      "deviceType": "multispeq",      "connectivity": {        "connected": true,        "lastSeenAt": "2019-08-24T14:15:22Z"      },      "lastDataAt": "2019-08-24T14:15:22Z"    }  ],  "throughput": [    {      "bucketStart": "2019-08-24T14:15:22Z",      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "count": 0    }  ],  "dataByExperiment": [    {      "bucketStart": "2019-08-24T14:15:22Z",      "experimentId": "7cb83992-f615-4081-9f22-54e0b618e006",      "count": 0    }  ],  "firmware": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "version": "string",      "lastSeen": "2019-08-24T14:15:22Z"    }  ],  "events": [    {      "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",      "eventType": "string",      "eventTimestamp": "2019-08-24T14:15:22Z",      "disconnectReason": "string"    }  ],  "pipelineUnavailable": true}

List Iot Device Group Members

GET/api/v1/device-groups/{groupId}/devices

Path Parameters

groupId*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/devices"

[  {    "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",    "name": "string",    "serialNumber": "string",    "deviceType": "multispeq",    "status": "pending",    "connected": true,    "addedAt": "2019-08-24T14:15:22Z"  }]

Add Iot Device Group Members

POST/api/v1/device-groups/{groupId}/devices

Path Parameters

groupId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deviceIds*array<>

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/devices" \  -H "Content-Type: application/json" \  -d '{    "deviceIds": [      "aef9410c-f29d-4a00-9ffe-27d2e2ff353a"    ]  }'

[  {    "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",    "name": "string",    "serialNumber": "string",    "deviceType": "multispeq",    "status": "pending",    "connected": true,    "addedAt": "2019-08-24T14:15:22Z"  }]

Remove Iot Device Group Member

DELETE/api/v1/device-groups/{groupId}/devices/{deviceId}

Path Parameters

groupId*string

Formatuuid

deviceId*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/device-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

List Iot Firmware Releases

GET/api/v1/iot/firmware/{family}/releases

Path Parameters

family*string

Value in

"ambyte"
"minipar"
"ambit"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/iot/firmware/ambyte/releases"

{  "releases": [    {      "version": "string",      "name": "string",      "publishedAt": "2019-08-24T14:15:22Z",      "prerelease": true,      "latest": true,      "notesHtml": "string",      "releaseUrl": "http://example.com",      "assets": [        {          "name": "string",          "sizeBytes": 0,          "downloadUrl": "http://example.com"        }      ]    }  ]}

List Macros

GET/api/v1/macros

Query Parameters

search?string

language?string

Value in

"python"
"r"
"javascript"

filter?"my"

Deprecated alias for scope=related

Value in

"my"

scope?string

Which slice of the accessible set to return

Value in

"related"
"all"

page?integer

1-based page number

Range1 <= value

pageSize?integer

Rows per page

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/macros"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "filename": "string",    "description": "string",    "language": "python",    "code": "string",    "sortOrder": 0,    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdByName": "string",    "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "organizationName": "string",    "visibility": "private"  }]

Create Macro

POST/api/v1/macros

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

language*string

Value in

"python"
"r"
"javascript"

code*string

Length1 <= length

forkedFrom?string

Formatuuid

organizationId?string

Formatuuid

visibility?string

Value in

"private"
"public"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/macros" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "language": "python",    "code": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "filename": "string",  "description": "string",  "language": "python",  "code": "string",  "sortOrder": 0,  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private"}

Get Macro

GET/api/v1/macros/{id}

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "filename": "string",  "description": "string",  "language": "python",  "code": "string",  "sortOrder": 0,  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private",  "capabilities": {    "canContribute": true,    "canUpdate": true,    "canManage": true,    "canShare": true,    "canLeave": true,    "canTransfer": true  }}

Update Macro

PUT/api/v1/macros/{id}

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 255

description?string

language?string

Value in

"python"
"r"
"javascript"

code?string

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "filename": "string",  "description": "string",  "language": "python",  "code": "string",  "sortOrder": 0,  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private"}

Delete Macro

DELETE/api/v1/macros/{id}

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Set Visibility

PATCH/api/v1/macros/{id}/visibility

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

visibility*string

Value in

"private"
"public"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08/visibility" \  -H "Content-Type: application/json" \  -d '{    "visibility": "private"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "visibility": "private"}

List Compatible Protocols

GET/api/v1/macros/{id}/protocols

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08/protocols"

[  {    "macroId": "ec059dca-f11f-4b38-b136-ad49d8b47afe",    "protocol": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "family": "string",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"    },    "addedAt": "2019-08-24T14:15:22Z"  }]

Add Compatible Protocols

POST/api/v1/macros/{id}/protocols

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

protocolIds*array<>

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08/protocols" \  -H "Content-Type: application/json" \  -d '{    "protocolIds": [      "10268364-9429-4b52-90a7-984af446e0a9"    ]  }'

[  {    "macroId": "ec059dca-f11f-4b38-b136-ad49d8b47afe",    "protocol": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "family": "string",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"    },    "addedAt": "2019-08-24T14:15:22Z"  }]

Remove Compatible Protocol

DELETE/api/v1/macros/{id}/protocols/{protocolId}

Path Parameters

id*string

Formatuuid

protocolId*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Execute Macro

POST/api/v1/macros/{id}/execute

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*|array<unknown|not (unknown)>

context?

timeout?integer

Range1 <= value <= 60

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08/execute" \  -H "Content-Type: application/json" \  -d '{    "data": {      "property1": null,      "property2": null    }  }'

{  "macro_id": "058c5644-6d89-4487-8893-fd8d698da202",  "success": true,  "output": {    "property1": null,    "property2": null  },  "error": "string"}

Execute Macro Batch

POST/api/v1/macros/execute-batch

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

items*array<>

Items1 <= items <= 5000

timeout?integer

Range1 <= value <= 60

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/macros/execute-batch" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "id": "string",        "macro_id": "058c5644-6d89-4487-8893-fd8d698da202",        "data": {          "property1": null,          "property2": null        }      }    ]  }'

{  "success": true,  "results": [    {      "id": "string",      "macro_id": "string",      "success": true,      "output": {        "property1": null,        "property2": null      },      "error": "string"    }  ],  "errors": [    "string"  ]}

POST/api/v1/newsletter/subscribe

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Email address to subscribe to the newsletter

Formatemail

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/newsletter/subscribe" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

{  "success": true}

Get Status

GET/api/v1/newsletter/status

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/newsletter/status"

{  "status": "subscribed"}

POST/api/v1/newsletter/subscription

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/newsletter/subscription"

{  "status": "subscribed"}

Unsubscribe

DELETE/api/v1/newsletter/subscription

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/newsletter/subscription"

{  "status": "subscribed"}

List Organizations

GET/api/v1/organizations

Query Parameters

search?string

Name or description substring

Lengthlength <= 200

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations"

{  "organizations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "slug": "string",      "logo": "string",      "type": "research_institute",      "description": "string",      "location": "string",      "memberCount": 0,      "resourceCount": 0,      "visibility": "private",      "membershipStatus": "none"    }  ]}

List My Organizations

GET/api/v1/users/me/organizations

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/users/me/organizations"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "slug": "string",    "description": "string",    "visibility": "private",    "role": "owner",    "isPersonal": true,    "memberCount": 0,    "resourceCount": 0  }]

Get Organization

GET/api/v1/organizations/{id}

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "logo": "string",  "type": "research_institute",  "description": "string",  "website": "string",  "location": "string",  "visibility": "private",  "memberCount": 0,  "resourceCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "role": "owner",  "membershipStatus": "none"}

List Organization Resources

GET/api/v1/organizations/{id}/resources

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources"

{  "resources": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "visibility": "private",      "updatedAt": "2019-08-24T14:15:22Z",      "collaboratorCount": 0,      "type": "experiment",      "status": "active"    }  ],  "totals": {    "experiment": 0,    "protocol": 0,    "macro": 0,    "workbook": 0,    "device": 0,    "device_group": 0  }}

List Organization Members

GET/api/v1/organizations/{id}/members

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/members"

{  "members": [    {      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "firstName": "string",      "lastName": "string",      "email": "string",      "avatarUrl": "string",      "role": "string",      "joinedAt": "2019-08-24T14:15:22Z"    }  ]}

Get Organization Deletion Blockers

GET/api/v1/organizations/{id}/deletion-blockers

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/deletion-blockers"

{  "blockers": [    {      "resourceType": "experiment",      "count": 0    }  ],  "total": 0}

List Organization Teams

GET/api/v1/organizations/{id}/teams

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/teams"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "createdAt": "2019-08-24T14:15:22Z",    "members": [      {        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",        "firstName": "string",        "lastName": "string",        "email": "string",        "avatarUrl": "string"      }    ]  }]

List Organization Team Grants

GET/api/v1/organizations/{id}/team-grants

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/team-grants"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",    "resourceType": "experiment",    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "resourceName": "string",    "role": "owner"  }]

List Grantee Teams

GET/api/v1/{resourceType}/{id}/grantee-teams

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/grantee-teams"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "memberCount": 0  }]

List Organization Join Requests

GET/api/v1/organizations/{id}/join-requests

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "user": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "firstName": "string",      "lastName": "string",      "email": "string",      "avatarUrl": "string"    },    "message": "string",    "status": "pending",    "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",    "decidedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create Organization Join Request

POST/api/v1/organizations/{id}/join-requests

Path Parameters

id*string

ID of the organization

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message?string

Optional short message to the organization's owners and admins

Lengthlength <= 250

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "user": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string"  },  "message": "string",  "status": "pending",  "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",  "decidedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Cancel My Organization Join Request

DELETE/api/v1/organizations/{id}/join-requests/me

Path Parameters

id*string

ID of the organization

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests/me"

null

Decide Organization Join Request

PATCH/api/v1/organizations/{id}/join-requests/{requestId}

Path Parameters

id*string

ID of the organization

Formatuuid

requestId*string

ID of the join request

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

decision*string

Value in

"approve"
"reject"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/join-requests/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "decision": "approve"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "user": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string"  },  "message": "string",  "status": "pending",  "decidedBy": "3a741861-b09d-4f52-b451-be998c2bf2d1",  "decidedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List Protocols

GET/api/v1/protocols

Query Parameters

search?string

filter?"my"

Deprecated alias for scope=related

Value in

"my"

scope?string

Which slice of the accessible set to return

Value in

"related"
"all"

page?integer

1-based page number

Range1 <= value

pageSize?integer

Rows per page

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/protocols"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "code": null,    "family": "multispeq",    "sortOrder": 0,    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdByName": "string",    "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "organizationName": "string",    "visibility": "private"  }]

Create Protocol

POST/api/v1/protocols

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

family*string

Value in

"multispeq"
"ambyte"
"minipar"
"generic"
"ambit"

forkedFrom?string

Formatuuid

organizationId?string

Formatuuid

visibility?string

Value in

"private"
"public"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/protocols" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "code": "string",    "family": "multispeq"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "code": "string",  "family": "multispeq",  "sortOrder": 0,  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private"}

`application/json`

curl -X GET "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "code": "string",  "family": "multispeq",  "sortOrder": 0,  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private",  "capabilities": {    "canContribute": true,    "canUpdate": true,    "canManage": true,    "canShare": true,    "canLeave": true,    "canTransfer": true  }}

Use the request body type in TypeScript.

name?string

Length1 <= length <= 255

description?string

family?string

Value in

"multispeq"
"ambyte"
"minipar"
"generic"
"ambit"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "code": "string",  "family": "multispeq",  "sortOrder": 0,  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private"}

`application/json`

curl -X DELETE "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Use the request body type in TypeScript.

visibility*string

Value in

"private"
"public"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08/visibility" \  -H "Content-Type: application/json" \  -d '{    "visibility": "private"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "visibility": "private"}

`application/json`

curl -X GET "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08/macros"

[  {    "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",    "macro": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "filename": "string",      "language": "python",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"    },    "addedAt": "2019-08-24T14:15:22Z"  }]

Use the request body type in TypeScript.

macroIds*array<>

Items1 <= items <= 100

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08/macros" \  -H "Content-Type: application/json" \  -d '{    "macroIds": [      "d77edf99-d72c-47c3-a802-2f35a6dc55a7"    ]  }'

[  {    "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",    "macro": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "filename": "string",      "language": "python",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"    },    "addedAt": "2019-08-24T14:15:22Z"  }]

Remove Compatible Macro

DELETE/api/v1/protocols/{id}/macros/{macroId}

Path Parameters

id*string

Formatuuid

macroId*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/protocols/497f6eca-6276-4993-bfeb-53cbbbba6f08/macros/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Global Search

GET/api/v1/search

Query Parameters

query*string

Search term

Length1 <= length <= 200

limit?integer

Range1 <= value <= 32

Default20

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/search?query=string"

{  "results": [    {      "type": "experiment",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "subtitle": "string",      "meta": "string"    }  ]}

List Grants

GET/api/v1/{resourceType}/{id}/collaborators

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/collaborators"

[  {    "kind": "owner",    "granteeType": "user",    "granteeId": "378a1ad2-6491-4618-ae2c-37033309d66a",    "organizationName": "string",    "grantee": {      "type": "user",      "displayName": "string",      "email": "string",      "avatarUrl": "string",      "memberCount": 0    },    "inertGrant": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "role": "owner"    }  }]

Create Grant

POST/api/v1/{resourceType}/{id}/collaborators

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

granteeType*string

Value in

"user"
"organization"
"team"

granteeId*string

Formatuuid

role?string

Default"viewer"

Value in

"admin"
"viewer"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/collaborators" \  -H "Content-Type: application/json" \  -d '{    "granteeType": "user",    "granteeId": "378a1ad2-6491-4618-ae2c-37033309d66a"  }'

[  {    "kind": "owner",    "granteeType": "user",    "granteeId": "378a1ad2-6491-4618-ae2c-37033309d66a",    "organizationName": "string",    "grantee": {      "type": "user",      "displayName": "string",      "email": "string",      "avatarUrl": "string",      "memberCount": 0    },    "inertGrant": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "role": "owner"    }  }]

Update Grant

PATCH/api/v1/{resourceType}/{id}/collaborators/{grantId}

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

grantId*string

ID of the grant to modify

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Value in

"admin"
"viewer"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/collaborators/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "role": "admin"  }'

[  {    "kind": "owner",    "granteeType": "user",    "granteeId": "378a1ad2-6491-4618-ae2c-37033309d66a",    "organizationName": "string",    "grantee": {      "type": "user",      "displayName": "string",      "email": "string",      "avatarUrl": "string",      "memberCount": 0    },    "inertGrant": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "role": "owner"    }  }]

Revoke Grant

DELETE/api/v1/{resourceType}/{id}/collaborators/{grantId}

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

grantId*string

ID of the grant to modify

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/collaborators/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Leave Resource

DELETE/api/v1/{resourceType}/{id}/collaborators/me

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/collaborators/me"

null

Search Grantee Organizations

GET/api/v1/grantee-organizations

Query Parameters

query?string

Name substring to match

limit?integer

Maximum number of organizations to return

Range1 <= value <= 50

Default20

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/grantee-organizations"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "slug": "string"  }]

Search Grantee Users

GET/api/v1/{resourceType}/{id}/grantee-users

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"
"device"
"device_group"

id*string

ID of the resource being shared

Formatuuid

Query Parameters

query?string

Name or email substring to match

limit?integer

Maximum number of users to return

Range1 <= value <= 50

Default20

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/grantee-users"

[  {    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "firstName": "string",    "lastName": "string",    "email": "string",    "avatarUrl": "string",    "organizationRole": "owner",    "existingGrantRole": "owner"  }]

Transfer Resource Admin

POST/api/v1/collaborators/transfer-admin

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transfers*array<>

Per-resource admin assignments

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/collaborators/transfer-admin" \  -H "Content-Type: application/json" \  -d '{    "transfers": [      {        "resourceType": "experiment",        "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",        "targetUserId": "73727401-c2dc-4b4b-ad9b-350075d6b049"      }    ]  }'

{  "results": [    {      "resourceType": "experiment",      "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",      "success": true,      "error": "string"    }  ]}

Transfer Resource Organization

POST/api/v1/{resourceType}/{id}/transfer

Path Parameters

resourceType*string

Value in

"experiment"
"macro"
"protocol"
"workbook"

id*string

ID of the resource being transferred

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

targetOrganizationId*string

Organization to move the resource to; the caller must be a member of it

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/experiment/497f6eca-6276-4993-bfeb-53cbbbba6f08/transfer" \  -H "Content-Type: application/json" \  -d '{    "targetOrganizationId": "899c5acf-391e-4605-9778-8e17de811b25"  }'

{  "resourceType": "experiment",  "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"}

Search Users

GET/api/v1/users/search

Query Parameters

query?string

Search query for name or email

limit?integer

Maximum number of users to return

Range1 <= value <= 100

Default50

offset?integer

Number of users to skip for pagination

Range0 <= value

Default0

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/users/search"

[  {    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "firstName": "string",    "lastName": "string",    "bio": "string",    "activated": true,    "email": "string",    "avatarUrl": "string"  }]

Get User

GET/api/v1/users/{id}

Path Parameters

id*string

ID of the user

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "email": "string",  "emailVerified": true,  "image": "string",  "createdAt": "2019-08-24T14:15:22Z",  "registered": true}

Delete User

DELETE/api/v1/users/{id}

Path Parameters

id*string

ID of the user

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Create User Profile

POST/api/v1/users/profile

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

firstName*string

First name

Length2 <= length

lastName*string

Last name

Length2 <= length

bio?string

Bio

activated?boolean

Whether the profile is active or deactivated

avatarUrl?|

Avatar URL seeded from OAuth provider

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/users/profile" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string"  }'

{}

Get User Profile

GET/api/v1/users/{id}/profile

Path Parameters

id*string

ID of the user

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/profile"

{  "firstName": "string",  "lastName": "string",  "bio": "string",  "activated": true,  "avatarUrl": "string"}

Get Deletion Blockers

GET/api/v1/users/{id}/deletion-blockers

Path Parameters

id*string

ID of the user

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/deletion-blockers"

{  "resources": [    {      "resourceType": "experiment",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "status": "active",      "candidates": [        {          "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",          "firstName": "string",          "lastName": "string",          "avatarUrl": "string"        }      ]    }  ],  "organizations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "slug": "string"    }  ]}

Get User Metadata

POST/api/v1/users/metadata

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userIds*array<string>

Items1 <= items <= 500

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/users/metadata" \  -H "Content-Type: application/json" \  -d '{    "userIds": [      "string"    ]  }'

{  "users": [    {      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "firstName": "string",      "lastName": "string",      "avatarUrl": "string"    }  ],  "success": true}

List Invitations

GET/api/v1/invitations

Query Parameters

resourceType*string

Value in

"platform"
"experiment"

resourceId*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/invitations?resourceType=platform&resourceId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "resourceType": "platform",    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "email": "user@example.com",    "tier": "admin",    "status": "pending",    "invitedBy": "9803bd85-1570-4d91-99f5-3a4d18ccfff0",    "invitedByName": "string",    "resourceName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create Invitation

POST/api/v1/invitations

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

resourceType*string

Value in

"platform"
"experiment"

resourceId*string

Formatuuid

email*string

Formatemail

tier?string

Access tier to grant on acceptance

Default"viewer"

Value in

"admin"
"viewer"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/invitations" \  -H "Content-Type: application/json" \  -d '{    "resourceType": "platform",    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "email": "user@example.com"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "resourceType": "platform",  "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",  "email": "user@example.com",  "tier": "admin",  "status": "pending",  "invitedBy": "9803bd85-1570-4d91-99f5-3a4d18ccfff0",  "invitedByName": "string",  "resourceName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Revoke Invitation

DELETE/api/v1/invitations/{invitationId}

Path Parameters

invitationId*string

ID of the invitation

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/invitations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Get Whats New Seen

GET/api/v1/whats-new/seen

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/whats-new/seen"

{  "lastSeenAt": "2019-08-24T14:15:22Z"}

Mark Whats New Seen

POST/api/v1/whats-new/seen

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/whats-new/seen" \  -H "Content-Type: application/json" \  -d '{}'

{  "lastSeenAt": "2019-08-24T14:15:22Z"}

List Workbooks

GET/api/v1/workbooks

Query Parameters

search?string

filter?"my"

Deprecated alias for scope=related

Value in

"my"

scope?string

Which slice of the accessible set to return

Value in

"related"
"all"

page?integer

1-based page number

Range1 <= value

pageSize?integer

Rows per page

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/workbooks"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "metadata": {      "property1": null,      "property2": null    },    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "organizationName": "string",    "visibility": "private",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",    "createdByName": "string",    "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "isUpgradable": true,    "experimentCount": 0,    "cellTypeCounts": {      "property1": 0,      "property2": 0    }  }]

Create Workbook

POST/api/v1/workbooks

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 255

description?string

cells?array<||||||>

metadata?

forkedFrom?string

Formatuuid

organizationId?string

Formatuuid

visibility?string

Value in

"private"
"public"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/workbooks" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "cells": [    {      "id": "string",      "isCollapsed": false,      "type": "protocol",      "payload": {        "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",        "version": 0,        "name": "string"      }    }  ],  "metadata": {    "property1": null,    "property2": null  },  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "isUpgradable": true,  "experimentCount": 0}

`application/json`

curl -X GET "https://example.com/api/v1/workbooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "cells": [    {      "id": "string",      "isCollapsed": false,      "type": "protocol",      "payload": {        "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",        "version": 0,        "name": "string"      }    }  ],  "metadata": {    "property1": null,    "property2": null  },  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "isUpgradable": true,  "experimentCount": 0,  "capabilities": {    "canContribute": true,    "canUpdate": true,    "canManage": true,    "canShare": true,    "canLeave": true,    "canTransfer": true  }}

Use the request body type in TypeScript.

name?string

Length1 <= length <= 255

description?string

cells?array<||||||>

metadata?

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/workbooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "cells": [    {      "id": "string",      "isCollapsed": false,      "type": "protocol",      "payload": {        "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",        "version": 0,        "name": "string"      }    }  ],  "metadata": {    "property1": null,    "property2": null  },  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "organizationName": "string",  "visibility": "private",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "createdByName": "string",  "forkedFrom": "3cd955ca-297d-4a34-9683-e3644d517064",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "isUpgradable": true,  "experimentCount": 0}

`application/json`

curl -X DELETE "https://example.com/api/v1/workbooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

Use the request body type in TypeScript.

visibility*string

Value in

"private"
"public"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/workbooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/visibility" \  -H "Content-Type: application/json" \  -d '{    "visibility": "private"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "visibility": "private"}

`application/json`

curl -X GET "https://example.com/api/v1/workbooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",    "version": 0,    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"  }]

Get Workbook Version

GET/api/v1/workbooks/{id}/versions/{versionId}

Path Parameters

id*string

Formatuuid

versionId*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/workbooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "workbookId": "e672ad0a-540a-4be9-9b09-cd316e2c706c",  "version": 0,  "cells": [    {      "id": "string",      "isCollapsed": false,      "type": "protocol",      "payload": {        "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",        "version": 0,        "name": "string"      }    }  ],  "metadata": {    "property1": null,    "property2": null  },  "entitySnapshots": {    "protocols": {      "property1": {        "code": null,        "family": "multispeq"      },      "property2": {        "code": null,        "family": "multispeq"      }    },    "macros": {      "property1": {        "code": "string"      },      "property2": {        "code": "string"      }    }  },  "createdAt": "2019-08-24T14:15:22Z",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"}

Authenticate with an API key

200application/json

201application/json

200application/json

200application/json

204application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

201application/json

200application/json

200application/json

201application/json

201application/json

200application/json

200application/json

200application/json

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

200application/json

204application/json

200application/json

201application/json

200application/json

204application/json

200application/json

201application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`