Insights charts (beta)

This feature is in beta

To use this feature, pass in a header including the LD-API-Version key with value set to beta. Use this header with each call. To learn more, read Beta resources.

Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.

The charts API provides access to the data used in engineering insights project metrics. To learn more, read Project metrics.

Get deployment frequency chart data

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.

Request

query Parameters

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

Responses

200

Chart response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/engineering-insights/charts/deployments/frequency

Request samples

curl
Node.js
Python

Response samples

application/json

{"metadata": {"summary": {"property1": null,
"property2": null
},
"name": "deploymentFrequency",
"metrics": {"property1": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
},
"property2": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
}
},
"xAxis": {"unit": "count"
},
"yAxis": {"unit": "count"
}
},
"series": [{"metadata": {"name": "string",
"count": 0,
"bounds": [{"name": "equal",
"value": 100
}
]
},
"data": [{"x": 1617225600000,
"y": 100,
"values": {"property1": null,
"property2": null
}
}
]
}
]
}

Get stale flags chart data

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.

Request

query Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key
applicationKey	string <string> Comma separated list of application keys
groupBy	string <string> Property to group results by. Options: `maintainer`
maintainerId	string <string> Comma-separated list of individual maintainers to filter results.
maintainerTeamKey	string <string> Comma-separated list of team maintainer keys to filter results.
expand	string <string> Options: `metrics`

Responses

200

Chart response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/engineering-insights/charts/flags/stale

Request samples

curl
Node.js
Python

Response samples

application/json

{"metadata": {"summary": {"property1": null,
"property2": null
},
"name": "deploymentFrequency",
"metrics": {"property1": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
},
"property2": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
}
},
"xAxis": {"unit": "count"
},
"yAxis": {"unit": "count"
}
},
"series": [{"metadata": {"name": "string",
"count": 0,
"bounds": [{"name": "equal",
"value": 100
}
]
},
"data": [{"x": 1617225600000,
"y": 100,
"values": {"property1": null,
"property2": null
}
}
]
}
]
}

Get flag status chart data

Get flag status chart data. To learn more, read Using the flag status chart.

Request

query Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key
applicationKey	string <string> Comma separated list of application keys

Responses

200

Chart response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/engineering-insights/charts/flags/status

Request samples

curl
Node.js
Python

Response samples

application/json

{"metadata": {"summary": {"property1": null,
"property2": null
},
"name": "deploymentFrequency",
"metrics": {"property1": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
},
"property2": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
}
},
"xAxis": {"unit": "count"
},
"yAxis": {"unit": "count"
}
},
"series": [{"metadata": {"name": "string",
"count": 0,
"bounds": [{"name": "equal",
"value": 100
}
]
},
"data": [{"x": 1617225600000,
"y": 100,
"values": {"property1": null,
"property2": null
}
}
]
}
]
}

Get lead time chart data

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

Request

query Parameters

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

Responses

200

Chart response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/engineering-insights/charts/lead-time

Request samples

curl
Node.js
Python

Response samples

application/json

{"metadata": {"summary": {"property1": null,
"property2": null
},
"name": "deploymentFrequency",
"metrics": {"property1": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
},
"property2": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
}
},
"xAxis": {"unit": "count"
},
"yAxis": {"unit": "count"
}
},
"series": [{"metadata": {"name": "string",
"count": 0,
"bounds": [{"name": "equal",
"value": 100
}
]
},
"data": [{"x": 1617225600000,
"y": 100,
"values": {"property1": null,
"property2": null
}
}
]
}
]
}

Get release frequency chart data

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

Request

query Parameters

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

Responses

200

Chart response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/engineering-insights/charts/releases/frequency

Request samples

curl
Node.js
Python

Response samples

application/json

{"metadata": {"summary": {"property1": null,
"property2": null
},
"name": "deploymentFrequency",
"metrics": {"property1": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
},
"property2": {"indicator": "excellent",
"value": 5,
"unit": "count",
"modifier": "per day",
"tiers": [{"indicator": "excellent",
"description": "at least 1 per day"
}
]
}
},
"xAxis": {"unit": "count"
},
"yAxis": {"unit": "count"
}
},
"series": [{"metadata": {"name": "string",
"count": 0,
"bounds": [{"name": "equal",
"value": 100
}
]
},
"data": [{"x": 1617225600000,
"y": 100,
"values": {"property1": null,
"property2": null
}
}
]
}
]
}

➔ Next to Insights deployments (beta)