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.

post

Create/Update Experiment User

Body
idstringOptionalExample: user1
Responses
200
Set Group Membership
application/json
post
POST /api/init HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "id": "user1",
  "group": {
    "schoolId": [
      "school1"
    ],
    "classId": [
      "class1"
    ],
    "instructorId": [
      "instructor1"
    ]
  },
  "workingGroup": {
    "schoolId": "school1",
    "classId": "class1",
    "instructorId": "instructor1"
  }
}
200

Set Group Membership

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

Set group membership for a user

Body
idstringOptionalExample: user1
Responses
200
Set Group Membership
application/json
post
POST /api/groupmembership HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "id": "user1",
  "group": {
    "schoolId": [
      "school1"
    ],
    "classId": [
      "class1"
    ],
    "instructorId": [
      "instructor1"
    ]
  }
}
{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}
patch

Set group membership for a user

Body
idstringOptionalExample: user1
Responses
200
Set Group Membership
application/json
patch
PATCH /api/groupmembership HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "id": "user1",
  "group": {
    "schoolId": [
      "school1"
    ],
    "classId": [
      "class1"
    ],
    "instructorId": [
      "instructor1"
    ]
  }
}
{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}
post

Set working group for a user

Body
idstringOptionalExample: user1
Responses
200
Set Group Membership
application/json
post
POST /api/workinggroup HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "id": "user1",
  "workingGroup": {
    "schoolId": "school1",
    "classId": "class1",
    "instructorId": "instructor1"
  }
}
{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}
patch

Set working group for a user

Body
idstringOptionalExample: user1
Responses
200
Set Group Membership
application/json
patch
PATCH /api/workinggroup HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "id": "user1",
  "workingGroup": {
    "schoolId": "school1",
    "classId": "class1",
    "instructorId": "instructor1"
  }
}
{
  "id": "text",
  "group": {
    "class": [
      {}
    ]
  },
  "workingGroup": {
    "school": "text",
    "class": "text",
    "instructor": "text"
  }
}
post

Assign a Experiment Point

Body
userIdstringOptionalExample: user1
contextstringOptionalExample: add
Responses
200
Experiment Point is Assigned
application/json
post
POST /api/assign HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "userId": "user1",
  "context": "add"
}
[
  {
    "site": "text",
    "target": "text",
    "condition": "text"
  }
]
post

Mark a Experiment Point

Body
userIdstringRequired
sitestringOptional
targetstringOptionalExample: partition1
conditionstringRequiredExample: control
statusstringOptionalExample: condition applied
experimentIdstringOptionalExample: exp1
Responses
200
Experiment Point is Marked
application/json
post
POST /api/mark HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "userId": "text",
  "site": "text",
  "target": "partition1",
  "condition": "control",
  "status": "condition applied",
  "experimentId": "exp1"
}
{
  "id": "text",
  "experimentId": "text",
  "site": "text",
  "target": "text",
  "condition": "text"
}
post

Post log data

Body
userIdstringOptional
Responses
200
Log data
post
POST /api/log HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "userId": "text",
  "value": [
    {
      "userId": "user1",
      "metrics": {
        "attributes": {
          "continuousMetricName": 100,
          "categoricalMetricName": "CATEGORY"
        },
        "groupedMetrics": [
          {
            "groupClass": "workspaceType",
            "groupKey": "workspaceName",
            "attributes": {
              "continuousMetricName": 100,
              "categoricalMetricName": "CATEGORY"
            }
          }
        ]
      }
    }
  ]
}
No content
get

Get all metrics tracked

Responses
200
Get all Metrics
get
GET /api/metric HTTP/1.1
Host: 
Accept: */*
200

Get all Metrics

No content
post

Add filter metrics

Body
metricUnitobjectOptional
Responses
200
Filtered Metrics
post
POST /api/metric HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "metricUnit": {}
}
No content
PreviousReferenceNextClient Libraries

Last updated