Skip to content

InsightsChartsBetaApi.md

Latest commit

 

History

History
394 lines (296 loc) · 17.7 KB

InsightsChartsBetaApi.md

File metadata and controls

394 lines (296 loc) · 17.7 KB

InsightsChartsBetaApi

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

Method HTTP request Description
getDeploymentFrequencyChart GET /api/v2/engineering-insights/charts/deployments/frequency Get deployment frequency chart data
getFlagStatusChart GET /api/v2/engineering-insights/charts/flags/status Get flag status chart data
getLeadTimeChart GET /api/v2/engineering-insights/charts/lead-time Get lead time chart data
getReleaseFrequencyChart GET /api/v2/engineering-insights/charts/releases/frequency Get release frequency chart data
getStaleFlagsChart GET /api/v2/engineering-insights/charts/flags/stale Get stale flags chart data

getDeploymentFrequencyChart

InsightsChart getDeploymentFrequencyChart()

Get deployment frequency chart data. Engineering insights displays deployment frequency data in the deployment frequency metric view. ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the expand query parameter and include the following: * metrics includes details on the metrics related to deployment frequency For example, use ?expand=metrics to include the metrics field in the response. By default, this field is not included in the response.

Example

import {
    InsightsChartsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new InsightsChartsBetaApi(configuration);

let projectKey: string; //The project key (optional) (default to undefined)
let environmentKey: string; //The environment key (optional) (default to undefined)
let applicationKey: string; //Comma separated list of application keys (optional) (default to undefined)
let from: string; //Unix timestamp in milliseconds. Default value is 7 days ago. (optional) (default to undefined)
let to: string; //Unix timestamp in milliseconds. Default value is now. (optional) (default to undefined)
let bucketType: string; //Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional) (default to undefined)
let bucketMs: number; //Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional) (default to undefined)
let groupBy: string; //Options: `application`, `kind` (optional) (default to undefined)
let expand: string; //Options: `metrics` (optional) (default to undefined)

const { status, data } = await apiInstance.getDeploymentFrequencyChart(
    projectKey,
    environmentKey,
    applicationKey,
    from,
    to,
    bucketType,
    bucketMs,
    groupBy,
    expand
);

Parameters

Name Type Description Notes
projectKey [string] The project key (optional) defaults to undefined
environmentKey [string] The environment key (optional) defaults to undefined
applicationKey [string] Comma separated list of application keys (optional) defaults to undefined
from [string] Unix timestamp in milliseconds. Default value is 7 days ago. (optional) defaults to undefined
to [string] Unix timestamp in milliseconds. Default value is now. (optional) defaults to undefined
bucketType [string] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional) defaults to undefined
bucketMs [number] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional) defaults to undefined
groupBy [string] Options: `application`, `kind` (optional) defaults to undefined
expand [string] Options: `metrics` (optional) defaults to undefined

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Chart response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

getFlagStatusChart

InsightsChart getFlagStatusChart()

Get flag status chart data. To learn more, read Flag statuses.

Example

