List experiments
Changed on[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.
List all experiments of the specified Application that match your filter criteria.
Request
- Base URLhttps://yourbaseurl.talon.one
- Auth
- API key in header Authorization
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The ID of the Application. It is displayed in your Talon.One deployment URL.
Query parameters
The number of items in the response.
The number of items to skip when paging through large result sets.
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.
Note: You may not be able to use all fields for sorting. This is due to performance limitations.
Response
OK
Example response
{
"totalResultSize": 1,
"data": [
{
"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"applicationId": 322,
"assignmentType": "random",
"campaign": {
"id": 4,
"created": "2020-06-10T09:05:27.993483Z",
"applicationId": 322,
"userId": 388,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"state": "enabled",
"activeRulesetId": 6,
"tags": [
"summer"
],
"reevaluateOnReturn": true,
"features": [
"coupons",
"referrals"
],
"couponSettings": {
"validCharacters": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {
"validCharacters": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"Z",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [
{
"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": [
"Coupon"
]
}
],
"campaignGroups": [
1,
3
],
"type": "advanced",
"linkedStoreIds": [
1,
2,
3
],
"budgets": [
{
"action": "createCoupon",
"limit": 1000,
"counter": 42
}
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"referralCreationCount": 8,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"reservecouponEffectCount": 9,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-27T15:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"templateId": 3,
"frontendState": "running",
"storesImported": true,
"valueMapsIds": [
100,
215
],
"experimentId": 1,
"revisionFrontendState": "revised",
"activeRevisionId": 6,
"activeRevisionVersionId": 6,
"version": 6,
"currentRevisionId": 6,
"currentRevisionVersionId": 6
},
"state": "enabled",
"variants": [
{
"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"name": "Variant A",
"experimentId": 10,
"ruleset": {
"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"userId": 388,
"rules": [
{
"id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [
{
"name": "Discount percentage",
"type": "templateParameter",
"expression": [
"identity",
10
],
"valueType": "number",
"maxValue": 19.9,
"attributeId": 100,
"description": "The percentage discount applied to the cart total."
}
],
"condition": [
"and",
[
"couponValid"
]
],
"effects": [
"catch",
[
"noop"
],
[
"setDiscount",
"10% off",
[
"*",
[
".",
"Session",
"Total"
],
[
"/",
10,
100
]
]
]
]
}
],
"strikethroughRules": [
{
"id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [
{
"name": "Discount percentage",
"type": "templateParameter",
"expression": [
"identity",
10
],
"valueType": "number",
"maxValue": 19.9,
"attributeId": 100,
"description": "The percentage discount applied to the cart total."
}
],
"condition": [
"and",
[
"couponValid"
]
],
"effects": [
"catch",
[
"noop"
],
[
"setDiscount",
"10% off",
[
"*",
[
".",
"Session",
"Total"
],
[
"/",
10,
100
]
]
]
]
}
],
"bindings": [],
"rbVersion": "v2",
"activate": true,
"campaignId": 320,
"templateId": 3
},
"weight": 12,
"isPrimary": true,
"audienceId": 55
}
],
"goalDescription": "Offering free shipping will increase average order revenue more than a 10% discount"
}
]
}Changes
- breaking
the response property
//////became optional for the status - info
added the optional property
///to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
response property
data/items/allOf[subschema #3]/isVariantAssignmentExternaldeprecated - info
response property
data/items/allOf[subschema #3]/variants/items/allOf[subschema #2]/isPrimarydeprecated
- breaking