Skip to content

v18.0.1

Choose a tag to compare

View all tags
@ldhenry ldhenry released this 24 Oct 10:47
· 2 commits to main since this release
18.0.1
4bf9789

Added

  • Added 'covarianceInfo' field to Iteration response to show details of the covariance file used for stratified sampling

  • Added judgeConfiguration field to AI Config variations for attaching judge AI configs with sampling rates. This field is available in variation-related endpoints

  • Added judgingConfigKeys field to AI Config judge variation responses to show which AI configs this judge is evaluating

  • Added imageUrl field to experiment treatment response in TreatmentRep schema (feature flagged and hidden from public documentation). This field will appear in the following endpoints once the enable-experimentation-treatment-images feature flag is enabled:

    • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
    • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
    • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
    • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
    • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations
    • POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
    • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}
    • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}
    • PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}

  • Moved selectors, URLs to a different part of the Metrics object (no changes visible to consumers)

  • Added GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting endpoint

  • Added PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting endpoint

  • Added new AI tools endpoints for managing AI tools within a project:

    • POST /api/v2/projects/{projectKey}/ai-tools (Create AI tool)
    • GET /api/v2/projects/{projectKey}/ai-tools (List AI tools)
    • GET /api/v2/projects/{projectKey}/ai-tools/{toolKey} (Get AI tool)
    • PATCH /api/v2/projects/{projectKey}/ai-tools/{toolKey} (Update AI tool)
    • DELETE /api/v2/projects/{projectKey}/ai-tools/{toolKey} (Delete AI tool)

  • Marked key as not required for POST /api/v2/api/v2/metrics/projects/{projectKey}/metric-groups. It is still required for funnel or standard groups, but can be omitted for guardrail groups.

  • Added type guardrail to metric groups data model, and to POST /api/v2/api/v2/metrics/projects/{projectKey}/metric-groups and GET /api/v2/metrics/projects/{projectKey}/metric-groups filter

  • Added new endpoint to update approval request settings PATCH /api/v2/approval-requests/projects/{projectKey}/settings

  • Added new endpoint to retrieve approval request settings GET /api/v2/approval-requests/projects/{projectKey}/settings

  • Added _id to AI Config variations models

  • Added mode field to AI Config with enum values agent and completion (default: completion)

  • Added instructions and description fields to AI Config variations

  • Added judge mode to AI Config for evaluation and assessment use cases

  • Added conditional API behavior for AI Config variations based on mode: agent mode returns instructions/description and excludes messages, completion mode returns messages and excludes instructions/description

  • Added new fields to input request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments endpoint

    • type
    • reallocationFrequencyMillis

  • Added new fields to Experiment response

    • reallocationFrequencyMillis
    • updatedAt
    • version

  • Added new fields to input request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations

    • type
    • reallocationFrequencyMillis

  • Added new fields to the Iteration response

    • reallocationFrequencyMillis
    • updatedAt
    • version

  • Added new endpoints to manage restricting AI models

    • POST /api/v2/projects/{projectKey}/ai-configs/model-configs/restricted
    • DELETE /api/v2/projects/{projectKey}/ai-configs/model-configs/restricted

  • Added the isRestricted property to the AI model configs response to indicate model restriction status

  • Added the filters property to the Metric response

  • Added the comment property to the AI Configs Variation to document changes in each version

  • Added optional isFlagOn boolean parameter to flag creation API to allow automatic flag activation across all environments

  • Added aiConfig field to approval-request response

  • Added optional audience.releaseGuardianConfiguration.metrics field of type MeasuredRolloutMetric to the input request body of PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}.

  • Added new field to input request body of POST /api/v2/metrics/{projectKey}

    • filters

  • Added an optional dataSource property to the Metric endpoint requests and responses to support warehouse native metrics

  • Added observability usage endpoints

    • GET /api/v2/usage/observability/sessions
    • GET /api/v2/usage/observability/errors
    • GET /api/v2/usage/observability/logs
    • GET /api/v2/usage/observability/traces

  • Added bigquery and databricks destination kinds to Destination and DestinationPost reps

  • Added views endpoints for managing views within a project, and updated their descriptions

    • GET /api/v2/projects/{projectKey}/views
    • POST /api/v2/projects/{projectKey}/views
    • GET /api/v2/projects/{projectKey}/views/{viewKey}
    • DELETE /api/v2/projects/{projectKey}/views/{viewKey}
    • PATCH /api/v2/projects/{projectKey}/views/{viewKey}
    • POST /api/v2/projects/{projectKey}/views/{viewKey}/link/{resourceType}
    • DELETE /api/v2/projects/{projectKey}/views/{viewKey}/link/{resourceType}
    • GET /api/v2/projects/{projectKey}/views/{viewKey}/linked/{resourceType}
    • GET /api/v2/projects/{projectKey}/view-associations/{resourceType}/{resourceKey}

  • Added documentation for existing possible 409 response from PUT /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{contextKind}/{contextKey}/flags/{featureFlagKey}

  • Added archived metrics support with new fields and lifecycle state filtering:

    • Added archived (boolean) and archivedAt (timestamp) fields to Metric responses
    • Added lifecycleState filter parameter to GET /api/v2/metrics/{projectKey} endpoint using syntax filter=lifecycleState equals active or filter=lifecycleState equals archived (defaults to active metrics when no filter is provided)
    • Added support for PATCH /api/v2/metrics/{projectKey}/{metricKey} to update archived status
    • Added business logic validation to prevent archiving metrics in active experiments, rollouts, or groups
    • Added UpdateMetricArchived RBAC action for controlling archive permissions

  • GET /api/v2/usage/service-connections

    • Added optional connectionType string parameter
    • Added optional relayVersion string parameter
    • Added optional sdkName string parameter
    • Added optional sdkVersion string parameter
    • Added optional sdkType string parameter
    • Added optional aggregationType string parameter
    • Added optional granularity string parameter
    • Added optional groupBy string parameter

  • GET /api/v2/usage/data-export-events

    • Added optional eventKind string parameter
    • Added optional aggregationType string parameter
    • Added optional granularity string parameter
    • Added optional groupBy string parameter

  • GET /api/v2/usage/experimentation-keys

    • Added optional experimentId string parameter
    • Added optional aggregationType string parameter
    • Added optional granularity string parameter
    • Added optional groupBy string parameter

  • GET /internal/comments

  • POST /internal/comments

  • DELETE /internal/comments

  • Added _version field to MetricListingRep for optimistic locking support in metric archive/restore operations

  • Added activeExperimentCount field to MetricListingRep to show the number of active experiments using the metric

  • Added activeGuardedRolloutCount field to MetricListingRep to show the number of active guarded rollouts using the metric

  • Added GET /api/v2/usage/experimentation-events endpoint

  • Added lastUsedInExperiment field to MetricRep to show the most recent experiment that used this metric (uses DependentExperimentRep type with fields: _links, creationDate, environmentId, environmentKey, key, name, archivedDate)

  • Added lastUsedInGuardedRollout field to MetricRep to show the most recent guarded rollout that used this metric (uses DependentMeasuredRolloutRep type with fields: _id, _links, creationDate, environmentKey, environmentName, flagKey, flagName, status)

  • Added lastUsedInEntity expand parameter to GET /api/v2/metrics/{projectKey}/{metricKey} endpoint

  • Added new release policies beta endpoints:

  • GET /api/v2/projects/{projectKey}/release-policies

  • POST /api/v2/projects/{projectKey}/release-policies

  • PUT /api/v2/projects/{projectKey}/release-policies

  • PUT /api/v2/projects/{projectKey}/release-policies/{policyId}

  • DELETE /api/v2/projects/{projectKey}/release-policies/{policyId}

  • Added new creationConfig field to integration approval conditions on custom workflow rep to support the use of Custom Approvals

  • GET /api/v2/usage/clientside-contexts

  • GET /api/v2/usage/serverside-contexts

  • GET /api/v2/usage/total-contexts

  • Added eventKey field to the MetricV2Rep, MetricInGroupRep, and DependentMetricOrMetricGroupRep to expose the event key sent with custom metrics

  • Added TotalConnectionsCount, TotalActiveConnectionsCount to MetricGroupRepExpandableProperties to show total connections and total active connections count.

  • Added IncludeActiveCounts expand parameter to GET /api/v2/projects/{projKey}/metric-groups.

  • Added covarianceId to POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments.

  • Added covarianceId to POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations.

