Skip to content

Latest commit

 

History

History
341 lines (238 loc) · 13.4 KB

MetricsBetaApi.md

File metadata and controls

341 lines (238 loc) · 13.4 KB
Raw

LaunchDarklyApi\MetricsBetaApi

All URIs are relative to https://app.launchdarkly.com.

Method HTTP request Description
createMetricGroup() POST /api/v2/projects/{projectKey}/metric-groups Create metric group
deleteMetricGroup() DELETE /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Delete metric group
getMetricGroup() GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Get metric group
getMetricGroups() GET /api/v2/projects/{projectKey}/metric-groups List metric groups
patchMetricGroup() PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Patch metric group

createMetricGroup()

createMetricGroup($project_key, $metric_group_post): \LaunchDarklyApi\Model\MetricGroupRep

Create metric group

Create a new metric group in the specified project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\MetricsBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$metric_group_post = new \LaunchDarklyApi\Model\MetricGroupPost(); // \LaunchDarklyApi\Model\MetricGroupPost

try {
    $result = $apiInstance->createMetricGroup($project_key, $metric_group_post);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsBetaApi->createMetricGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
project_key string The project key
metric_group_post \LaunchDarklyApi\Model\MetricGroupPost

Return type

\LaunchDarklyApi\Model\MetricGroupRep

Authorization

ApiKey

HTTP request headers

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

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

deleteMetricGroup()

deleteMetricGroup($project_key, $metric_group_key)

Delete metric group

Delete a metric group by key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\MetricsBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$metric_group_key = 'metric_group_key_example'; // string | The metric group key

try {
    $apiInstance->deleteMetricGroup($project_key, $metric_group_key);
} catch (Exception $e) {
    echo 'Exception when calling MetricsBetaApi->deleteMetricGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
project_key string The project key
metric_group_key string The metric group key

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

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

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

getMetricGroup()

getMetricGroup($project_key, $metric_group_key, $expand): \LaunchDarklyApi\Model\MetricGroupRep

Get metric group

Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the "Get metric group" response. By default, these fields are not included in the response. To expand the response, append the expand query parameter and add a comma-separated list with either or both of the following fields: - experiments includes all experiments from the specific project that use the metric group - experimentCount includes the number of experiments from the specific project that use the metric group For example, expand=experiments includes the experiments field in the response.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\MetricsBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$metric_group_key = 'metric_group_key_example'; // string | The metric group key
$expand = 'expand_example'; // string | A comma-separated list of properties that can reveal additional information in the response.

try {
    $result = $apiInstance->getMetricGroup($project_key, $metric_group_key, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsBetaApi->getMetricGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
project_key string The project key
metric_group_key string The metric group key
expand string A comma-separated list of properties that can reveal additional information in the response. [optional]

Return type

\LaunchDarklyApi\Model\MetricGroupRep

Authorization

ApiKey

HTTP request headers

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

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

getMetricGroups()

getMetricGroups($project_key, $filter, $expand, $limit, $offset): \LaunchDarklyApi\Model\MetricGroupCollectionRep

List metric groups

Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the "Get metric groups" response. By default, these fields are not included in the response. To expand the response, append the expand query parameter and add a comma-separated list with the following field: - experiments includes all experiments from the specific project that use the metric group For example, expand=experiments includes the experiments field in the response. ### Filtering metric groups The filter parameter supports the equals operator on the following fields: experimentStatus, query. The experimentStatus field supports the following values: not_started, running, stopped, and started. The query field is a search query that is compared against the metric group name and key. #### Sample query filter=experimentStatus equals 'not_started' and query equals 'metric name'

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\MetricsBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$filter = 'filter_example'; // string | Accepts filter by `experimentStatus` and `query`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.
$expand = 'expand_example'; // string | A comma-separated list of properties that can reveal additional information in the response.
$limit = 56; // int | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
$offset = 56; // int | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.

try {
    $result = $apiInstance->getMetricGroups($project_key, $filter, $expand, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsBetaApi->getMetricGroups: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
project_key string The project key
filter string Accepts filter by `experimentStatus` and `query`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. [optional]
expand string A comma-separated list of properties that can reveal additional information in the response. [optional]
limit int The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. [optional]
offset int Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. [optional]

Return type

\LaunchDarklyApi\Model\MetricGroupCollectionRep

Authorization

ApiKey

HTTP request headers

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

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

patchMetricGroup()

patchMetricGroup($project_key, $metric_group_key, $patch_operation): \LaunchDarklyApi\Model\MetricGroupRep

Patch metric group

Patch a metric group by key. Updating a metric group uses a JSON patch representation of the desired changes.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\MetricsBetaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_key = 'project_key_example'; // string | The project key
$metric_group_key = 'metric_group_key_example'; // string | The metric group key
$patch_operation = [{"op":"replace","path":"/name","value":"my-updated-metric-group"}]; // \LaunchDarklyApi\Model\PatchOperation[]

try {
    $result = $apiInstance->patchMetricGroup($project_key, $metric_group_key, $patch_operation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetricsBetaApi->patchMetricGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
project_key string The project key
metric_group_key string The metric group key
patch_operation \LaunchDarklyApi\Model\PatchOperation[]

Return type

\LaunchDarklyApi\Model\MetricGroupRep

Authorization

ApiKey

HTTP request headers

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

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