v1.0

OAS 2.0

Bucketeer Gateway Service

Server

https://ENDPOINT

Client Libraries

Shell Curl

Client and Server SDKs

Client and Server SDKs Operations

post/get_evaluation
post/get_evaluations
post/get_feature_flags
post/get_segment_users
post/register_events
get/track

Get Evaluation

Gets a single evaluation for a specific user. To call this API, you need a CLIENT API Key role.

Body

required

application/json

featureId
Type: string
sdkVersion
Type: string
sourceId
Type: stringenum
default:
"UNKNOWN"
- UNKNOWN
- ANDROID
- IOS
- WEB
- GO_SERVER
tag
Type: string
user
Type: object

Responses

application/json
application/json
application/json
application/json
application/json

post/get_evaluation

curl https://ENDPOINT/get_evaluation \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "tag": "",
  "user": {
    "id": "",
    "data": {
      "propertyName*": ""
    },
    "taggedData": {
      "propertyName*": {
        "value": {
          "propertyName*": ""
        }
      }
    },
    "lastSeen": "",
    "createdAt": ""
  },
  "featureId": "",
  "sourceId": "UNKNOWN",
  "sdkVersion": ""
}'

Show Schema

{
  "evaluation": {
    "id": "string",
    "featureId": "string",
    "featureVersion": 1,
    "userId": "string",
    "variationId": "string",
    "variation": {
      "id": "string",
      "value": "string",
      "name": "string",
      "description": "string"
    },
    "reason": {
      "type": "TARGET",
      "ruleId": "string"
    },
    "variationValue": "string",
    "variationName": "string"
  }
}

A successful response.

Get Evaluations

Gets all the evaluations for a specific user. To call this API, you need a CLIENT API Key role.

Body

required

application/json

featureId
Type: instead, use GetEvaluation API
sdkVersion
Type: string
sourceId
Type: stringenum
default:
"UNKNOWN"
- UNKNOWN
- ANDROID
- IOS
- WEB
- GO_SERVER
tag
Type: string
user
Type: object
userEvaluationCondition
Type: object
userEvaluationsId
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

post/get_evaluations

curl https://ENDPOINT/get_evaluations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "tag": "",
  "user": {
    "id": "",
    "data": {
      "propertyName*": ""
    },
    "taggedData": {
      "propertyName*": {
        "value": {
          "propertyName*": ""
        }
      }
    },
    "lastSeen": "",
    "createdAt": ""
  },
  "userEvaluationsId": "",
  "featureId": "",
  "sourceId": "UNKNOWN",
  "userEvaluationCondition": {
    "evaluatedAt": "",
    "userAttributesUpdated": true
  },
  "sdkVersion": ""
}'

Show Schema

{
  "state": "QUEUED",
  "evaluations": {
    "id": "string",
    "evaluations": [
      {
        "id": "string",
        "featureId": "string",
        "featureVersion": 1,
        "userId": "string",
        "variationId": "string",
        "variation": {
          "id": "string",
          "value": "string",
          "name": "string",
          "description": "string"
        },
        "reason": {
          "type": "TARGET",
          "ruleId": "string"
        },
        "variationValue": "string",
        "variationName": "string"
      }
    ],
    "createdAt": "string",
    "archivedFeatureIds": [
      "string"
    ],
    "forceUpdate": true
  },
  "userEvaluationsId": "string"
}

A successful response.

Get Feature Flags

Gets all the feature flag in an environment. To call this API, you need a SERVER API Key role.

Body

required

application/json

featureFlagsId
Type: string
requestedAt
Type: stringFormat: int64
sdkVersion
Type: string
sourceId
Type: stringenum
default:
"UNKNOWN"
- UNKNOWN
- ANDROID
- IOS
- WEB
- GO_SERVER
tag
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

post/get_feature_flags

curl https://ENDPOINT/get_feature_flags \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "tag": "",
  "featureFlagsId": "",
  "requestedAt": "",
  "sourceId": "UNKNOWN",
  "sdkVersion": ""
}'

Show Schema

