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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationKey": { "type": "string", "description": "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": { "type": "string", "description": "The kind of application. Default: <code>server</code>", "enum": [ "server", "browser", "mobile" ] }, "applicationName": { "type": "string", "description": "The application name. This defines how the application is displayed" }, "deploymentMetadata": { "type": "object", "description": "A JSON object containing metadata about the deployment" }, "environmentKey": { "type": "string", "description": "The environment key" }, "eventMetadata": { "type": "object", "description": "A JSON object containing metadata about the event" }, "eventTime": { "type": "integer", "description": "Event Time" }, "eventType": { "type": "string", "description": "The event type", "enum": [ "started", "failed", "finished", "custom" ] }, "projectKey": { "type": "string", "description": "The project key" }, "version": { "type": "string", "description": "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": { "type": "string", "description": "The version name. This defines how the version is displayed" } }, "required": [ "PCID", "applicationKey", "environmentKey", "eventType", "projectKey", "version" ]}
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "applicationKeys": { "type": "array", "items": { "type": "string" }, "description": "The application keys to associate with the insight group. If not provided, the insight group will include data from all applications." }, "environmentKey": { "type": "string", "description": "The environmentKey to be associated with the insight group" }, "key": { "type": "string", "description": "The key of the insight group" }, "name": { "type": "string", "description": "The name of the insight group" }, "projectKey": { "type": "string", "description": "The projectKey to be associated with the insight group" } }, "required": [ "PCID", "environmentKey", "key", "name", "projectKey" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repoName": { "type": "string", "description": "Filter results to a specific repository" }, "branchName": { "type": "string", "description": "Filter results to a specific branch. By default, only the default branch will be queried for extinctions." }, "projKey": { "type": "string", "description": "Filter results to a specific project" }, "flagKey": { "type": "string", "description": "Filter results to a specific flag key" }, "from": { "type": "integer", "description": "Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `to`." }, "to": { "type": "integer", "description": "Filter results to a specific timeframe based on commit time, expressed as a Unix epoch time in milliseconds. Must be used with `from`." } }, "required": [ "PCID" ]}
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "applicationKey": { "type": "string", "description": "Comma separated list of application keys" }, "query": { "type": "string", "description": "Filter events by flag key" }, "impactSize": { "type": "string", "description": "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": { "type": "boolean", "description": "Filter events to those associated with an experiment (`true`) or without an experiment (`false`)" }, "global": { "type": "string", "description": "Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`" }, "expand": { "type": "string", "description": "Expand properties in response. Options: `experiments`" }, "limit": { "type": "integer", "description": "The number of deployments to return. Default is 20. Maximum allowed is 100." }, "from": { "type": "integer", "description": "Unix timestamp in milliseconds. Default value is 7 days ago." }, "to": { "type": "integer", "description": "Unix timestamp in milliseconds. Default value is now." }, "after": { "type": "string", "description": "Identifier used for pagination" }, "before": { "type": "string", "description": "Identifier used for pagination" } }, "required": [ "PCID", "projectKey", "environmentKey" ]}
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive." }, "offset": { "type": "integer", "description": "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": { "type": "string", "description": "Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name" }, "query": { "type": "string", "description": "Filter list of insights groups by name." }, "expand": { "type": "string", "description": "Options: `scores`, `environment`, `metadata`" } }, "required": [ "PCID" ]}
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "environmentKey": { "type": "string", "description": "Required if you are using the <code>sort</code> parameter's <code>leadTime</code> option to sort pull requests." }, "applicationKey": { "type": "string", "description": "Filter the results to pull requests deployed to a comma separated list of applications" }, "status": { "type": "string", "description": "Filter results to pull requests with the given status. Options: `open`, `merged`, `closed`, `deployed`." }, "query": { "type": "string", "description": "Filter list of pull requests by title or author" }, "limit": { "type": "integer", "description": "The number of pull requests to return. Default is 20. Maximum allowed is 100." }, "expand": { "type": "string", "description": "Expand properties in response. Options: `deployments`, `flagReferences`, `leadTime`." }, "sort": { "type": "string", "description": "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": { "type": "string", "description": "Unix timestamp in milliseconds. Default value is 7 days ago." }, "to": { "type": "string", "description": "Unix timestamp in milliseconds. Default value is now." }, "after": { "type": "string", "description": "Identifier used for pagination" }, "before": { "type": "string", "description": "Identifier used for pagination" } }, "required": [ "PCID", "projectKey" ]}
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "projectKey": { "type": "string", "description": "The project key" }, "environmentKey": { "type": "string", "description": "The environment key" }, "applicationKey": { "type": "string", "description": "Comma separated list of application keys" }, "hasExperiments": { "type": "boolean", "description": "Filter events to those associated with an experiment (`true`) or without an experiment (`false`)" }, "global": { "type": "string", "description": "Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`" }, "groupBy": { "type": "string", "description": "Property to group results by. Options: `impact`" }, "from": { "type": "string", "description": "Unix timestamp in milliseconds. Default value is 7 days ago." }, "to": { "type": "string", "description": "Unix timestamp in milliseconds. Default value is now." }, "bucketType": { "type": "string", "description": "Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`." }, "bucketMs": { "type": "integer", "description": "Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds)." }, "expand": { "type": "string", "description": "Options: `metrics`" } }, "required": [ "PCID", "projectKey", "environmentKey" ]}
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
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "withBranches": { "type": "string", "description": "If set to any value, the endpoint returns repositories with associated branch data" }, "withReferencesForDefaultBranch": { "type": "string", "description": "If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch" }, "projKey": { "type": "string", "description": "A LaunchDarkly project key. If provided, this filters code reference results to the specified project." }, "flagKey": { "type": "string", "description": "If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch" } }, "required": [ "PCID" ]}
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>.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commitUrlTemplate": { "type": "string", "description": "A template for constructing a valid URL to view the commit" }, "defaultBranch": { "type": "string", "description": "The repository's default branch. If not specified, the default value is <code>main</code>." }, "hunkUrlTemplate": { "type": "string", "description": "A template for constructing a valid URL to view the hunk" }, "name": { "type": "string", "description": "The repository name" }, "sourceLink": { "type": "string", "description": "A URL to access the repository" }, "type": { "type": "string", "description": "The type of repository. If not specified, the default value is <code>custom</code>.", "enum": [ "bitbucket", "custom", "github", "gitlab" ] } }, "required": [ "PCID", "name" ]}
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo": { "type": "string", "description": "The repository name" }, "branch": { "type": "string", "description": "The URL-encoded branch name" }, "commitTime": { "type": "integer", "description": "Commit Time" }, "head": { "type": "string", "description": "An ID representing the branch HEAD. For example, a commit SHA." }, "name": { "type": "string", "description": "The branch name" }, "references": { "type": "array", "items": { "type": "object" }, "description": "An array of flag references found on the branch" }, "syncTime": { "type": "integer", "description": "Sync Time" }, "updateSequenceId": { "type": "integer", "description": "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." } }, "required": [ "PCID", "repo", "branch", "head", "name", "syncTime" ]}