LaunchDarkly.Api.Api.UserSegmentsApi

All URIs are relative to https://app.launchdarkly.com/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

void DeleteUserSegment (string projectKey, string environmentKey, string userSegmentKey)

Delete a user segment.

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class DeleteUserSegmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentKey = userSegmentKey_example;  // string | The user segment's key. The key identifies the user segment in your code.

            try
            {
                // Delete a user segment.
                apiInstance.DeleteUserSegment(projectKey, environmentKey, userSegmentKey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.DeleteUserSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

void (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

UserTargetingExpirationForSegment GetExpiringUserTargetsOnSegment (string projectKey, string environmentKey, string userSegmentKey)

Get expiring user targets for user segment

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class GetExpiringUserTargetsOnSegmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentKey = userSegmentKey_example;  // string | The user segment's key. The key identifies the user segment in your code.

            try
            {
                // Get expiring user targets for user segment
                UserTargetingExpirationForSegment result = apiInstance.GetExpiringUserTargetsOnSegment(projectKey, environmentKey, userSegmentKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.GetExpiringUserTargetsOnSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

UserSegment GetUserSegment (string projectKey, string environmentKey, string userSegmentKey)

Get a single user segment by key.

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class GetUserSegmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentKey = userSegmentKey_example;  // string | The user segment's key. The key identifies the user segment in your code.

            try
            {
                // Get a single user segment by key.
                UserSegment result = apiInstance.GetUserSegment(projectKey, environmentKey, userSegmentKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.GetUserSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

UserSegments GetUserSegments (string projectKey, string environmentKey, string tag)

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

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class GetUserSegmentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var tag = tag_example;  // string | Filter by tag. A tag can be used to group flags across projects. (optional) 

            try
            {
                // Get a list of all user segments in the given project.
                UserSegments result = apiInstance.GetUserSegments(projectKey, environmentKey, tag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.GetUserSegments: " + e.Message );
            }
        }
    }
}

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

UserTargetingExpirationForSegment PatchExpiringUserTargetsOnSegment (string projectKey, string environmentKey, string userSegmentKey, Object semanticPatchWithComment)

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

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class PatchExpiringUserTargetsOnSegmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentKey = userSegmentKey_example;  // string | The user segment's key. The key identifies the user segment in your code.
            var semanticPatchWithComment = ;  // Object | 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.

            try
            {
                // Update, add, or delete expiring user targets on user segment
                UserTargetingExpirationForSegment result = apiInstance.PatchExpiringUserTargetsOnSegment(projectKey, environmentKey, userSegmentKey, semanticPatchWithComment);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.PatchExpiringUserTargetsOnSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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	Object	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

UserSegment PatchUserSegment (string projectKey, string environmentKey, string userSegmentKey, List patchOnly)

Perform a partial update to a user segment.

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class PatchUserSegmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentKey = userSegmentKey_example;  // string | The user segment's key. The key identifies the user segment in your code.
            var patchOnly = new List<PatchOperation>(); // List<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.

            try
            {
                // Perform a partial update to a user segment.
                UserSegment result = apiInstance.PatchUserSegment(projectKey, environmentKey, userSegmentKey, patchOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.PatchUserSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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	List	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

UserSegment PostUserSegment (string projectKey, string environmentKey, UserSegmentBody userSegmentBody)

Creates a new user segment.

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class PostUserSegmentExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentBody = new UserSegmentBody(); // UserSegmentBody | Create a new user segment.

            try
            {
                // Creates a new user segment.
                UserSegment result = apiInstance.PostUserSegment(projectKey, environmentKey, userSegmentBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.PostUserSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

void UpdateBigSegmentTargets (string projectKey, string environmentKey, string userSegmentKey, BigSegmentTargetsBody bigSegmentTargetsBody)

Update targets included or excluded in a big segment

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class UpdateBigSegmentTargetsExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UserSegmentsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var userSegmentKey = userSegmentKey_example;  // string | The user segment's key. The key identifies the user segment in your code.
            var bigSegmentTargetsBody = new 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.

            try
            {
                // Update targets included or excluded in a big segment
                apiInstance.UpdateBigSegmentTargets(projectKey, environmentKey, userSegmentKey, bigSegmentTargetsBody);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSegmentsApi.UpdateBigSegmentTargets: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
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

void (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]

FilesExpand file tree

UserSegmentsApi.md

Latest commit

History

UserSegmentsApi.md

File metadata and controls

LaunchDarkly.Api.Api.UserSegmentsApi

DeleteUserSegment

Example

Parameters

Return type

Authorization

HTTP request headers

GetExpiringUserTargetsOnSegment

Example

Parameters

Return type

Authorization

HTTP request headers

GetUserSegment

Example

Parameters

Return type

Authorization

HTTP request headers

GetUserSegments

Example

Parameters

Return type

Authorization

HTTP request headers

PatchExpiringUserTargetsOnSegment

Example

Parameters

Return type

Authorization

HTTP request headers

PatchUserSegment

Example

Parameters

Return type

Authorization

HTTP request headers

PostUserSegment

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateBigSegmentTargets

Example

Parameters

Return type

Authorization

HTTP request headers