v17.2.0

[Unreleased] ### Added - Added a new maintainerId field to the input request body of the POST /api/v2/metrics/{projectKey} endpoint - Added a new resourceCategory field to the rep returned by custom roles endpoints and the custom role post body - Added new _presetBundleVersion and _presetStatements fields to the rep returned by custom roles endpoints - Added new query params, aggregationType and contextKind, to the GET /api/v2/usage/mau endpoint - Added a new assignedTo expand parameter to GET /api/v2/roles and GET /api/v2/roles/{customRoleKey} - Added fifteen new AI Configs (beta) endpoints for working with AI Configs, AI Config variations, and AI model configs - Added documentation for the roleAttributes field and expand query parameter on the following endpoints: - GET /api/v2/members - GET /api/v2/members/{memberId} - GET /api/v2/teams - GET /api/v2/teams/{teamKey} - Added documentation for patching the roleAttributes field on the PATCH /api/v2/teams/{teamKey} endpoint - Added a new category field to the Metric response. - Added new public endpoints for working with announcements: - GET /api/v2/announcements - POST /api/v2/announcements - PATCH /api/v2/announcements/{announcementId} - DELETE /api/v2/announcements/{announcementId} - Added a new 'sort' query parameter to GET /api/v2/metric-groups/{projectKey} - Updated the 'filter' query parameter of GET /api/v2/metric-groups/{projectKey} to include 'kind' as a valid option - Added new satisfactionRating field to AI Configs metrics endpoints. - Added new costPerInputToken and costPerInputToken fields to AI Configs Models. - Added new cost metrics to AI Configs Metrics. - Added new endpoint for generating an RSA key pair in order to create a new data warehouse destination - POST /api/v2/destinations/generate-warehouse-destination-key-pair ### Removed - Removed legacy experiment results endpoint GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}} - Removed obsolete isActive field from endpoint POST /api/v2/metrics/{projectKey} ### Changed - Updated the Data Export destination endpoints to include a new destination kind - Expose waitOnApprovals request parameter on POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports - Updated the ApprovalRequestResponse type to optionally include resourceKind - Removed the beta tag from the following endpoints - POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports - GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID} - POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports - GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} - Make environments optional on : - GET /api/v2/flags/{projectKey} (List flags) - POST /api/v2/flags/{projectKey} (Create flag) - GET /api/v2/flags/{projectKey}/{featureFlagKey} (Get flag) - PATCH /api/v2/flags/{projectKey}/{featureFlagKey} (Patch flag) - POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy (Copy flag) - Added a list of valid values to the Import type returned by the GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} endpoint ## [17.1.0] - 2024-12-13 ### Added - Added a roleAttributes field to the POST /api/v2/teams endpoint (Create team) - Updated the request body type on PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Added new endpoints for working with integration configurations: - POST /api/v2/integration-configurations/keys/{integrationKey} (Create integration configuration) - GET /api/v2/integration-configurations/keys/{integrationKey} (Get all configurations for the integration) - GET /api/v2/integration-configurations/{integrationConfigurationId} (Get an integration configuration) - PATCH /api/v2/integration-configurations/{integrationConfigurationId} (Update integration configuration) - DELETE /api/v2/integration-configurations/{integrationConfigurationId} (Delete integration configuration) - Added the new endpoint PATCH /api/v2/approval-requests/{id} - Added a new endpoint in beta PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Expose roleAttributes on the Team type - Expose totalCount in paginated roles API response ### Removed - Removed the unused bakeTimeDurationMs field from endpoints that return release and release pipeline details. These endpoints are currently in beta. - Removed the beta endpoint PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} ### Changed - Updated environment in the following beta endpoints to no longer be required, in order to account for deleted environments: - GET /api/v2/flags/{projectKey}/{flagKey}/release - PATCH /api/v2/flags/{projectKey}/{flagKey}/release - PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release - PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId} - GET /api/v2/projects/{projectKey}/release-pipelines - POST /api/v2/projects/{projectKey}/release-pipelines - GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Renamed the /api/v2/integration-capabilities/big-segment-store endpoints to use the Persistent store integrations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints: - GET /api/v2/integration-capabilities/big-segment-store (List all big segment store integrations) - POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey} (Create big segment store integration) - GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Get big segment store integration by ID) - PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Update big segment store integration) - DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Delete big segment store integration) - Renamed the /api/v2/integration-capabilities/flag-import endpoints to use the Flag import configurations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints: - GET /api/v2/integration-capabilities/flag-import (List all flag import configurations) - POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} (Create a flag import configuration) - GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Get a single flag import configuration) - PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Update a flag import configuration) - DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Delete a flag import configuration) - POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger (Trigger a single flag import run) - Updated the operation id and summary field definitions for the PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} endpoint - Updated items in /api/v2/roles response body to be required - Updated items in /api/v2/teams response body to be required - Added the property resourceApprovalSettings in the environment type - Updated instructions[].value property in the PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} endpoint to be a 64 bit integer ## [17.0.0] - 2024-10-15 ### Added - Added filter query parameter to GET /api/v2/metrics/{projectKey} (List metrics) - Added expand query parameter to GET /api/v2/members/{id} (Get member - Added expand query parameter to GET /api/v2/members (List member) - Added expand query parameter to PATCH /api/v2/members/{id} (Patch member) - Added expand query parameter to POST /api/v2/members (Create member) - Updated MemberRep to include RoleAttributes - Updated MetricInGroupRep and MetricV2Rep to both contain the metric's 'unitAggregationType- Updated thekindfield inDependentMetricOrMetricGroupRepto allow enum valuestandard, used for metric groups - Added latestCommitTimefield to the response ofGET /api/v2/code-refs/statistics/{projectKey}(Get code references statistics for flags) - Added optionalstatisticalMethodologyfield to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) - AddedstatisticalMethodologyfield to the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Get experiments) - AddedautoApplyApprovedChangesfield to environment approval settings on project, environment, and approval request responses. - Addedtotal_countfield to the response ofGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts- Addedlinksfield to the response ofGET /api/v2/projects/{projectKey}/envir...

