Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
275 lines (175 loc) · 10.8 KB

UserSegmentsApi.md

File metadata and controls

275 lines (175 loc) · 10.8 KB

UserSegmentsApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteUserSegment DELETE /segments/{projectKey}/{environmentKey}/{userSegmentKey} Delete a user segment.
getExpiringUserTargetsOnSegment GET /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} Get expiring user targets for user segment
getUserSegment GET /segments/{projectKey}/{environmentKey}/{userSegmentKey} Get a single user segment by key.
getUserSegments GET /segments/{projectKey}/{environmentKey} Get a list of all user segments in the given project.
patchExpiringUserTargetsOnSegment PATCH /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} Update, add, or delete expiring user targets on user segment
patchUserSegment PATCH /segments/{projectKey}/{environmentKey}/{userSegmentKey} Perform a partial update to a user segment.
postUserSegment POST /segments/{projectKey}/{environmentKey} Creates a new user segment.
updateBigSegmentTargets POST /segments/{projectKey}/{environmentKey}/{userSegmentKey}/users Update targets included or excluded in a big segment

deleteUserSegment

Delete a user segment.

Example

 deleteUserSegment projectKey=value environmentKey=value userSegmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentKey string The user segment's key. The key identifies the user segment in your code.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getExpiringUserTargetsOnSegment

Get expiring user targets for user segment

Example

 getExpiringUserTargetsOnSegment projectKey=value environmentKey=value userSegmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentKey string The user segment's key. The key identifies the user segment in your code.

Return type

UserTargetingExpirationForSegment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserSegment

Get a single user segment by key.

Example

 getUserSegment projectKey=value environmentKey=value userSegmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentKey string The user segment's key. The key identifies the user segment in your code.

Return type

UserSegment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserSegments

Get a list of all user segments in the given project.

Example

 getUserSegments projectKey=value environmentKey=value  tag=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
tag string Filter by tag. A tag can be used to group flags across projects. [optional]

Return type

UserSegments

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchExpiringUserTargetsOnSegment

Update, add, or delete expiring user targets on user segment

Example

 patchExpiringUserTargetsOnSegment projectKey=value environmentKey=value userSegmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentKey string The user segment's key. The key identifies the user segment in your code.
semanticPatchWithComment map Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.

Return type

UserTargetingExpirationForSegment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchUserSegment

Perform a partial update to a user segment.

Example

 patchUserSegment projectKey=value environmentKey=value userSegmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentKey string The user segment's key. The key identifies the user segment in your code.
patchOnly array[PatchOperation] Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.

Return type

UserSegment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postUserSegment

Creates a new user segment.

Example

 postUserSegment projectKey=value environmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentBody UserSegmentBody Create a new user segment.

Return type

UserSegment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateBigSegmentTargets

Update targets included or excluded in a big segment

Example

 updateBigSegmentTargets projectKey=value environmentKey=value userSegmentKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userSegmentKey string The user segment's key. The key identifies the user segment in your code.
bigSegmentTargetsBody BigSegmentTargetsBody Add or remove user targets to the included or excluded lists on a big segment. Contact your account manager for early access to this feature.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]