Removed

  • Removed an incorrect enum value from the input request body of POST /api/v2/projects (Create project) and PATCH /api/v2/projects/{projectKey} (Patch project)
    • namingConvention
      • none
  • Removed required id field from view-associations APIs.
  • GET /api/v2/projects/{projectKey}/experimentation-settings
    • Removed standardRandomizationUnit
  • Removed deprecated MeasuredRolloutStatus type
  • Removed standardRandomizationUnit property from randomization units in experimentation settings endpoints:
    • GET /api/v2/projects/{projectKey}/experimentation-settings
    • PUT /api/v2/projects/{projectKey}/experimentation-settings
  • Removed GET /api/v2/usage/experimentation-units endpoint
  • Removed deprecated experiment results endpoints:
    • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
    • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metric-groups/{metricGroupKey}/results

Changed

  • PUT /api/v2/projects/{projectKey}/experimentation-settings
    • Marked standardRandomizationUnit as deprecated
  • PATCH /api/v2/approval-requests/projects/{projectKey}/settings
    • Deleted query param: environmentKey
    • Deleted query param: resourceKind
    • Request body changed
  • Updated pagination of maintainers from 5 to 20 in GET /api/v2/teams/{teamKey}
  • Made the global field optional in the request body of POST /api/v2/projects/{projectKey}/ai-configs/model-configs
  • Made the model field optional in the request body of POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations
  • Replaced smart quote characters with regular apostrophe character
  • Updated @Success 200 response schema for GET /api/v2/usage/data-export-events: replaced SeriesIntervalsRep with SeriesListRep
  • Updated @Success 200 response schema for GET /api/v2/usage/experimentation-keys: replaced SeriesIntervalsRep with SeriesListRep
  • Updated @Success 200 response schema for GET /api/v2/usage/service-connections: replaced SeriesIntervalsRep with SeriesListRep
  • Added IntegrationCreationConfig field to ApprovalConditionInputRep.
Assets 2
Loading