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
user1
POST /api/v5/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"
}
}
{
"id": "text",
"group": {
"class": [
"text"
]
},
"workingGroup": {
"school": "text",
"class": "text",
"instructor": "text"
}
}
Set group membership for a user
user1
PATCH /api/v5/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": [
"text"
]
},
"workingGroup": {
"school": "text",
"class": "text",
"instructor": "text"
}
}
Set working group for a user
user1
PATCH /api/v5/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": [
"text"
]
},
"workingGroup": {
"school": "text",
"class": "text",
"instructor": "text"
}
}
Mark a Experiment Point
condition applied
POST /api/v5/mark HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 161
{
"userId": "text",
"data": {
"site": "text",
"target": "partition1",
"assignedCondition": {
"conditionCode": "control"
},
"experimentId": "exp1"
},
"status": "condition applied"
}
{
"id": "text",
"userId": "text",
"experimentId": "text",
"site": "text",
"target": "text",
"condition": "text"
}
Assign a Experiment Point
user1
add
POST /api/v5/assign HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"userId": "user1",
"context": "add"
}
[
{
"site": "text",
"target": "text",
"experimentType": "Simple",
"assignedCondition": [
{
"conditionCode": "text",
"payload": {
"type": "text",
"value": "text"
},
"id": "text",
"experimentId": "text"
}
]
}
]
Post log data
POST /api/v5/log HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 331
{
"userId": "text",
"value": [
{
"timestamp": "text",
"metrics": {
"attributes": {
"continuousMetricName": 100,
"categoricalMetricName": "CATEGORY"
},
"groupedMetrics": [
{
"groupClass": "workspaceType",
"groupKey": "workspaceName",
"groupUniquifier": "workspaceUniquifier",
"attributes": {
"continuousMetricName": 100,
"categoricalMetricName": "CATEGORY"
}
}
]
}
}
]
}
No content
Post blob log data
POST /api/v5/bloblog HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"userId": "text",
"value": [
{}
]
}
No content
Get all feature flags using SDK
User Document
user1
add
POST /api/v5/featureflag HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"userId": "user1",
"context": "add"
}
No content
Set aliases for current user
user1
PATCH /api/v5/useraliases HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"userId": "user1",
"aliases": [
"alias123"
]
}
{
"userId": "text",
"aliases": [
"text"
]
}
Create/Update Experiment User
POST /api/v6/init HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 172
{
"group": {
"schoolId": [
"school1"
],
"classId": [
"class1"
],
"instructorId": [
"instructor1"
]
},
"workingGroup": {
"schoolId": "school1",
"classId": "class1",
"instructorId": "instructor1"
}
}
{
"id": "text",
"group": {
"class": [
"text"
]
},
"workingGroup": {
"school": "text",
"class": "text",
"instructor": "text"
}
}
Set group membership for a user
PATCH /api/v6/groupmembership HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"group": {
"schoolId": [
"school1"
],
"classId": [
"class1"
],
"instructorId": [
"instructor1"
]
}
}
{
"id": "text",
"group": {
"class": [
"text"
]
},
"workingGroup": {
"school": "text",
"class": "text",
"instructor": "text"
}
}
Set working group for a user
PATCH /api/v6/workinggroup HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"workingGroup": {
"schoolId": "school1",
"classId": "class1",
"instructorId": "instructor1"
}
}
{
"id": "text",
"group": {
"class": [
"text"
]
},
"workingGroup": {
"school": "text",
"class": "text",
"instructor": "text"
}
}
Mark a Experiment Point
condition applied
POST /api/v6/mark HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 145
{
"data": {
"site": "text",
"target": "partition1",
"assignedCondition": {
"conditionCode": "control"
},
"experimentId": "exp1"
},
"status": "condition applied"
}
{
"id": "text",
"userId": "text",
"experimentId": "text",
"site": "text",
"target": "text",
"condition": "text"
}
Assign a Experiment Point
add
POST /api/v6/assign HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"context": "add"
}
[
{
"site": "text",
"target": "text",
"experimentType": "Simple",
"assignedCondition": [
{
"conditionCode": "text",
"payload": {
"type": "text",
"value": "text"
},
"id": "text",
"experimentId": "text"
}
]
}
]
Post log data
POST /api/v6/log HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 315
{
"value": [
{
"timestamp": "text",
"metrics": {
"attributes": {
"continuousMetricName": 100,
"categoricalMetricName": "CATEGORY"
},
"groupedMetrics": [
{
"groupClass": "workspaceType",
"groupKey": "workspaceName",
"groupUniquifier": "workspaceUniquifier",
"attributes": {
"continuousMetricName": 100,
"categoricalMetricName": "CATEGORY"
}
}
]
}
}
]
}
No content
Get all feature flags using SDK
User Document
add
POST /api/v6/featureflag HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"context": "add"
}
No content
Set aliases for current user
PATCH /api/v6/useraliases HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"aliases": [
"alias123"
]
}
{
"userId": "text",
"aliases": [
"text"
]
}
Last updated