JUMP TOCTRL-/

Rest APIS

• About the Feature Experimentation APIs
• Generate tokens and use the REST APIs
• REST API cookbook

Eyeofcloud Feature Experimentation API

• Environments
  • List Environmentsget
  • Create or Update Environmentspatch
• Flags
  • List Flagsget
  • Update Flagspatch
  • Create a New Flagpost
  • Archive Flagspost
  • Unarchive Flagspost
  • Delete a Flagdelete
  • Fetch a Single Flagget
• Reports
  • List Reportsget
  • Archive Reportspost
  • Unarchive Reportspost
  • Delete a Reportdelete
  • Fetch a Single Reportget
  • Reset the results for a Reportpost
• Rulesets
  • Fetch the Ruleset for a Flag in an Environmentget
  • Update the Ruleset for a Flag in an Environmentpatch
  • Disable the Ruleset for a Flag in an Environmentpost
  • Enable the Ruleset for a Flag in an Environmentpost
• Rules
  • Fetch the Rule for a Ruleset in an Environmentget
  • List Rulesget
  • Fetch a Rule for a specific experiment_idget
• Variations
  • List Variationsget
  • Update Variationspatch
  • Create a New Variationpost
  • Archive Variationspost
  • Brainstorm variations definitions using AI.post
  • Unarchive Variationspost
  • Delete a Variationdelete
  • Fetch a Single Variationget
• Groups
  • List Exclusion Groupsget
  • Update Exclusion Groupspatch
  • Create an Exclusion Grouppost
  • Archive Exclusion Groupspost
  • Unarchive Exclusion Groupspost
  • Delete an Exclusion Groupdelete
  • Fetch a Single Exclusion Groupget
• Variable Definitions
  • Fetch all variable definitions for flag.get
  • Update Variable Definitionspatch
  • Create Variable Definitionpost
  • Brainstorm variable definitions using AI.post
  • Delete a Variable Definitiondelete
  • Fetch a single variable definition by its key.get
• Changes
  • Get Change Historyget

Eyeofcloud API

• Overview
• Projects
  • List Projectsget
  • Create a Projectpost
  • Read a Projectget
  • Update a Projectpatch
• Campaigns
  • List Campaignsget
  • Create a Campaignpost
  • Archive a Campaigndelete
  • Read a Campaignget
  • Update a Campaignpatch
  • Get Campaign resultsget
  • Get a sharable link for the campaign's results pageget
  • Get Campaign results as a CSVget
• Experiments
  • List Experimentsget
  • Create an Experimentpost
  • Archive an Experimentdelete
  • Read an Experimentget
  • Update an Experimentpatch
  • Get Experiment resultsget
  • Get a sharable link for the experiment's results pageget
  • Get Experiment results time seriesget
  • Get Experiment results as a CSVget
• Audiences
  • List Audiencesget
  • Create an Audiencepost
  • Read an Audienceget
  • Update an Audiencepatch
• Pages
  • List Pagesget
  • Create a Pagepost
  • Archived a Pagedelete
  • Read a pageget
  • Update a Pagepatch
• Events
  • List all Eventsget
  • Get Event by IDget
  • Create an In-Page Eventpost
  • Archive an In-Page Eventdelete
  • Update an In-Page Eventpatch
  • Create a Custom Eventpost
  • Archive a Custom Eventdelete
  • Update a Custom Eventpatch
• Attributes
  • List Attributesget
  • Create an Attributepost
  • Archive an Attributedelete
  • Read an Attributeget
  • Update an Attributepatch
• Groups
  • List Exclusion Groupsget
  • Create an Exclusion Grouppost
  • Archive an Exclusion Groupdelete
  • Get an Exclusion Groupget
  • Update an Exclusion Grouppatch
• Extensions
  • List Extensionsget
  • Create an Extensionpost
  • Archive an Extensiondelete
  • Get an Extensionget
  • Update an Extensionpatch
• Plan
  • Get Plan & Usage information for all productsget
• Scheduled Jobs
  • Get a list of Scheduled Jobsget
  • Create a Scheduled Jobpost
  • Archive a Scheduled Jobdelete
  • Get a Scheduled Jobget
  • Update a Scheduled Jobpatch
• User
  • Get current User informationget
• List Attributes
  • Get list attributes by projectget
  • Create a List Attributepost
  • Archive a List Attributedelete
  • Read a List Attributeget
  • Update a List Attributepatch
• Sections
  • Read all the Sections in a Multivariate Testget
  • Create a new Section in a Multivariate Testpost
  • Archive a Section by IDdelete
  • Read a Section of a Multivariate Testget
  • Update a Section by IDpatch
• Features
  • Get Features by Projectget
  • Create a Featurepost
  • Archive a Featuredelete
  • Read a Featureget
  • Update a Featurepatch
• Subject Access Requests
  • List Subject Access Requests by data source and statusget
  • Update a Subject Access Requestpatch
  • Update a Subject Access Requestpost
  • List Subject Access Requestsget
  • Create a Subject Access Requestpost
  • Get Subject Access Requestget
• Environments
  • Get Environments by Projectget
  • Create an Environmentpost
  • Archive an Environmentdelete
  • Read an Environmentget
  • Update an Environmentpatch
  • Read the datafile of an Environmentget