v17.1.0

Added - Added a roleAttributes field to the POST /api/v2/teams endpoint (Create team) - Updated the request body type on PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Added new endpoints for working with integration configurations: - POST /api/v2/integration-configurations/keys/{integrationKey} (Create integration configuration) - GET /api/v2/integration-configurations/keys/{integrationKey} (Get all configurations for the integration) - GET /api/v2/integration-configurations/{integrationConfigurationId} (Get an integration configuration) - PATCH /api/v2/integration-configurations/{integrationConfigurationId} (Update integration configuration) - DELETE /api/v2/integration-configurations/{integrationConfigurationId} (Delete integration configuration) - Added the new endpoint PATCH /api/v2/approval-requests/{id} - Added a new endpoint in beta PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Expose roleAttributes on the Team type - Expose totalCount in paginated roles API response ### Removed - Removed the unused bakeTimeDurationMs field from endpoints that return release and release pipeline details. These endpoints are currently in beta. - Removed the beta endpoint PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} ### Changed - Updated environment in the following beta endpoints to no longer be required, in order to account for deleted environments: - GET /api/v2/flags/{projectKey}/{flagKey}/release - PATCH /api/v2/flags/{projectKey}/{flagKey}/release - PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release - PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId} - GET /api/v2/projects/{projectKey}/release-pipelines - POST /api/v2/projects/{projectKey}/release-pipelines - GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Renamed the /api/v2/integration-capabilities/big-segment-store endpoints to use the Persistent store integrations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints: - GET /api/v2/integration-capabilities/big-segment-store (List all big segment store integrations) - POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey} (Create big segment store integration) - GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Get big segment store integration by ID) - PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Update big segment store integration) - DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Delete big segment store integration) - Renamed the /api/v2/integration-capabilities/flag-import endpoints to use the Flag import configurations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints: - GET /api/v2/integration-capabilities/flag-import (List all flag import configurations) - POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} (Create a flag import configuration) - GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Get a single flag import configuration) - PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Update a flag import configuration) - DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Delete a flag import configuration) - POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger (Trigger a single flag import run) - Updated the operation id and summary field definitions for the PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} endpoint - Updated items in /api/v2/roles response body to be required - Updated items in /api/v2/teams response body to be required - Added the property resourceApprovalSettings in the environment type - Updated instructions[].value property in the PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} endpoint to be a 64 bit integer

17.0.0

Added

