/launchdarkly-insights | Type: Application | PCID required: Yes
Tools
launchdarkly_insights_associate_repositories_and_projects
Associate repositories with projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mappings | object[] | Yes | — | The mappings value |
launchdarkly_insights_create_deployment_event
Create deployment event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKey | string | Yes | — | The application key. This defines the granularity at which you want to view your insights metrics. Typically it is the name of one of the GitHub repositories that you use in this project.<br/><br/>LaunchDarkly automatically creates a new application each time you send a unique application key. |
applicationKind | string | No | — | The kind of application. Default: <code>server</code> |
applicationName | string | No | — | The application name. This defines how the application is displayed |
deploymentMetadata | object | No | — | A JSON object containing metadata about the deployment |
environmentKey | string | Yes | — | The environment key |
eventMetadata | object | No | — | A JSON object containing metadata about the event |
eventTime | integer | No | — | Event Time |
eventType | string | Yes | — | The event type |
projectKey | string | Yes | — | The project key |
version | string | Yes | — | The application version. You can set the application version to any string that includes only letters, numbers, periods (<code>.</code>), hyphens (<code>-</code>), or underscores (<code>_</code>).<br/><br/>We recommend setting the application version to at least the first seven characters of the SHA or to the tag of the GitHub commit for this deployment. |
versionName | string | No | — | The version name. This defines how the version is displayed |
launchdarkly_insights_create_insight_group
Create insight group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationKeys | string[] | No | — | The application keys to associate with the insight group. If not provided, the insight group will include data from all applications. |
environmentKey | string | Yes | — | The environmentKey to be associated with the insight group |
key | string | Yes | — | The key of the insight group |
name | string | Yes | — | The name of the insight group |
projectKey | string | Yes | — | The projectKey to be associated with the insight group |
launchdarkly_insights_delete_branches
Delete branches Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name to delete branches for. |
body | string[] | Yes | — | Request body |
launchdarkly_insights_delete_insight_group
Delete insight group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
insightGroupKey | string | Yes | — | The insight group key |
launchdarkly_insights_delete_repository
Delete repository Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
launchdarkly_insights_delete_repository_project
Remove repository project association Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repositoryKey | string | Yes | — | The repository key |
projectKey | string | Yes | — | The project key |
launchdarkly_insights_get_branch
Get branch Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
branch | string | Yes | — | The url-encoded branch name |
projKey | string | No | — | Filter results to a specific project |
flagKey | string | No | — | Filter results to a specific flag key |
launchdarkly_insights_get_branches
List branches Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
launchdarkly_insights_get_caller_identity
Identify the callerlaunchdarkly_insights_get_deployment
Get deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentID | string | Yes | — | The deployment ID |
expand | string | No | — | Expand properties in response. Options: pullRequests, flagReferences |
launchdarkly_insights_get_deployment_frequency_chart
Get deployment frequency chart data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | No | — | The project key |
environmentKey | string | No | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
from | string | No | — | Unix timestamp in milliseconds. Default value is 7 days ago. |
to | string | No | — | Unix timestamp in milliseconds. Default value is now. |
bucketType | string | No | — | Specify type of bucket. Options: rolling, hour, day. Default: rolling. |
bucketMs | integer | No | — | Duration of intervals for x-axis in milliseconds. Default value is one day (86400000 milliseconds). |
groupBy | string | No | — | Options: application, kind |
expand | string | No | — | Options: metrics |
launchdarkly_insights_get_deployments
List deployments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
limit | integer | No | — | The number of deployments to return. Default is 20. Maximum allowed is 100. |
expand | string | No | — | Expand properties in response. Options: pullRequests, flagReferences |
from | integer | No | — | Unix timestamp in milliseconds. Default value is 7 days ago. |
to | integer | No | — | Unix timestamp in milliseconds. Default value is now. |
after | string | No | — | Identifier used for pagination |
before | string | No | — | Identifier used for pagination |
kind | string | No | — | The deployment kind |
status | string | No | — | The deployment status |
launchdarkly_insights_get_extinctions
List extinctions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repoName | string | No | — | Filter results to a specific repository |
branchName | string | No | — | Filter results to a specific branch. By default, only the default branch will be queried for extinctions. |
projKey | string | No | — | Filter results to a specific project |
flagKey | string | No | — | Filter results to a specific flag key |
from | integer | No | — | Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with to. |
to | integer | No | — | Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with from. |
launchdarkly_insights_get_flag_events
List flag events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
query | string | No | — | Filter events by flag key |
impactSize | string | No | — | Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: none, small, medium, large |
hasExperiments | boolean | No | — | Filter events to those associated with an experiment (true) or without an experiment (false) |
global | string | No | — | Filter to include or exclude global events. Default value is include. Options: include, exclude |
expand | string | No | — | Expand properties in response. Options: experiments |
limit | integer | No | — | The number of deployments to return. Default is 20. Maximum allowed is 100. |
from | integer | No | — | Unix timestamp in milliseconds. Default value is 7 days ago. |
to | integer | No | — | Unix timestamp in milliseconds. Default value is now. |
after | string | No | — | Identifier used for pagination |
before | string | No | — | Identifier used for pagination |
launchdarkly_insights_get_flag_status_chart
Get flag status chart data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
launchdarkly_insights_get_insight_group
Get insight group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
insightGroupKey | string | Yes | — | The insight group key |
expand | string | No | — | Options: scores, environment |
launchdarkly_insights_get_insight_groups
List insight groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
sort | string | No | — | Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name |
query | string | No | — | Filter list of insights groups by name. |
expand | string | No | — | Options: scores, environment, metadata |
launchdarkly_insights_get_ips
Gets the public IP listlaunchdarkly_insights_get_lead_time_chart
Get lead time chart data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | No | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
from | integer | No | — | Unix timestamp in milliseconds. Default value is 7 days ago. |
to | integer | No | — | Unix timestamp in milliseconds. Default value is now. |
bucketType | string | No | — | Specify type of bucket. Options: rolling, hour, day. Default: rolling. |
bucketMs | integer | No | — | Duration of intervals for x-axis in milliseconds. Default value is one day (86400000 milliseconds). |
groupBy | string | No | — | Options: application, stage. Default: stage. |
expand | string | No | — | Options: metrics, percentiles. |
launchdarkly_insights_get_openapi_spec
Gets the OpenAPI spec in jsonlaunchdarkly_insights_get_pull_requests
List pull requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | No | — | Required if you are using the <code>sort</code> parameter’s <code>leadTime</code> option to sort pull requests. |
applicationKey | string | No | — | Filter the results to pull requests deployed to a comma separated list of applications |
status | string | No | — | Filter results to pull requests with the given status. Options: open, merged, closed, deployed. |
query | string | No | — | Filter list of pull requests by title or author |
limit | integer | No | — | The number of pull requests to return. Default is 20. Maximum allowed is 100. |
expand | string | No | — | Expand properties in response. Options: deployments, flagReferences, leadTime. |
sort | string | No | — | Sort results. Requires the environmentKey to be set. Options: leadTime (asc) and -leadTime (desc). When query option is excluded, default sort is by created or merged date. |
from | string | No | — | Unix timestamp in milliseconds. Default value is 7 days ago. |
to | string | No | — | Unix timestamp in milliseconds. Default value is now. |
after | string | No | — | Identifier used for pagination |
before | string | No | — | Identifier used for pagination |
launchdarkly_insights_get_release_frequency_chart
Get release frequency chart data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
hasExperiments | boolean | No | — | Filter events to those associated with an experiment (true) or without an experiment (false) |
global | string | No | — | Filter to include or exclude global events. Default value is include. Options: include, exclude |
groupBy | string | No | — | Property to group results by. Options: impact |
from | string | No | — | Unix timestamp in milliseconds. Default value is 7 days ago. |
to | string | No | — | Unix timestamp in milliseconds. Default value is now. |
bucketType | string | No | — | Specify type of bucket. Options: rolling, hour, day. Default: rolling. |
bucketMs | integer | No | — | Duration of intervals for x-axis in milliseconds. Default value is one day (86400000 milliseconds). |
expand | string | No | — | Options: metrics |
launchdarkly_insights_get_repositories
List repositories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
withBranches | string | No | — | If set to any value, the endpoint returns repositories with associated branch data |
withReferencesForDefaultBranch | string | No | — | If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch |
projKey | string | No | — | A LaunchDarkly project key. If provided, this filters code reference results to the specified project. |
flagKey | string | No | — | If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch |
launchdarkly_insights_get_repositories_2
List repositories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string | No | — | Expand properties in response. Options: projects |
launchdarkly_insights_get_repository
Get repository Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
launchdarkly_insights_get_root
Root resourcelaunchdarkly_insights_get_root_statistic
Get links to code reference repositories for each projectlaunchdarkly_insights_get_scores
Get insight scores Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
launchdarkly_insights_get_stale_flags_chart
Get stale flags chart data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
applicationKey | string | No | — | Comma separated list of application keys |
groupBy | string | No | — | Property to group results by. Options: maintainer |
maintainerId | string | No | — | Comma-separated list of individual maintainers to filter results. |
maintainerTeamKey | string | No | — | Comma-separated list of team maintainer keys to filter results. |
expand | string | No | — | Options: metrics |
launchdarkly_insights_get_statistics
Get code references statistics for flags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | No | — | Filter results to a specific flag key |
launchdarkly_insights_get_versions
Get version informationlaunchdarkly_insights_patch_insight_group
Patch insight group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
insightGroupKey | string | Yes | — | The insight group key |
body | object[] | Yes | — | Request body |
launchdarkly_insights_patch_repository
Update repository Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
body | object[] | Yes | — | Request body |
launchdarkly_insights_post_extinction
Create extinction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
branch | string | Yes | — | The URL-encoded branch name |
body | object[] | Yes | — | Request body |
launchdarkly_insights_post_repository
Create repository Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
commitUrlTemplate | string | No | — | A template for constructing a valid URL to view the commit |
defaultBranch | string | No | — | The repository’s default branch. If not specified, the default value is <code>main</code>. |
hunkUrlTemplate | string | No | — | A template for constructing a valid URL to view the hunk |
name | string | Yes | — | The repository name |
sourceLink | string | No | — | A URL to access the repository |
type | string | No | — | The type of repository. If not specified, the default value is <code>custom</code>. |
launchdarkly_insights_put_branch
Upsert branch Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo | string | Yes | — | The repository name |
branch | string | Yes | — | The URL-encoded branch name |
commitTime | integer | No | — | Commit Time |
head | string | Yes | — | An ID representing the branch HEAD. For example, a commit SHA. |
name | string | Yes | — | The branch name |
references | object[] | No | — | An array of flag references found on the branch |
syncTime | integer | Yes | — | Sync Time |
updateSequenceId | integer | No | — | An optional ID used to prevent older data from overwriting newer data. If no sequence ID is included, the newly submitted data will always be saved. |
launchdarkly_insights_update_deployment
Update deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentID | string | Yes | — | The deployment ID |
body | object[] | Yes | — | Request body |

