Request feature flag's results

Send a request to generate the report for the results of the given feature flag

POST /feature-flags/{featureFlagId}/results

Request feature flag's results

cURL

curl --request POST \
  --url https://api.kameleoon.com/feature-flags/{featureFlagId}/results \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateIntervals": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "visitorData": false,
  "allVariationsData": false,
  "bayesian": false,
  "sequentialTesting": false,
  "enabledMultipleTesting": false,
  "referenceVariationId": "<string>",
  "breakdown": {},
  "goalsIds": [
    123
  ],
  "goalIdsCuped": [
    123
  ],
  "filters": [
    {
      "type": "<string>",
      "include": true
    }
  ],
  "callbackUrl": "<string>"
}
'

200

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

featureFlagId · integer<int64> · required

Body

application/json

dateIntervals · object[] · required

Date boundaries to include only the results from the specified time period(s).

Show child attributes

conversionType · enum<string> · required

Type of conversions to use for calculating reliability, improvement rate and etc

Available options: ALL_CONVERSION, CONVERTED_VISITS

visitorData · boolean · default: false

Set to true to only include data from unique visitors. By default, the report includes all visitor data.

allVariationsData · boolean · default: false

Set to true to include data from all variations at once.

bayesian · boolean · default: false

Enables the current Bayesian result probability for the experiment in the report.

sequentialTesting · boolean · default: false

Enables the sequential testing result for the experiment in the report.

enabledMultipleTesting · boolean · default: false

Enables multiple testing correction for the experiment in the report.

referenceVariationId · string

Unique ID of the variation that you want to use as the reference variation.

breakdown · object

Breakdown request argument for splitting data

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

goalsIds · integer<int64>[]

Specifies which goals to include in the report. Use an empty list [] to exclude all goals. Use null to include all goals. Use a list of goal IDs [123, 456] to include only those goals.

Specifies which goals to include in the report. Use an empty list [] to exclude all goals. Use null to include all goals. Use a list of goal IDs [123, 456] to include only those goals.

goalIdsCuped · integer<int64>[]

Specifies which CUPED goals to include in the report. Use an empty list [] to exclude all CUPED goals. Use null to include all CUPED goals. Use a list of CUPED goal IDs [123, 456] to include only those goals.

Specifies which CUPED goals to include in the report. Use an empty list [] to exclude all CUPED goals. Use null to include all CUPED goals. Use a list of CUPED goal IDs [123, 456] to include only those goals.

filters · object[]

List of filters to apply to the data included in the report.

List of filters to apply to the data included in the report.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Show child attributes

callbackUrl · string

Callback URL that you want to send the data response to.

Response

200

*/*

OK

dataCode · string

Hash code containing information about the data request, such as dates, goals, variations, format, filters, and so on. Use this code in the AudienceController#poll or DataController functions to obtain actual results. There are two possible formats for the code, depending on the context: 123...123 or 123...123|123...123. For example, AudienceController#global generates the latter.

Example:

"89599333501501534304101214660291496129464311669540935471556471877530843827432"