• Added filter query parameter to GET /api/v2/metrics/{projectKey} (List metrics)
• Added expand query parameter to GET /api/v2/members/{id} (Get member
• Added expand query parameter to GET /api/v2/members (List member)
• Added expand query parameter to PATCH /api/v2/members/{id} (Patch member)
• Added expand query parameter to POST /api/v2/members (Create member)
• Updated MemberRep to include RoleAttributes
• Updated MetricInGroupRep and MetricV2Rep to both contain the metric's 'unitAggregationType`
• Updated the kind field in DependentMetricOrMetricGroupRep to allow enum value standard, used for metric groups
• Added latestCommitTime field to the response of GET /api/v2/code-refs/statistics/{projectKey} (Get code references statistics for flags)
• Added optional statisticalMethodology field to the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
• Added statisticalMethodology field to the response bodies of:
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Patch experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Get experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Get experiments)
• Added autoApplyApprovedChanges field to environment approval settings on project, environment, and approval request responses.
• Added total_count field to the response of GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
• Added links field to the response of GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
• Added limit and offset query parameters to GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
• Added the GET /api/v2/caller-identity endpoint to aid in secret scanning integrations
• Updated the GET /api/v2/flags/{projectKey}/{flagKey}/release to include the property _id in the audience response
• Added the following endpoints in beta for Release Automation:
  • DELETE /api/v2/flags/{projectKey}/{flagKey}/release
  • PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release
  • PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}
  • GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
• Added optional holdoutId field to the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
• Added holdoutId field to the response bodies of:
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Patch experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Get experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Get experiments)
  • Updated GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes/{attributeName} to accept a limit param.
• Added optional projectKey/environmentKey to the query params of beta endpoints:
  • GET /api/v2/usage/service-connections
  • GET /api/v2/usage/experimentation-units
  • GET /api/v2/usage/experimentation-keys
  • GET /api/v2/usage/data-export-events
• Added environmentKey field to the response bodies of:
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Patch experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Get experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Get experiments)
• Added POST /api/v2/auditlog to support large policy statement lists (that would not otherwise fit in the URL)
• Updated 200 response type for PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}
• Updated FeatureFlagStatus to use an enum for its name
• Updated PATCH /api/v2/projects/{projectKey}/flags/{flagKey} to include the ignoreConflicts query parameter
• Added variance field for each relative difference in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added varianceReduction field for each relative difference in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added endpoints for managing experiment layers:
  • Create a new layer: POST /api/v2/projects/{projectKey}/layers
  • Update a layer: PATCH /api/v2/projects/{projectKey}/layers/{layerKey}
  • Get layers: GET /api/v2/projects/{projectKey}/layers
• Added endpoints for managing holdouts:
  • Create a new holdout: POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}
  • Update a holdout: PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}
  • Get a holdout by id: GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}
  • Get a holdout by key: GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}
• Added totalCount field to the response body of GET /api/v2/metrics/{projectKey} (list metrics)
• Added pagination to GET /api/v2/projects/{projectKey}/metric-groups (list metric groups)
  • Added limit and offset query params
  • Added totalCount field to the response body
• Added optional attributes field to the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (create experiment) and POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations (create iteration)
• Added version field to the response bodies of:
  • GET /api/v2/members (Get members)
  • GET /api/v2/members/{id} (Get member)
  • PATCH /api/v2/members/{id} (Patch member)
  • POST /api/v2/members (Create member)
  • POST /members/{id}/teams (Add member to teams)
• Added optional initialPrerequisites field to request body of POST /api/v2/flags/{projectKey} endpoint (Create Flag).
• Added eventValuesSum field for each treatment result in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added new endpoints for working with flag import configurations:
  • POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} (Create flag import configuration)
  • GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Get flag import configuration)
  • GET /api/v2/integration-capabilities/flag-import (List all flag import configurations)
  • PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Update flag import configuration)
  • POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger (Trigger a flag import run)
  • DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Delete flag import configuration)
• Added model, bayesianNormal, and bayesianBeta fields for each treatment result in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added optional methodology field to the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
• Added methodology field to the response bodies of:
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Patch experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Get experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Get experiments)
• Added correlation, sdRatio, and covariateImbalance fields for each treatment result in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added optional namingConvention field to the request body of POST /api/v2/projects (Create project)
• Added new endpoint for updating an approval request: PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} (Update approval request)
• Added optional query field to the filter param on GET /api/v2/projects/{projectKey}/metric-groups to search against the metric group name and key
• Added documentation for the filter param on GET /api/v2/projects/{projectKey}/metric-groups
• Added limit, offset, and asOf query parameters to the GET /api/v2/tags (List tags) endpoint
• Added optional limit field to GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes
• Updated the distribution field in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint to always use number parameters
• Added new endpoints for working with integration configurations:
  • POST /api/v2/integration-configurations/keys/{integrationKey} (Create integration configuration)
  • `GET /api/v2/integrati...

16.1.1

No significant changes.

Full Changelog: 16.1.0...16.1.1

16.1.0

[16.1.0] - 2024-05-16

Added

• Added optional notInExperimentVariationId field to flags inside iteration in the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create Experiment)
• Added optional notInExperimentVariationId field in flags in the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations (Create Iteration)
• Added notInExperimentVariationId field to the flags object in the response bodies of:
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create Experiment)
  • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations (Create Iteration)
  • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Patch Experiment)
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Get Experiment)
• Added HTTP 409 as a possible response status code for PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} (Patch Experiment)