import {
    InsightsChartsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new InsightsChartsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let environmentKey: string; //The environment key (default to undefined)
let applicationKey: string; //Comma separated list of application keys (optional) (default to undefined)

const { status, data } = await apiInstance.getFlagStatusChart(
    projectKey,
    environmentKey,
    applicationKey
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
environmentKey [string] The environment key defaults to undefined
applicationKey [string] Comma separated list of application keys (optional) defaults to undefined

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Chart response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

getLeadTimeChart

InsightsChart getLeadTimeChart()

Get lead time chart data. The engineering insights UI displays lead time data in the lead time metric view.

Example

import {
    InsightsChartsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new InsightsChartsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let environmentKey: string; //The environment key (optional) (default to undefined)
let applicationKey: string; //Comma separated list of application keys (optional) (default to undefined)
let from: number; //Unix timestamp in milliseconds. Default value is 7 days ago. (optional) (default to undefined)
let to: number; //Unix timestamp in milliseconds. Default value is now. (optional) (default to undefined)
let bucketType: string; //Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional) (default to undefined)
let bucketMs: number; //Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional) (default to undefined)
let groupBy: string; //Options: `application`, `stage`. Default: `stage`. (optional) (default to undefined)
let expand: string; //Options: `metrics`, `percentiles`. (optional) (default to undefined)

const { status, data } = await apiInstance.getLeadTimeChart(
    projectKey,
    environmentKey,
    applicationKey,
    from,
    to,
    bucketType,
    bucketMs,
    groupBy,
    expand
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
environmentKey [string] The environment key (optional) defaults to undefined
applicationKey [string] Comma separated list of application keys (optional) defaults to undefined
from [number] Unix timestamp in milliseconds. Default value is 7 days ago. (optional) defaults to undefined
to [number] Unix timestamp in milliseconds. Default value is now. (optional) defaults to undefined
bucketType [string] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional) defaults to undefined
bucketMs [number] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional) defaults to undefined
groupBy [string] Options: `application`, `stage`. Default: `stage`. (optional) defaults to undefined
expand [string] Options: `metrics`, `percentiles`. (optional) defaults to undefined

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Chart response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

getReleaseFrequencyChart

InsightsChart getReleaseFrequencyChart()

Get release frequency chart data. Engineering insights displays release frequency data in the release frequency metric view.

Example

import {
    InsightsChartsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new InsightsChartsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let environmentKey: string; //The environment key (default to undefined)
let applicationKey: string; //Comma separated list of application keys (optional) (default to undefined)
let hasExperiments: boolean; //Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional) (default to undefined)
let global: string; //Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional) (default to undefined)
let groupBy: string; //Property to group results by. Options: `impact` (optional) (default to undefined)
let from: string; //Unix timestamp in milliseconds. Default value is 7 days ago. (optional) (default to undefined)
let to: string; //Unix timestamp in milliseconds. Default value is now. (optional) (default to undefined)
let bucketType: string; //Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional) (default to undefined)
let bucketMs: number; //Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional) (default to undefined)
let expand: string; //Options: `metrics` (optional) (default to undefined)

const { status, data } = await apiInstance.getReleaseFrequencyChart(
    projectKey,
    environmentKey,
    applicationKey,
    hasExperiments,
    global,
    groupBy,
    from,
    to,
    bucketType,
    bucketMs,
    expand
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
environmentKey [string] The environment key defaults to undefined
applicationKey [string] Comma separated list of application keys (optional) defaults to undefined
hasExperiments [boolean] Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional) defaults to undefined
global [string] Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional) defaults to undefined
groupBy [string] Property to group results by. Options: `impact` (optional) defaults to undefined
from [string] Unix timestamp in milliseconds. Default value is 7 days ago. (optional) defaults to undefined
to [string] Unix timestamp in milliseconds. Default value is now. (optional) defaults to undefined
bucketType [string] Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`. (optional) defaults to undefined
bucketMs [number] Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds). (optional) defaults to undefined
expand [string] Options: `metrics` (optional) defaults to undefined

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Chart response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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

getStaleFlagsChart

InsightsChart getStaleFlagsChart()

Get stale flags chart data. Engineering insights displays stale flags data in the flag health metric view. ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the expand query parameter and include the following: * metrics includes details on the metrics related to stale flags For example, use ?expand=metrics to include the metrics field in the response. By default, this field is not included in the response.

Example

import {
    InsightsChartsBetaApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new InsightsChartsBetaApi(configuration);

let projectKey: string; //The project key (default to undefined)
let environmentKey: string; //The environment key (default to undefined)
let applicationKey: string; //Comma separated list of application keys (optional) (default to undefined)
let groupBy: string; //Property to group results by. Options: `maintainer` (optional) (default to undefined)
let maintainerId: string; //Comma-separated list of individual maintainers to filter results. (optional) (default to undefined)
let maintainerTeamKey: string; //Comma-separated list of team maintainer keys to filter results. (optional) (default to undefined)
let expand: string; //Options: `metrics` (optional) (default to undefined)

const { status, data } = await apiInstance.getStaleFlagsChart(
    projectKey,
    environmentKey,
    applicationKey,
    groupBy,
    maintainerId,
    maintainerTeamKey,
    expand
);

Parameters

Name Type Description Notes
projectKey [string] The project key defaults to undefined
environmentKey [string] The environment key defaults to undefined
applicationKey [string] Comma separated list of application keys (optional) defaults to undefined
groupBy [string] Property to group results by. Options: `maintainer` (optional) defaults to undefined
maintainerId [string] Comma-separated list of individual maintainers to filter results. (optional) defaults to undefined
maintainerTeamKey [string] Comma-separated list of team maintainer keys to filter results. (optional) defaults to undefined
expand [string] Options: `metrics` (optional) defaults to undefined

Return type

InsightsChart

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Chart response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

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