{
  "featureFlagsId": "string",
  "features": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "deleted": true,
      "evaluationUndelayable": true,
      "ttl": 1,
      "version": 1,
      "createdAt": "string",
      "updatedAt": "string",
      "variations": [
        {
          "id": "string",
          "value": "string",
          "name": "string",
          "description": "string"
        }
      ],
      "targets": [
        {
          "variation": "string",
          "users": [
            "string"
          ]
        }
      ],
      "rules": [
        {
          "id": "string",
          "strategy": {
            "type": "FIXED",
            "fixedStrategy": {
              "variation": "string"
            },
            "rolloutStrategy": {
              "variations": [
                {
                  "variation": "string",
                  "weight": 1
                }
              ],
              "audience": {
                "percentage": 1,
                "defaultVariation": "string"
              }
            }
          },
          "clauses": [
            {
              "id": "string",
              "attribute": "string",
              "operator": "EQUALS",
              "values": [
                "string"
              ]
            }
          ]
        }
      ],
      "defaultStrategy": {
        "type": "FIXED",
        "fixedStrategy": {
          "variation": "string"
        },
        "rolloutStrategy": {
          "variations": [
            {
              "variation": "string",
              "weight": 1
            }
          ],
          "audience": {
            "percentage": 1,
            "defaultVariation": "string"
          }
        }
      },
      "offVariation": "string",
      "tags": [
        "string"
      ],
      "lastUsedInfo": {
        "featureId": "string",
        "version": 1,
        "lastUsedAt": "string",
        "createdAt": "string",
        "clientOldestVersion": "string",
        "clientLatestVersion": "string"
      },
      "maintainer": "string",
      "variationType": "STRING",
      "archived": true,
      "prerequisites": [
        {
          "featureId": "string",
          "variationId": "string"
        }
      ],
      "samplingSeed": "string",
      "autoOpsSummary": {
        "progressiveRolloutCount": 1,
        "scheduleCount": 1,
        "killSwitchCount": 1
      }
    }
  ],
  "archivedFeatureFlagIds": [
    "string"
  ],
  "requestedAt": "string",
  "forceUpdate": true
}

A successful response.

Get Segment Users

Gets all the segment users in an environment. To call this API, you need a SERVER API Key role.

Body

required

application/json

requestedAt
Type: stringFormat: int64
sdkVersion
Type: string
segmentIds
Type: array string[]
sourceId
Type: stringenum
default:
"UNKNOWN"
- UNKNOWN
- ANDROID
- IOS
- WEB
- GO_SERVER

Responses

application/json
application/json
application/json
application/json
application/json

post/get_segment_users

curl https://ENDPOINT/get_segment_users \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "segmentIds": [
    ""
  ],
  "requestedAt": "",
  "sourceId": "UNKNOWN",
  "sdkVersion": ""
}'

Show Schema

{
  "segmentUsers": [
    {
      "segmentId": "string",
      "users": [
        {
          "id": "string",
          "segmentId": "string",
          "userId": "string",
          "state": "INCLUDED",
          "deleted": true
        }
      ],
      "updatedAt": "string"
    }
  ],
  "deletedSegmentIds": [
    "string"
  ],
  "requestedAt": "string",
  "forceUpdate": true
}

A successful response.

Register Events

This API is for reporting Goal events. To call this API, you need a CLIENT or SERVER API Key role.

Body

required

application/json

events
Type: array eventclientEvent[]
sdkVersion
Type: string
sourceId
Type: stringenum
default:
"UNKNOWN"
- UNKNOWN
- ANDROID
- IOS
- WEB
- GO_SERVER

Responses

application/json
application/json
application/json
application/json
application/json

post/register_events

curl https://ENDPOINT/register_events \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "events": [
    {
      "id": "",
      "event": {
        "@type": "",
        "propertyName*": "anything"
      },
      "environmentId": ""
    }
  ],
  "sdkVersion": "",
  "sourceId": "UNKNOWN"
}'

Show Schema

{
  "errors": {
    "propertyName*": {
      "retriable": true,
      "message": "string"
    }
  }
}

A successful response.

Track

This API is an integration for Google Tab Manager to report Goal events. To call this API, you need a CLIENT API Key role.

Query Parameters

apikey
Type: string
userid
Type: string
goalid
Type: string
tag
Type: string
timestamp
Type: stringFormat: int64
value
Type: numberFormat: double

Responses

application/json
application/json
application/json
application/json
application/json

get/track

curl 'https://ENDPOINT/track?apikey=&userid=&goalid=&tag=&timestamp=&value=1' \
  --header 'authorization: YOUR_SECRET_TOKEN'

