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

/init

Body

idstring

Example: user1

workingGroupobject

groupobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/init' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "user1",
    "workingGroup": {
      "schoolId": "school1",
      "classId": "class1",
      "instructorId": "instructor1"
    },
    "group": {
      "schoolId": [
        "school1"
      ],
      "classId": [
        "class1"
      ],
      "instructorId": [
        "instructor1"
      ]
    }
  }'

200

200

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

Set Group Membership

Set group membership for a user

post

/groupmembership

Body

idstring

Example: user1

groupobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/groupmembership' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "user1",
    "group": {
      "schoolId": [
        "school1"
      ],
      "classId": [
        "class1"
      ],
      "instructorId": [
        "instructor1"
      ]
    }
  }'

200

500

200

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

Set Group Membership

Set group membership for a user

patch

/groupmembership

Body

idstring

Example: user1

groupobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/groupmembership' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "user1",
    "group": {
      "schoolId": [
        "school1"
      ],
      "classId": [
        "class1"
      ],
      "instructorId": [
        "instructor1"
      ]
    }
  }'

200

500

200

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

Set Group Membership

Set working group for a user

post

/workinggroup

Body

idstring

Example: user1

workingGroupobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/workinggroup' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "user1",
    "workingGroup": {
      "schoolId": "school1",
      "classId": "class1",
      "instructorId": "instructor1"
    }
  }'

200

500

200

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

Set Group Membership

Set working group for a user

patch

/workinggroup

Body

idstring

Example: user1

workingGroupobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/workinggroup' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "user1",
    "workingGroup": {
      "schoolId": "school1",
      "classId": "class1",
      "instructorId": "instructor1"
    }
  }'

200

500

200

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

Set Group Membership

Assign a Experiment Point

post

/assign

Body

userIdstring

Example: user1

contextstring

Example: add

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/assign' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "user1",
    "context": "add"
  }'

200

404

500

200

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

Experiment Point is Assigned

Mark a Experiment Point

post

/mark

Body

userIdstringrequired

sitestring

targetstring

Example: partition1

conditionstringrequired

Example: control

statusstring

Example: condition applied

experimentIdstring

Example: exp1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/mark' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "text",
    "site": "text",
    "target": "partition1",
    "condition": "control",
    "status": "condition applied",
    "experimentId": "exp1"
  }'

200

500

200

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

Experiment Point is Marked

Post log data

post

/log

Body

userIdstring

valueobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/log' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "text",
    "value": [
      {
        "userId": "user1",
        "metrics": {
          "attributes": {
            "continuousMetricName": 100,
            "categoricalMetricName": "CATEGORY"
          },
          "groupedMetrics": [
            {
              "groupClass": "workspaceType",
              "groupKey": "workspaceName",
              "attributes": {
                "continuousMetricName": 100,
                "categoricalMetricName": "CATEGORY"
              }
            }
          ]
        }
      }
    ]
  }'

200

500

200

No body

Log data

Get all metrics tracked

get

/metric

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/metric'

200

200

No body

Get all Metrics

Add filter metrics

post

/metric

Body

metricUnitobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/metric' \
  --header 'Content-Type: application/json' \
  --data '{
    "metricUnit": {}
  }'

200

500

200

No body

Filtered Metrics