aiconfigsmetriclistingrep.md•152 kB
# AiConfigsMetricListingRep
## Example Usage
```typescript
import { AiConfigsMetricListingRep } from "@launchdarkly/mcp-server/models/components";
let value: AiConfigsMetricListingRep = {
experimentCount: 0,
metricGroupCount: 0,
guardedRolloutCount: 0,
id: "5902deadbeef667524a01290",
versionId: "version-id-123abc",
key: "metric-key-123abc",
name: "My metric",
kind: "custom",
attachedFlagCount: 0,
links: {
"parent": {
href: "/api/v2/metrics/my-project",
type: "application/json",
},
"self": {
href: "/api/v2/metrics/my-project/my-metric",
type: "application/json",
},
},
site: {
href: "href",
type: "type",
},
access: {
denied: [
{
action: "action",
reason: {
resources: [
"proj/*:env/*;qa_*:/flag/*",
],
notResources: [
"notResources",
"notResources",
],
actions: [
"*",
],
notActions: [
"<value 1>",
"<value 2>",
],
effect: "allow",
roleName: "role_name",
},
},
{
action: "action",
reason: {
resources: [
"proj/*:env/*;qa_*:/flag/*",
],
notResources: [
"notResources",
"notResources",
],
actions: [
"*",
],
notActions: [
"<value 1>",
"<value 2>",
],
effect: "allow",
roleName: "role_name",
},
},
],
allowed: [
{
action: "action",
reason: {
resources: [
"proj/*:env/*;qa_*:/flag/*",
],
notResources: [
"notResources",
"notResources",
],
actions: [
"*",
],
notActions: [
"<value 1>",
"<value 2>",
],
effect: "allow",
roleName: "role_name",
},
},
{
action: "action",
reason: {
resources: [
"proj/*:env/*;qa_*:/flag/*",
],
notResources: [
"notResources",
"notResources",
],
actions: [
"*",
],
notActions: [
"<value 1>",
"<value 2>",
],
effect: "allow",
roleName: "role_name",
},
},
],
},
tags: [],
creationDate: 1,
lastModified: {
date: new Date("2021-08-05T19:46:31.148Z"),
},
maintainerId: "569fdeadbeef1644facecafe",
maintainer: {
links: {
"self": {
href: "/api/v2/members/569f183514f4432160000007",
type: "application/json",
},
},
id: "569f183514f4432160000007",
firstName: "Ariel",
lastName: "Flores",
role: "admin",
email: "ariel@acme.com",
},
description: "description",
category: "Error monitoring",
isNumeric: true,
successCriteria: "HigherThanBaseline",
unit: "unit",
eventKey: "Order placed",
randomizationUnits: [
"user",
],
filters: {
type: "contextAttribute",
attribute: "country",
op: "op",
values: [
"JP",
],
contextKind: "user",
negate: false,
},
unitAggregationType: "average",
analysisType: "mean",
percentileValue: 95,
eventDefault: {
disabled: true,
value: 0,
},
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `experimentCount` | *number* | :heavy_minus_sign: | The number of experiments using this metric | 0 |
| `metricGroupCount` | *number* | :heavy_minus_sign: | The number of metric groups using this metric | 0 |
| `guardedRolloutCount` | *number* | :heavy_minus_sign: | The number of guarded rollouts using this metric | 0 |
| `id` | *string* | :heavy_check_mark: | The ID of this metric | 5902deadbeef667524a01290 |
| `versionId` | *string* | :heavy_check_mark: | The version ID of the metric | version-id-123abc |
| `key` | *string* | :heavy_check_mark: | A unique key to reference the metric | metric-key-123abc |
| `name` | *string* | :heavy_check_mark: | A human-friendly name for the metric | My metric |
| `kind` | [components.AiConfigsMetricListingRepKind](../../models/components/aiconfigsmetriclistingrepkind.md) | :heavy_check_mark: | The kind of event the metric tracks | custom |
| `attachedFlagCount` | *number* | :heavy_minus_sign: | The number of feature flags currently attached to this metric | 0 |
| `links` | Record<string, [components.AiConfigsLink](../../models/components/aiconfigslink.md)> | :heavy_check_mark: | The location and content type of related resources | {<br/>"parent": {<br/>"href": "/api/v2/metrics/my-project",<br/>"type": "application/json"<br/>},<br/>"self": {<br/>"href": "/api/v2/metrics/my-project/my-metric",<br/>"type": "application/json"<br/>}<br/>} |
| `site` | [components.AiConfigsLink](../../models/components/aiconfigslink.md) | :heavy_minus_sign: | N/A | {<br/>"href": "href",<br/>"type": "type"<br/>} |
| `access` | [components.AiConfigsAccess](../../models/components/aiconfigsaccess.md) | :heavy_minus_sign: | N/A | {<br/>"allowed": [<br/>{<br/>"reason": {<br/>"role_name": "role_name",<br/>"notActions": [<br/>null,<br/>null<br/>],<br/>"notResources": [<br/>"notResources",<br/>"notResources"<br/>],<br/>"effect": "allow",<br/>"resources": [<br/>"proj/*:env/*;qa_*:/flag/*"<br/>],<br/>"actions": [<br/>"*"<br/>]<br/>},<br/>"action": "action"<br/>},<br/>{<br/>"reason": {<br/>"role_name": "role_name",<br/>"notActions": [<br/>null,<br/>null<br/>],<br/>"notResources": [<br/>"notResources",<br/>"notResources"<br/>],<br/>"effect": "allow",<br/>"resources": [<br/>"proj/*:env/*;qa_*:/flag/*"<br/>],<br/>"actions": [<br/>"*"<br/>]<br/>},<br/>"action": "action"<br/>}<br/>],<br/>"denied": [<br/>{<br/>"reason": {<br/>"role_name": "role_name",<br/>"notActions": [<br/>null,<br/>null<br/>],<br/>"notResources": [<br/>"notResources",<br/>"notResources"<br/>],<br/>"effect": "allow",<br/>"resources": [<br/>"proj/*:env/*;qa_*:/flag/*"<br/>],<br/>"actions": [<br/>"*"<br/>]<br/>},<br/>"action": "action"<br/>},<br/>{<br/>"reason": {<br/>"role_name": "role_name",<br/>"notActions": [<br/>null,<br/>null<br/>],<br/>"notResources": [<br/>"notResources",<br/>"notResources"<br/>],<br/>"effect": "allow",<br/>"resources": [<br/>"proj/*:env/*;qa_*:/flag/*"<br/>],<br/>"actions": [<br/>"*"<br/>]<br/>},<br/>"action": "action"<br/>}<br/>]<br/>} |
| `tags` | *string*[] | :heavy_check_mark: | Tags for the metric | [] |
| `creationDate` | *number* | :heavy_check_mark: | N/A | |
| `lastModified` | [components.AiConfigsModification](../../models/components/aiconfigsmodification.md) | :heavy_minus_sign: | N/A | {<br/>"date": "2021-08-05T19:46:31.148Z"<br/>} |
| `maintainerId` | *string* | :heavy_minus_sign: | The ID of the member who maintains this metric | 569fdeadbeef1644facecafe |
| `maintainer` | [components.AiConfigsMemberSummary](../../models/components/aiconfigsmembersummary.md) | :heavy_minus_sign: | N/A | {<br/>"firstName": "Ariel",<br/>"lastName": "Flores",<br/>"role": "admin",<br/>"_links": {<br/>"self": {<br/>"href": "/api/v2/members/569f183514f4432160000007",<br/>"type": "application/json"<br/>}<br/>},<br/>"_id": "569f183514f4432160000007",<br/>"email": "ariel@acme.com"<br/>} |
| `description` | *string* | :heavy_minus_sign: | Description of the metric | |
| `category` | *string* | :heavy_minus_sign: | The category of the metric | Error monitoring |
| `isNumeric` | *boolean* | :heavy_minus_sign: | For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>). | true |
| `successCriteria` | [components.AiConfigsMetricListingRepSuccessCriteria](../../models/components/aiconfigsmetriclistingrepsuccesscriteria.md) | :heavy_minus_sign: | For custom metrics, the success criteria | |
| `unit` | *string* | :heavy_minus_sign: | For numeric custom metrics, the unit of measure | |
| `eventKey` | *string* | :heavy_minus_sign: | For custom metrics, the event key to use in your code | Order placed |
| `randomizationUnits` | *string*[] | :heavy_minus_sign: | An array of randomization units allowed for this metric | [<br/>"user"<br/>] |
| `filters` | [components.AiConfigsFilter](../../models/components/aiconfigsfilter.md) | :heavy_minus_sign: | N/A | {<br/>"op": "op",<br/>"negate": false,<br/>"values": [<br/>"JP"<br/>],<br/>"contextKind": "user",<br/>"attribute": "country",<br/>"type": "contextAttribute"<br/>} |
| `unitAggregationType` | [components.AiConfigsMetricListingRepUnitAggregationType](../../models/components/aiconfigsmetriclistingrepunitaggregationtype.md) | :heavy_minus_sign: | The method by which multiple unit event values are aggregated | average |
| `analysisType` | [components.AiConfigsMetricListingRepAnalysisType](../../models/components/aiconfigsmetriclistingrepanalysistype.md) | :heavy_minus_sign: | The method for analyzing metric events | mean |
| `percentileValue` | *number* | :heavy_minus_sign: | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | 95 |
| `eventDefault` | [components.AiConfigsMetricEventDefaultRep](../../models/components/aiconfigsmetriceventdefaultrep.md) | :heavy_minus_sign: | N/A | {<br/>"disabled": true,<br/>"value": 0<br/>} |