Skip to content

Releases: launchdarkly/api-client-python

v18.1.0

29 Oct 16:22
@LaunchDarklyReleaseBot LaunchDarklyReleaseBot
v18.1.0
d090e12

Choose a tag to compare

View all tags
v18.1.0 Latest
Latest

Added

  • Added tags field to experiment POST request as optional body field. Tags are an array of strings.

  • Added tags field to experiment responses. For individual experiment GET requests (GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}), the tags field is now always included in the response. For list experiment GET requests (GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments), the tags field can be included by adding expand=tags to the query parameters.

Removed

Changed

Bug Fixes

Assets 2
Loading

v18.0.2

24 Oct 10:45
@LaunchDarklyReleaseBot LaunchDarklyReleaseBot
v18.0.2
1ec10bc

Choose a tag to compare

View all tags
v18.0.2

Added

  • Added lastUsedInExperiment and lastUsedInGuardedRollout fields to metric group responses. These fields appear in the following endpoints:
    • GET /api/v2/projects/{projectKey}/metric-groups
    • POST /api/v2/projects/{projectKey}/metric-groups
    • GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}
    • PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}

Removed

Changed

  • Made the messages field optional in the request body of POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations. Validation is now mode-dependent: completion/judge mode requires messages, while agent mode rejects messages.
  • Removed the beta tag from PATCH /api/v2/members
Loading

v18.0.1

24 Oct 10:47
@ldhenry ldhenry
18.0.1
4bf9789

Choose a tag to compare

View all tags
v18.0.1

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 activ...

Read more
Loading

v17.2.0

04 Apr 21:38
@LaunchDarklyReleaseBot LaunchDarklyReleaseBot
v17.2.0
6e2733c

Choose a tag to compare

View all tags
v17.2.0

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
Loading

v17.1.0

13 Dec 22:30
@LaunchDarklyReleaseBot LaunchDarklyReleaseBot
v17.1.0
d3d7755

Choose a tag to compare

View all tags
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
Loading

17.0.0

15 Oct 17:39
@lucywyman lucywyman
17.0.0
e2a9e2c

Choose a tag to compare

View all tags
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...
Read more
Loading

16.1.1

16 May 12:11
@ldhenry ldhenry
16.1.1
e23933f

Choose a tag to compare

View all tags
16.1.1

No significant changes.

Full Changelog: 16.1.0...16.1.1

Loading

16.1.0

16 May 11:19
@ldhenry ldhenry
16.1.0
b5a70d2

Choose a tag to compare

View all tags
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)
Loading

16.0.0

15 Apr 20:40
@lucywyman lucywyman
16.0.0
616dd82

Choose a tag to compare

View all tags
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
Loading

15.0.0

13 Mar 23:59
@lucywyman lucywyman
15.0.0
800bbf1

Choose a tag to compare

View all tags
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.
Loading