16.0.0

Added

• Added totalCount field to response of GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows
• Added limit and offset query params to getWorkflows and getCustomRoles endpoints

Removed

• Removed the followerId, hasDataExport, status, contextKindTargeted, and segmentTargeted filters for the getFeatureFlags endpoint
• Removed the projects and roles options for the expand query parameter in the getTeams endpoint

15.0.0

Added

• Added deprecated and deprecatedDate to the rep returned by the flags endpoints
• Added an optional description field for a segment rule
• Added Integrations (beta) endpoints for working with big segment persistent store integrations
• Added environmentKey to dependent experiment rep
• Added lastModified to the unbounded object returned by Segment APIs
• Added results field to GET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results, deprecating treatmentResults
• Added critical to Environment object and POST /api/v2/projects/{projectKey}/environments endpoint request body.
• Added expand query parameter to GET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results with support for expanding traffic
• Added pagination parameters limit and offset to /api/v2/tokens
• Added missing response information to PATCH /api/v2/flags/{projectKey}/{flagKey}/release
• Added 4xx response info to GET /api/v2, GET /api/v2/openapi.json, and GET /api/v2/public-ip-list
• Added key to the rep returned by flag defaults endpoints
• Added type to code references statistics reps
• Added standard as a metric group kind
• Added primarySingleMetric, primaryFunnel, and metrics to IterationRep, deprecating primaryMetric and secondaryMetric
• Added primarySingleMetricKey and primaryFunnelKey to IterationInput, deprecating primary in MetricInput
• Added _versionId field to the metric rep returned by metric and experimentation endpoints
• Added beta engineering insights endpoints

Removed

• Removed components schemas that were unused by any paths or operations
• Removed the endpoint to reset experiment results
• Removed the endpoint to create an application
• Removed the endpoint to create an application version

Changed

• Updated definition of post delete approval request to include previously ommited error codes 405 and 409
• Marked key and name required in MaintainerTeam to match API behavior
• Added filter to /api/v2/projects/{projectKey}/release-pipelines
• Added pagination parameters limit and offset to /api/v2/projects/{projectKey}/release-pipelines
• Renamed experimentation settings endpoints and reps to randomization settings, the fields and api's remain the same.
• Marked nameInGroup as optional in MetricInGroupRep if and only if the group isn't a funnel.

14.0.0

Added

• Added Application and Application version endpoints, in beta
• Added unitOfAnalysis field to the metric listing rep returned by get all metrics endpoint
• Added lastSeen field to the metric listing rep returned by get all metrics endpoint
• Added _access object to the release pipeline rep returned by several endpoints
• Added _links field to the team summary object returned by several endpoints
• Added beta endpoint for getting experimentation units usage
• Added iterationId query string parameter to /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
• Added pagination parameters limit and offset to /api/v2/segments/{projKey}/{envKey}
• Added lastModifiedDate field to response of GET /api/v2/segments/{projectKey}/{environmentKey}
• Added sort to /api/v2/segments/{projKey}/{envKey}
• Added filter to /api/v2/segments/{projKey}/{envKey}
• Added _id field to the expanded project information in Teams endpoints
• Added purpose field to the FlagPost input object
• Added migrationSettings field to the FlagPost input object
• Added archived field to GET /api/v2/projects/{projectKey}/context-kinds and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
• Marked items required in FlagFollowersGetRep to match API behavior
• Added _flagCount field to GET /api/v2/segments/{projectKey}/{environmentKey}
• Added totalEvaluations field to GET /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey}
• Added Release pipelines and Releases endpoints, in beta
  • Added links in environment representations
• Update code and message on error reps to be required to match API behavior
• Added name field to PhaseInfo for GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
• Added unitAggregationType, analysisType, and eventDefault fields to GET /api/v2/metrics/{projectKey}, GET /api/v2/metrics/{projectKey}/{metricKey}, POST /api/v2/metrics/{projectKey}, and PATCH /api/v2/metrics/{projectKey}/{metricKey}
• Marked items as required in EnvironmentCollectionRep to match API behavior
• Marked color and name as required in EnvironmentSummaryRep to match API behavior
• Added @Failure 404 with a value of Member not found to POST /api/v2/members/{id}/teams
• Added beta endpoint to retrieve migration safety issues when updating a migration flag
• Added migrationSettings expand parameter to GET /api/v2/flags/{projectKey}
• Added migrationSettings expand parameter to GET /api/v2/flags/{projectKey}/{featureFlagKey}
• Added limit and offset query params to GET /projects/{projKey}/release-pipelines/{pipelineKey}/releases
• Added beta endpoints to create, delete, and list metric groups
• Marked items as required on ExperimentCollectionRep to match API behavior
• Added isGroup and metrics fields to DependentMetricOrMetricGroupRep
• Added isGroup field to MetricInput
• Added randomizationUnits field to MetricInGroupRep
• Added metricGroups and metricGroupCount expand parameters to the getMetric endpoint

