API

Swagger API details

This is a snapshot of swagger.json file at time of this release. You can also view the 'live' swagger API documentation details for your hosted backend environment by adding /swagger to your backend hostUrl link.

Create/Update Experiment User

POST/api/init

Body

application/json

ExperimentUser

idstring

Example: "user1"

groupobject

workingGroupobject

Response

200

Set Group Membership

Body

application/json

id*string

group*object

workingGroup*object

Request

JavaScriptCurlPython

const response = await fetch('/api/init', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}

Set group membership for a user

POST/api/groupmembership

Body

application/json

ExperimentUser

idstring

Example: "user1"

groupobject

Response

200500

Set Group Membership

Body

application/json

id*string

group*object

workingGroup*object

Request

JavaScriptCurlPython

const response = await fetch('/api/groupmembership', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}

Set group membership for a user

PATCH/api/groupmembership

Body

application/json

ExperimentUser

idstring

Example: "user1"

groupobject

Response

200500

Set Group Membership

Body

application/json

id*string

group*object

workingGroup*object

Request

JavaScriptCurlPython

const response = await fetch('/api/groupmembership', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}

Set working group for a user

POST/api/workinggroup

Body

application/json

ExperimentUser

idstring

Example: "user1"

workingGroupobject

Response

200500

Set Group Membership

Body

application/json

id*string

group*object

workingGroup*object

Request

JavaScriptCurlPython

const response = await fetch('/api/workinggroup', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}

Set working group for a user

PATCH/api/workinggroup

Body

application/json

ExperimentUser

idstring

Example: "user1"

workingGroupobject

Response

200500

Set Group Membership

Body

application/json

id*string

group*object

workingGroup*object

Request

JavaScriptCurlPython

const response = await fetch('/api/workinggroup', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}

Assign a Experiment Point

POST/api/assign

Body

application/json

User Document

userIdstring

Example: "user1"

contextstring

Example: "add"

Response

200404500

Experiment Point is Assigned

Body

application/json

site*string

target*string

condition*string

Request

JavaScriptCurlPython

const response = await fetch('/api/assign', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

[
  {
    "site": "text",
    "target": "text",
    "condition": "text"
  }
]

Mark a Experiment Point

POST/api/mark

Body

application/json

ExperimentUser

userId*string

sitestring

targetstring

Example: "partition1"

condition*string

Example: "control"

statusstring

Example: "condition applied"

experimentIdstring

Example: "exp1"

Response

200500

Experiment Point is Marked

Body

application/json

id*string

experimentId*string

sitestring

targetstring

condition*string

Request

JavaScriptCurlPython

const response = await fetch('/api/mark', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "condition": "control",
      "userId": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "experimentId": "text",
  "site": "text",
  "target": "text",
  "condition": "text"
}

Post log data

POST/api/log

Body

application/json

User Document

userIdstring

valuearray of object

Response

200500

Log data

Request

JavaScriptCurlPython

const response = await fetch('/api/log', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get all metrics tracked

GET/api/metric

Response

200

Get all Metrics

Request

JavaScriptCurlPython

const response = await fetch('/api/metric', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Add filter metrics

POST/api/metric

Body

application/json

Filtered Metrics

metricUnitobject

Response

200500

Filtered Metrics

Request

JavaScriptCurlPython

const response = await fetch('/api/metric', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();