Show Schema

{}

A successful response.

Utility (Collapsed)

Utility Operations

get/ping

Account (Collapsed)

Account Operations

get/v1/account
post/v1/account
patch/v1/account
get/v1/account/get_account_by_environment
get/v1/account/get_me
get/v1/accounts

Audit Logs (Collapsed)

Audit Logs Operations

get/v1/audit_log
get/v1/audit_logs
get/v1/feature_history

Auto Ops Rules (Collapsed)

Auto Ops Rules Operations

get/v1/auto_ops_rule
delete/v1/auto_ops_rule
post/v1/auto_ops_rule
patch/v1/auto_ops_rule
post/v1/auto_ops_rule/execute
post/v1/auto_ops_rule/stop
get/v1/auto_ops_rules

Code References (Collapsed)

Code References Operations

get/v1/code_reference
delete/v1/code_reference
post/v1/code_reference
patch/v1/code_reference
get/v1/code_references

Feature Flags (Collapsed)

Feature Flags Operations

post/v1/debug_evaluate_features
get/v1/feature
post/v1/feature
patch/v1/feature
get/v1/features

Environment (Collapsed)

Environment Operations

get/v1/environment/get_environment
get/v1/environment/list_environments

Project (Collapsed)

Project Operations

get/v1/environment/get_project
get/v1/environment/list_projects

Event Counter (Collapsed)

Event Counter Operations

get/v1/event_counter/evaluation_timeseries_count
get/v1/event_counter/experiment_evaluation_count
get/v1/event_counter/experiment_goal_count
get/v1/event_counter/experiment_result
get/v1/event_counter/experiment_results
get/v1/event_counter/ops_evaluation_user_count
get/v1/event_counter/ops_goal_user_count

Experiments (Collapsed)

Experiments Operations

get/v1/experiment
post/v1/experiment
patch/v1/experiment
get/v1/experiments

Flag Triggers (Collapsed)

Flag Triggers Operations

get/v1/flag_trigger
delete/v1/flag_trigger
post/v1/flag_trigger
patch/v1/flag_trigger
get/v1/flag_triggers

Goals (Collapsed)

Goals Operations

get/v1/goal
delete/v1/goal
post/v1/goal
patch/v1/goal
get/v1/goals

Progressive Rollouts (Collapsed)

Progressive Rollouts Operations

get/v1/progressive_rollout
delete/v1/progressive_rollout
post/v1/progressive_rollout
post/v1/progressive_rollout/execute
patch/v1/progressive_rollout/stop
get/v1/progressive_rollouts

Pushes (Collapsed)

Pushes Operations

get/v1/push
post/v1/push
patch/v1/push
get/v1/pushes

Segments (Collapsed)

Segments Operations

get/v1/segment
delete/v1/segment
post/v1/segment
patch/v1/segment
post/v1/segment/bulk_upload_users
get/v1/segments

Subscriptions (Collapsed)

Subscriptions Operations

get/v1/subscription
delete/v1/subscription
post/v1/subscription
patch/v1/subscription
get/v1/subscriptions

Tags (Collapsed)

Tags Operations

delete/v1/tag
post/v1/tag
get/v1/tags

Teams (Collapsed)

Teams Operations

delete/v1/team
post/v1/team
get/v1/teams

Header Enabled	Header Key	Header Value
	Accept	/
	Content-Type	application/json
	Key	Value

Bucketeer Gateway Service

AuthenticationRequired

Client and Server SDKs

Get Evaluation

Get Evaluations

Get Feature Flags

Get Segment Users

Register Events

Track

Utility (Collapsed)

Account (Collapsed)

Audit Logs (Collapsed)

Auto Ops Rules (Collapsed)

Code References (Collapsed)

Feature Flags (Collapsed)

Environment (Collapsed)

Project (Collapsed)

Event Counter (Collapsed)

Experiments (Collapsed)

Flag Triggers (Collapsed)

Goals (Collapsed)

Progressive Rollouts (Collapsed)

Pushes (Collapsed)

Segments (Collapsed)

Subscriptions (Collapsed)

Tags (Collapsed)

Teams (Collapsed)

AuthenticationRequired

Variables

Cookies

Headers

Query Parameters

Body

Code Snippet (Collapsed)