• Search
  • Searchget
• Change History
  • Retrieve changes for a project.get
• Attribution
  • Get bucketing information for a visitorget
• Export Credentials
  • Get aws credentials to access enriched events datasetget
• Metrics
  • Get all of the global metrics of an accountget
  • Update a Global Metricpatch
  • Read global metrics by projectsget
  • Create a Global Metricpost
• Impressions Usage
  • Get Impressions Usageget
  • Get Impressions Usage Summaryget
• Collaborators
  • List Collaboratorsget
  • Invite Collaboratorspost
  • List Collaborators who have not yet accepted the invitationsget
• ExperimentSummary
  • Summaries of Experiments and Campaignsget
• Reports
  • Get Experiment Result's Reportget
• Recommendations
  • Download a CSV with all current catalog dataget
  • Download a CSV with all computed recommendations output dataget
  • Download a CSV with summary stats dataget

Permission Service

• Entity
  • Get User Permissions For Project Entity Typeget
  • Get Team Permissions For Project Entity Typeget
  • Get Entity Permissionsget
  • Change Permissionspatch
• Team Management (BETA)
  • Get Teamsget
  • Create Teampost
  • Delete Teamdelete
  • Get Team Infoget
  • Update Teampatch

Eyeofcloud Feature Experimentation scheduling API

• Schedules
  • Get Schedule Listget
  • Create Schedulepost
  • Get Scheduleget
  • Update Schedulepatch
  • Delete Scheduledelete

Eyeofcloud Agent API

• /v1/config
  • Return the Eyeofcloud config for the given environmentget
• /v1/datafile
  • Return the datafile for the given environment. If you need strict consistency, you can pass the datafile to other Eyeofcloud instances. so that all initialize from exactly the same datafile version (rather than each fetching the datafile separately from the Eyeofcloud CDN).get
• /v1/decide
  • Decide makes feature decisions for the selected query parameters.post
• /v1/lookup
  • Lookup returns saved user profile.post
• /v1/save
  • Save saves user profile.post
• /v1/track
  • Track event for the given user.post
• /v1/send-odp-event
  • Send event to Eyeofcloud Data Platform (ODP).post
• /v1/activate
  • Activate selected features and experiments for the given user.post
• /v1/override
  • Override an experiment decision for a userpost
• /oauth/token
  • Get JWT token to authenticate all requests.post
• /v1/batch
  • Batch multiple API endpoints into one request.post

Metrics Hub Service API

• Metrics
  • Update a Metric Layerput
  • List Metricsget
  • Create a Metricpost
  • Update a Metricpatch
  • Read a metricget
  • Delete a Metricdelete

关于功能试验 API

介绍可用于 Eyeofcloud 功能实验的 REST API。

Eyeofcloud 功能实验具有多个 REST API，可用于对功能实验项目执行管理任务。下面介绍了可用 REST API 的功能以及哪些终端节点可用于 Eyeofcloud 功能实验。

有关使用 Eyeofcloud API 的实验生命周期中最常见的操作，请参阅 GitHub 上托管的功能实验 REST API 说明书。

身份验证和检测结果 ID

---

有关生成 API 密钥的信息，请参阅有关使用功能实验 REST API 的开发人员文档。有关查找 API 密钥的 ID 的信息，请参阅查找 API 调用的 ID。

Eyeofcloud 功能实验 API

---

Eyeofcloud 功能实验 API 的速率限制为每秒 2 个请求，每分钟 120 个请求。

您可以使用 Eyeofcloud Feature Experimentation API 管理以下项目：

• 标志
• 规则和规则集
• 报告（结果）
• 变量定义
• 变化
• 环境
• 组

📘

注意

---

Eyeofcloud 功能实验 API 扩展了 Eyeofcloud API 的功能，以包含特定于功能实验项目的功能。

优化 API

---

使用 Eyeofcloud API 进行 Eyeofcloud 功能实验 API 未涵盖的其他管理。您可以将 Eyeofcloud API 用于其他类型的实验项目，例如 Web 实验和完整堆栈（旧版）。

Eyeofcloud API 的速率限制为每分钟 100 个请求。Get Campaign results （获取活动结果） 和 Get Experiment results （获取实验结果） 终端节点的速率限制为每分钟 20 个请求。

📘

注意

---

并非所有 Eyeofcloud API 终端节点在功能实验中都可用。

Eyeofcloud 功能实验中提供了以下 Eyeofcloud API 终端节点：

• 属性
• 观众
• 展示次数使用情况
• 活动
• 更改历史记录
• 事件
• Experiments （实验） – 只有 Get Experiment results （获取实验结果） 终端节点可用于功能实验。
• 报告
• 导出凭证
• 主题访问请求
• 用户
• 指标
• 计划
• 项目
• 搜索

Eyeofcloud 功能实验调度 API

---

使用 Scheduling API 列出、创建、更新或删除标志和规则的计划更改。

权限服务

---

使用 Permission Service API 获取和更新用户权限。

Eyeofcloud 代理 API

---

Eyeofcloud 代理 API 管理您的 Eyeofcloud 功能实验代理实例。