Changed

• Moved PATCH /projects/{projKey}/release-pipelines/{pipelineKey} out of hidden docs
• Set deprecated property on legacy experimentation operation which has already been deprecated
  • GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}
• Set deprecated on offset parameter which has already been deprecated
  • GET /api/v2/user-search/{projectKey}
• Set deprecated on flag-related schema properties that have already been deprecated
• Moved OAuth Client APIs out of beta
• Updated the response body of ReviewOutput to optionally return serviceTokenId, omitted when approval reviewer was a member
• Updated the response body of ReviewResponse to optionally return serviceTokenId, omitted when approval reviewer was a member
• Updated the response body of FlagConfigApprovalRequestResponse to optionally return appliedByServiceTokenId, omitted when a member applies an approval
• Set deprecated property on legacy users endpoints, which are replaced by contexts endpoints
  • DELETE /api/v2/users/{projectKey}/{environmentKey}/{userKey}
  • GET /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}
  • GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags
  • GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}
  • GET /api/v2/users/{projectKey}/{environmentKey}
  • GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}
  • GET /api/v2/user-attributes/{projectKey}/{environmentKey}
  • GET /api/v2/user-search/{projectKey}/{environmentKey}
  • PATCH /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}
  • PUT /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}
• Moved Approvals APIs out of beta
• Moved Workflow APIs out of beta
• Moved Workflow template APIs out of beta
• Updated the response body of the Member struct to clarify that in the permissionGrants, only one of actions or actionSet is required
• Updated type of PrimaryMetric in IterationRep
• Updated maintainerId to be an optional parameter when creating a new experiment
• Updated contextTargets field for flags endpoints to be required
• Renamed metricWrapper to MetricWrapper
• Updated type of Effect in custom roles to string
• Added the expand query parameter for the getExperiment endpoint
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
• Updated description and unhid archived field on GET /api/v2/projects/{projectKey}/context-kinds and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
• Updated description for hideInTargeting field on GET /api/v2/projects/{projectKey}/context-kinds and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
• Moved Context Kind APIs out of beta
• Updated response body of GET /api/v2/flags/{projectKey}/{flagKey}/release and PATCH /api/v2/flags/{projectKey}/{flagKey}/release to include MemberSummary and TokenSummary in each phase's completedBy field instead of having flat values.
• Renamed activeReleases and completedReleases to activeCount and totalCount for GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
• Updated the response body of FeatureFlag and FeatureFlagConfig to return migrationSettings when calling PATCH /api/v2/flags/{projectKey}/{featureFlagKey}
• Set deprecated property on archived query param for GET /api/v2/flags/{projectKey}
• Renamed DependentMetricRep to DependentMetricOrMetricGroupRep
• Updated the kind field in DependentMetricOrMetricGroupRep to allow enum value funnel, used for metric groups
• Renamed MetricWrapper to MetricInGroupRep
• Get metric metricGroups and metricGroupCount fields are expandable, omitted by default

Bug Fixes

• RootResponse schema was incorrect

13.0.0

[13.0.0] - 2023-04-19

Added

Removed

Changed

• Moved Contexts APIs out of beta

12.1.0

[12.1.0] - 2023-04-12

Added

• Added beta endpoint for server connection minutes usage
• Added customRoles expand parameter to GET /api/v2/members
• Added 409 return code information for reset environment keys endpoints
• Added new beta endpoints for approvals
• Updated response bodies for beta approval endpoints
• Added contextKindTargeted filter parameter to GET /api/v2/flags/{projectKey}
• Added contextKindsEvaluated filter parameter to GET /api/v2/flags/{projectKey}
• Added evaluation expand parameter to GET /api/v2/flags/{projectKey}
• Added evaluation expand parameter to GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}

Removed

Changed

• Updated note for param memberId in follow flag endpoints putFlagFollowers and deleteFlagFollowers to reflect the limitation of Reader roles.
• Updated the response body of ExpandableApprovalRequestResponse to optionally return environments instead of environment which is only used in beta APIs