> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# sentry-monitors
> Sentry Monitors - manage uptime monitors, cron monitors, alerts, and dashboards
**Server path:** `/sentry-monitors` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`sentry_monitors_create_a_monitor`](#sentry_monitors_create_a_monitor) | Create a new monitor. |
| [`sentry_monitors_create_a_monitor_for_a_project`](#sentry_monitors_create_a_monitor_for_a_project) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Create a Monitor for a project |
| [`sentry_monitors_create_a_new_dashboard_for_an_organization`](#sentry_monitors_create_a_new_dashboard_for_an_organization) | Create a new dashboard for the given Organization |
| [`sentry_monitors_create_an_alert_for_an_organization`](#sentry_monitors_create_an_alert_for_an_organization) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Creates an alert for an organization |
| [`sentry_monitors_delete_a_monitor`](#sentry_monitors_delete_a_monitor) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Delete a monitor |
| [`sentry_monitors_delete_an_alert`](#sentry_monitors_delete_an_alert) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Deletes an alert. |
| [`sentry_monitors_edit_an_organization_s_custom_dashboard`](#sentry_monitors_edit_an_organization_s_custom_dashboard) | Edit an organization's custom dashboard as well as any bulk edits on widgets that may have been made. (For example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.) |
| [`sentry_monitors_fetch_a_monitor`](#sentry_monitors_fetch_a_monitor) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Return details on an individual monitor |
| [`sentry_monitors_fetch_alerts`](#sentry_monitors_fetch_alerts) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Returns a list of alerts for a given organization |
| [`sentry_monitors_fetch_an_alert`](#sentry_monitors_fetch_an_alert) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Returns an alert. |
| [`sentry_monitors_fetch_an_organization_s_monitors`](#sentry_monitors_fetch_an_organization_s_monitors) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. List an Organization's Monitors |
| [`sentry_monitors_list_an_organization_s_custom_dashboards`](#sentry_monitors_list_an_organization_s_custom_dashboards) | Retrieve a list of custom dashboards that are associated with the given organization. |
| [`sentry_monitors_retrieve_a_monitor`](#sentry_monitors_retrieve_a_monitor) | Retrieves details for a monitor. |
| [`sentry_monitors_retrieve_an_organization_s_custom_dashboard`](#sentry_monitors_retrieve_an_organization_s_custom_dashboard) | Return details about an organization's custom dashboard. |
| [`sentry_monitors_retrieve_check_ins_for_a_monitor`](#sentry_monitors_retrieve_check_ins_for_a_monitor) | Retrieve a list of check-ins for a monitor |
| [`sentry_monitors_retrieve_monitors_for_an_organization`](#sentry_monitors_retrieve_monitors_for_an_organization) | Lists monitors, including nested monitor environments. May be filtered to a project or environment. |
| [`sentry_monitors_update_a_monitor`](#sentry_monitors_update_a_monitor) | Update a monitor. |
| [`sentry_monitors_update_a_monitor_by_id`](#sentry_monitors_update_a_monitor_by_id) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Update an existing monitor |
| [`sentry_monitors_update_an_alert_by_id`](#sentry_monitors_update_an_alert_by_id) | ⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Updates an alert. |
***
## sentry\_monitors\_create\_a\_monitor
Create a new monitor.
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `config` | object | Yes | — | The configuration for the monitor. | |
| `is_muted` | boolean | No | — | Disable creation of monitor incidents | |
| `name` | string | Yes | — | Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name. | |
| `owner` | string | null | No | — | The ID of the team or user that owns the monitor. (eg. user:51 or team:6) |
| `project` | string | Yes | — | The project slug to associate the monitor to. | |
| `slug` | string | No | — | Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls. | |
| `status` | string | No | — | Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota. \* `active` \* `disabled` | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"config": {
"description": "The configuration for the monitor."
},
"is_muted": {
"type": "boolean",
"description": "Disable creation of monitor incidents"
},
"name": {
"type": "string",
"description": "Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name."
},
"owner": {
"type": [
"string",
"null"
],
"description": "The ID of the team or user that owns the monitor. (eg. user:51 or team:6)"
},
"project": {
"type": "string",
"description": "The project slug to associate the monitor to."
},
"slug": {
"type": "string",
"description": "Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls."
},
"status": {
"type": "string",
"description": "Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota. * `active` * `disabled`",
"enum": [
"active",
"disabled"
]
}
},
"required": [
"PCID",
"organization_id_or_slug",
"config",
"name",
"project"
]
}
```
***
## sentry\_monitors\_create\_a\_monitor\_for\_a\_project
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Create a Monitor for a project
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `project_id_or_slug` | string | Yes | — | The ID or slug of the project the resource belongs to. | |
| `condition_group` | object | No | — | Issue detection configuration for when to create an issue and at what priority level. - `logicType`: `any` - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic) - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. "Create a metric issue when there are more than 5 unresolved error events". - If creating a **dynamic** monitor, see the options below. - `seasonality`: `auto` - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high` - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold. - `0`: Above - `1`: Below - `2`: Above and below - `conditionResult`: The issue state change when the threshold is crossed. - `75`: High priority - `50`: Low priority - `0`: Resolved **Threshold and Change Monitor** `json "logicType": "any", "conditions": [ { "type": "gt", "comparison": 10, "conditionResult": 75 }, { "type": "lte", "comparison": 10, "conditionResult": 0 } ], "actions": [] ` **Threshold Monitor with Medium Priority** `json "logicType": "any", "conditions": [ { type: "gt", comparison: 5, conditionResult: 75 }, { type: "gt", comparison: 2, conditionResult: 50 }, { type: "lte", comparison: 2, conditionResult: 0 } ], "actions": [] ` **Dynamic Monitor** `json "logicType": "any", "conditions": [ { "type": "anomaly_detection", "comparison": { "seasonality": "auto", "sensitivity": "medium", "thresholdType": 2 }, "conditionResult": 75 } ], "actions": [] ` | |
| `config` | object | No | — | The issue detection type configuration. - `detectionType` - `static`: Threshold based monitor - `percent`: Change based monitor - `dynamic`: Dynamic monitor - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes. For example, a value of 3600 compares the metric tracked against data 1 hour ago. - `300`: 5 minutes - `900`: 15 minutes - `3600`: 1 hour - `86400`: 1 day - `604800`: 1 week - `2592000`: 1 month **Threshold** `json { "detectionType": "static", } ` **Change** `json { "detectionType": "percent", "comparisonDelta": 3600, } ` **Dynamic** `json { "detectionType": "dynamic", } ` | |
| `data_sources` | any\[] | No | — | The data sources for the monitor to use based on what you want to measure. **Number of Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. `json [ { "aggregate": "count()", "dataset" : "events", "environment": "prod", "eventTypes": ["default", "error"], "query": "is:unresolved", "queryType": 0, "timeWindow": 3600, }, ], ` **Users Experiencing Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. `json [ { "aggregate": "count_unique(tags[sentry:user])", "dataset" : "events", "environment": "prod", "eventTypes": ["default", "error"], "query": "is:unresolved", "queryType": 0, "timeWindow": 3600, }, ], ` **Throughput Metric Monitor** `json [ { "aggregate":"count(span.duration)", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Duration Metric Monitor** `json [ { "aggregate":"p95(span.duration)", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Failure Rate Metric Monitor** `json [ { "aggregate":"failure_rate()", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Largest Contentful Paint Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile. `json [ { "aggregate":"p95(measurements.lcp)", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Custom Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are: `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile. `failure_rate()` `apdex(x)`, where `x` is the value of the Apdex score. `count()` \`\`\`json \[ \{ "aggregate": "p75(measurements.ttfb)" "dataset": "events\_analytics\_platform", "queryType": 1, }, ], | |
| `description` | string | null | No | — | A description of the monitor. Will be used in the resulting issue. |
| `enabled` | boolean | No | — | Set to False if you want to disable the monitor. | |
| `name` | string | Yes | — | Name of the monitor. | |
| `owner` | string | null | No | — | The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** `json "user:123456" ` **Team** `json "team:456789" ` |
| `type` | string | Yes | — | The type of monitor - `metric_issue`. | |
| `workflow_ids` | integer\[] | No | — | The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs. | |
````json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"project_id_or_slug": {
"type": "string",
"description": "The ID or slug of the project the resource belongs to."
},
"condition_group": {
"description": "Issue detection configuration for when to create an issue and at what priority level. - `logicType`: `any` - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic) - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. \"Create a metric issue when there are more than 5 unresolved error events\". - If creating a **dynamic** monitor, see the options below. - `seasonality`: `auto` - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high` - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold. - `0`: Above - `1`: Below - `2`: Above and below - `conditionResult`: The issue state change when the threshold is crossed. - `75`: High priority - `50`: Low priority - `0`: Resolved **Threshold and Change Monitor** ```json \"logicType\": \"any\", \"conditions\": [ { \"type\": \"gt\", \"comparison\": 10, \"conditionResult\": 75 }, { \"type\": \"lte\", \"comparison\": 10, \"conditionResult\": 0 } ], \"actions\": [] ``` **Threshold Monitor with Medium Priority** ```json \"logicType\": \"any\", \"conditions\": [ { type: \"gt\", comparison: 5, conditionResult: 75 }, { type: \"gt\", comparison: 2, conditionResult: 50 }, { type: \"lte\", comparison: 2, conditionResult: 0 } ], \"actions\": [] ``` **Dynamic Monitor** ```json \"logicType\": \"any\", \"conditions\": [ { \"type\": \"anomaly_detection\", \"comparison\": { \"seasonality\": \"auto\", \"sensitivity\": \"medium\", \"thresholdType\": 2 }, \"conditionResult\": 75 } ], \"actions\": [] ```"
},
"config": {
"type": "object",
"description": "The issue detection type configuration. - `detectionType` - `static`: Threshold based monitor - `percent`: Change based monitor - `dynamic`: Dynamic monitor - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes. For example, a value of 3600 compares the metric tracked against data 1 hour ago. - `300`: 5 minutes - `900`: 15 minutes - `3600`: 1 hour - `86400`: 1 day - `604800`: 1 week - `2592000`: 1 month **Threshold** ```json { \"detectionType\": \"static\", } ``` **Change** ```json { \"detectionType\": \"percent\", \"comparisonDelta\": 3600, } ``` **Dynamic** ```json { \"detectionType\": \"dynamic\", } ```"
},
"data_sources": {
"type": "array",
"description": "The data sources for the monitor to use based on what you want to measure. **Number of Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. ```json [ { \"aggregate\": \"count()\", \"dataset\" : \"events\", \"environment\": \"prod\", \"eventTypes\": [\"default\", \"error\"], \"query\": \"is:unresolved\", \"queryType\": 0, \"timeWindow\": 3600, }, ], ``` **Users Experiencing Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. ```json [ { \"aggregate\": \"count_unique(tags[sentry:user])\", \"dataset\" : \"events\", \"environment\": \"prod\", \"eventTypes\": [\"default\", \"error\"], \"query\": \"is:unresolved\", \"queryType\": 0, \"timeWindow\": 3600, }, ], ``` **Throughput Metric Monitor** ```json [ { \"aggregate\":\"count(span.duration)\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Duration Metric Monitor** ```json [ { \"aggregate\":\"p95(span.duration)\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Failure Rate Metric Monitor** ```json [ { \"aggregate\":\"failure_rate()\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Largest Contentful Paint Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile. ```json [ { \"aggregate\":\"p95(measurements.lcp)\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Custom Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are: `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile. `failure_rate()` `apdex(x)`, where `x` is the value of the Apdex score. `count()` ```json [ { \"aggregate\": \"p75(measurements.ttfb)\" \"dataset\": \"events_analytics_platform\", \"queryType\": 1, }, ],"
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the monitor. Will be used in the resulting issue."
},
"enabled": {
"type": "boolean",
"description": "Set to False if you want to disable the monitor."
},
"name": {
"type": "string",
"description": "Name of the monitor."
},
"owner": {
"type": [
"string",
"null"
],
"description": "The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** ```json \"user:123456\" ``` **Team** ```json \"team:456789\" ```"
},
"type": {
"type": "string",
"description": "The type of monitor - `metric_issue`."
},
"workflow_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"project_id_or_slug",
"name",
"type"
]
}
````
***
## sentry\_monitors\_create\_a\_new\_dashboard\_for\_an\_organization
Create a new dashboard for the given Organization
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------- | ----------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `end` | string | null | No | — | The saved end time for this dashboard. |
| `environment` | string\[] | No | — | The saved environment filter for this dashboard. | |
| `filters` | object | No | — | The saved filters for this dashboard. | |
| `id` | string | No | — | A dashboard's unique id. | |
| `is_favorited` | boolean | No | — | Favorite the dashboard automatically for the request user | |
| `period` | string | null | No | — | The saved time range period for this dashboard. |
| `permissions` | object | No | — | Permissions that restrict users from editing dashboards | |
| `projects` | integer\[] | No | — | The saved projects filter for this dashboard. | |
| `start` | string | null | No | — | The saved start time for this dashboard. |
| `title` | string | Yes | — | The user defined title for this dashboard. | |
| `utc` | boolean | No | — | Setting that lets you display saved time range for this dashboard in UTC. | |
| `widgets` | object\[] | No | — | A json list of widgets saved in this dashboard. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"end": {
"type": [
"string",
"null"
],
"description": "The saved end time for this dashboard."
},
"environment": {
"type": "array",
"items": {
"type": "string"
},
"description": "The saved environment filter for this dashboard."
},
"filters": {
"type": "object",
"description": "The saved filters for this dashboard."
},
"id": {
"type": "string",
"description": "A dashboard's unique id."
},
"is_favorited": {
"type": "boolean",
"description": "Favorite the dashboard automatically for the request user"
},
"period": {
"type": [
"string",
"null"
],
"description": "The saved time range period for this dashboard."
},
"permissions": {
"description": "Permissions that restrict users from editing dashboards"
},
"projects": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The saved projects filter for this dashboard."
},
"start": {
"type": [
"string",
"null"
],
"description": "The saved start time for this dashboard."
},
"title": {
"type": "string",
"description": "The user defined title for this dashboard."
},
"utc": {
"type": "boolean",
"description": "Setting that lets you display saved time range for this dashboard in UTC."
},
"widgets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"title": {
"type": "string",
"description": "The title value"
},
"description": {
"type": "string",
"description": "The description value"
},
"thresholds": {
"type": "object",
"description": "The thresholds value"
},
"display_type": {
"type": "string",
"enum": [
"line",
"area",
"stacked_area",
"bar",
"table",
"big_number",
"top_n",
"details",
"categorical_bar",
"wheel",
"rage_and_dead_clicks",
"server_tree",
"text",
"agents_traces_table"
],
"description": "* `line` * `area` * `stacked_area` * `bar` * `table` * `big_number` * `top_n` * `details` * `categorical_bar` * `wheel` * `rage_and_dead_clicks` * `server_tree` * `text` * `agents_traces_table`"
},
"interval": {
"type": "string",
"description": "The interval value"
},
"queries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"fields": {
"type": "array"
},
"aggregates": {
"type": "array"
},
"columns": {
"type": "array"
},
"field_aliases": {
"type": "array"
},
"name": {
"type": "string"
},
"conditions": {
"type": "string"
},
"orderby": {
"type": "string"
},
"is_hidden": {
"type": "boolean"
},
"on_demand_extraction": {
"type": "object",
"description": "Allows parameters to be defined in snake case, but passed as camel case. Errors are output in camel case."
},
"on_demand_extraction_disabled": {
"type": "boolean"
},
"selected_aggregate": {
"type": "integer"
},
"linked_dashboards": {
"type": "array"
}
}
},
"description": "The queries value"
},
"widget_type": {
"type": "string",
"enum": [
"discover",
"issue",
"metrics",
"error-events",
"transaction-like",
"spans",
"logs",
"tracemetrics",
"preprod-app-size"
],
"description": "* `discover` * `issue` * `metrics` * `error-events` * `transaction-like` * `spans` * `logs` * `tracemetrics` * `preprod-app-size`"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"layout": {
"description": "The layout value"
},
"axis_range": {
"type": "string",
"enum": [
"auto",
"dataMin"
],
"description": "* `auto` * `dataMin`"
},
"legend_type": {
"type": "string",
"enum": [
"default",
"breakdown"
],
"description": "* `default` * `breakdown`"
}
}
},
"description": "A json list of widgets saved in this dashboard."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"title"
]
}
```
***
## sentry\_monitors\_create\_an\_alert\_for\_an\_organization
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Creates an alert for an organization
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `action_filters` | any\[] | No | — | The filters to run before the action will fire and the action(s) to fire. `logicType` can be one of `any-short`, `all`, or `none`. Below is a basic example. See below for all other options. `json "actionFilters": [ { "logicType": "any", "conditions": [ { "type": "level", "comparison": { "level": 50, "match": "eq" }, "conditionResult": true } ], "actions": [ { "id": "123", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "user", "targetDisplay": null, "targetIdentifier": "56789" }, "status": "active" } ] } ] ` ## Conditions **Issue Age** - `time`: One of `minute`, `hour`, `day`, or `week`. - `value`: A positive integer. - `comparisonType`: One of `older` or `newer`. `json { "type": "age_comparison", "comparison": { "time": "minute", "value": 10, "comparisonType": "older" }, "conditionResult": true } ` **Issue Assignment** - `targetType`: Who the issue is assigned to - `Unassigned`: Unassigned - `Member`: Assigned to a user - `Team`: Assigned to a team - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter "" if `targetType` is `Unassigned`. `json { "type": "assigned_to", "comparison": { "targetType": "Member", "targetIdentifier": 123456 }, "conditionResult": true } ` **Issue Category** - `value`: The issue category to filter to. - `1`: Error issues - `6`: Feedback issues - `10`: Outage issues - `11`: Metric issues - `12`: DB Query issues - `13`: HTTP Client issues - `14`: Front end issues - `15`: Mobile issues `json { "type": "issue_category", "comparison": { "value": 1 }, "conditionResult": true } ` **Issue Frequency** - `value`: A positive integer representing how many times the issue has to happen before the alert will fire. `json { "type": "issue_occurrences", "comparison": { "value": 10 }, "conditionResult": true } ` **De-escalation** `json { "type": "issue_priority_deescalating", "comparison": true, "conditionResult": true } ` **Issue Priority** - `comparison`: The priority the issue must be for the alert to fire. - `75`: High priority - `50`: Medium priority - `25`: Low priority `json { "type": "issue_priority_greater_or_equal", "comparison": 75, "conditionResult": true } ` **Number of Users Affected** - `value`: A positive integer representing the number of users that must be affected before the alert will fire. - `filters`: A list of additional sub-filters to evaluate before the alert will fire. - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days `json { "type": "event_unique_user_frequency_count", "comparison": { "value": 100, "filters": [{"key": "foo", "match": "eq", "value": "bar"}], "interval": "1h" }, "conditionResult": true } ` **Number of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days `json { "type": "event_frequency_count", "comparison": { "value": 100, "interval": "1h" }, "conditionResult": true } ` **Percent of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. `json { "type": "event_frequency_percent", "comparison": { "value": 100, "interval": "1h", "comparisonInterval": "1w" }, "conditionResult": true } ` **Percentage of Sessions Affected Count** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days `json { "type": "percent_sessions_count", "comparison": { "value": 10, "interval": "1h" }, "conditionResult": true } ` **Percentage of Sessions Affected Percent** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. `json { "type": "percent_sessions_percent", "comparison": { "value": 10, "interval": "1h" }, "conditionResult": true } ` **Event Attribute** The event's `attribute` value `match` `value` - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`. - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. `json { "type": "event_attribute", "comparison": { "match": "co", "value": "bar", "attribute": "message" }, "conditionResult": true } ` **Tagged Event** The event's tags `key` match `value` - `key`: The tag value - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. `json { "type": "tagged_event", "comparison": { "key": "level", "match": "eq", "value": "error" }, "conditionResult": true } ` **Latest Release** The event is from the latest release `json { "type": "latest_release", "comparison": true, "conditionResult": true } ` **Release Age** `json { "type": "latest_adopted_release", "comparison": { "environment": "12345", "ageComparison": "older", "releaseAgeType": "oldest" }, "conditionResult": true } ` **Event Level** The event's level is `match` `level` - `match`: The comparison operator - `eq`: Equal - `gte`: Greater than or equal - `lte`: Less than or equal - `level`: The event level - `50`: Fatal - `40`: Error - `30`: Warning - `20`: Info - `10`: Debug - `0`: Sample `json { "type": "level", "comparison": { "level": 50, "match": "eq" }, "conditionResult": true } ` ## Actions A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions. **Notify on Preferred Channel** - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team. - `fallthroughType` - `ActiveMembers` - `AllMembers` - `NoOne` - `config`: A dictionary with the configuration options for notification. - `targetType`: The type of recipient to notify - `user`: User - `team`: Team - `issue_owners`: Suggested Assignees - `targetDisplay`: null - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees. `json { "type":"email", "integrationId":null, "data":{}, "config":{ "targetType":"user", "targetDisplay":null, "targetIdentifier":"232692" }, "status":"active" }, { "type":"email", "integrationId":null, "data":{ "fallthroughType":"ActiveMembers" }, "config":{ "targetType":"issue_owners", "targetDisplay":null, "targetIdentifier":""} , "status":"active" } ` **Notify on Slack** - `targetDisplay`: The name of the channel to notify in. `integrationId`: The stringified ID of the integration. `json { "type":"slack", "config":{ "targetType":"specific", "targetIdentifier":"", "targetDisplay":"notify-errors" }, "integrationId":"1", "data":{}, "status":"active" } ` **Notify on PagerDuty** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data["priority"]`: The severity level for the notification. `json { "type":"pagerduty", "config":{ "targetType":"specific", "targetIdentifier":"123456", "targetDisplay":"Error Service" }, "integrationId":"2345", "data":{ "priority":"default" }, "status":"active" } ` **Notify on Discord** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data["tags"]`: Comma separated list of tags to add to the notification. `json { "type":"discord", "config":{ "targetType":"specific", "targetIdentifier":"12345", "targetDisplay":"", }, "integrationId":"1234", "data":{ "tags":"transaction,environment" }, "status":"active" } ` **Notify on MSTeams** - `targetIdentifier` - The integration ID associated with the Microsoft Teams team. - `targetDisplay` - The name of the channel to send the notification to. - `integrationId`: The stringified ID of the integration. `json { "type":"msteams", "config":{ "targetType":"specific", "targetIdentifier":"19:a4b3kghaghgkjah357y6847@thread.skype", "targetDisplay":"notify-errors" }, "integrationId":"1", "data":{}, "status":"active" } ` **Notify on OpsGenie** - `targetDisplay`: The name of the Opsgenie team. - `targetIdentifier`: The ID of the Opsgenie team to send the notification to. - `integrationId`: The stringified ID of the integration. - `data["priority"]`: The priority level for the notification. `json { "type":"opsgenie", "config":{ "targetType":"specific", "targetIdentifier":"123456-Error-Service", "targetDisplay":"Error Service" }, "integrationId":"2345", "data":{ "priority":"P3" }, "status":"active" } ` **Notify on Azure DevOps** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"vsts", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{...}, "status":"active" } ` **Create a Jira ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"jira", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{...}, "status":"active" } ` **Create a Jira Server ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"jira_server", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{...}, "status":"active" } ` **Create a GitHub issue** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"github", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{ "additional_fields": { "assignee": "", "integration": "2345", "labels": [], "repo": "example-repo", }, "dynamic_form_fields": [ { "choices": [["YourOrg/example-repo", "example-repo"]], "default": "YourOrg/example-repo", "label": "GitHub Repository", "name": "repo", "required": true "type": "select", "updatesForm": true, "url": "/extensions/github/search/example-repo/1234567/", }, ], }, "status":"active" } ` | |
| `config` | object | No | — | Typically the frequency at which the alert will fire, in minutes. - `0`: 0 minutes - `5`: 5 minutes - `10`: 10 minutes - `30`: 30 minutes - `60`: 1 hour - `180`: 3 hours - `720`: 12 hours - `1440`: 24 hours `json { "frequency":3600 } ` | |
| `detector_ids` | integer\[] | No | — | The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs. | |
| `enabled` | boolean | No | — | Whether the alert is enabled or disabled | |
| `environment` | string | null | No | — | The name of the environment for the alert to evaluate in |
| `id` | string | No | — | The ID of the existing alert | |
| `name` | string | Yes | — | The name of the alert | |
| `owner` | string | null | No | — | The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** `json "user:123456" ` **Team** `json "team:456789" ` |
| `triggers` | object | No | — | The conditions on which the alert will trigger. See available options below. `json "triggers": { "organizationId": "1", "logicType": "any-short", "conditions": [ { "type": "first_seen_event", "comparison": true, "conditionResult": true }, { "type": "issue_resolved_trigger", "comparison": true, "conditionResult": true }, { "type": "reappeared_event", "comparison": true, "conditionResult": true }, { "type": "regression_event", "comparison": true, "conditionResult": true } ], "actions": [] } ` | |
````json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"action_filters": {
"type": "array",
"description": "The filters to run before the action will fire and the action(s) to fire. `logicType` can be one of `any-short`, `all`, or `none`. Below is a basic example. See below for all other options. ```json \"actionFilters\": [ { \"logicType\": \"any\", \"conditions\": [ { \"type\": \"level\", \"comparison\": { \"level\": 50, \"match\": \"eq\" }, \"conditionResult\": true } ], \"actions\": [ { \"id\": \"123\", \"type\": \"email\", \"integrationId\": null, \"data\": {}, \"config\": { \"targetType\": \"user\", \"targetDisplay\": null, \"targetIdentifier\": \"56789\" }, \"status\": \"active\" } ] } ] ``` ## Conditions **Issue Age** - `time`: One of `minute`, `hour`, `day`, or `week`. - `value`: A positive integer. - `comparisonType`: One of `older` or `newer`. ```json { \"type\": \"age_comparison\", \"comparison\": { \"time\": \"minute\", \"value\": 10, \"comparisonType\": \"older\" }, \"conditionResult\": true } ``` **Issue Assignment** - `targetType`: Who the issue is assigned to - `Unassigned`: Unassigned - `Member`: Assigned to a user - `Team`: Assigned to a team - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter \"\" if `targetType` is `Unassigned`. ```json { \"type\": \"assigned_to\", \"comparison\": { \"targetType\": \"Member\", \"targetIdentifier\": 123456 }, \"conditionResult\": true } ``` **Issue Category** - `value`: The issue category to filter to. - `1`: Error issues - `6`: Feedback issues - `10`: Outage issues - `11`: Metric issues - `12`: DB Query issues - `13`: HTTP Client issues - `14`: Front end issues - `15`: Mobile issues ```json { \"type\": \"issue_category\", \"comparison\": { \"value\": 1 }, \"conditionResult\": true } ``` **Issue Frequency** - `value`: A positive integer representing how many times the issue has to happen before the alert will fire. ```json { \"type\": \"issue_occurrences\", \"comparison\": { \"value\": 10 }, \"conditionResult\": true } ``` **De-escalation** ```json { \"type\": \"issue_priority_deescalating\", \"comparison\": true, \"conditionResult\": true } ``` **Issue Priority** - `comparison`: The priority the issue must be for the alert to fire. - `75`: High priority - `50`: Medium priority - `25`: Low priority ```json { \"type\": \"issue_priority_greater_or_equal\", \"comparison\": 75, \"conditionResult\": true } ``` **Number of Users Affected** - `value`: A positive integer representing the number of users that must be affected before the alert will fire. - `filters`: A list of additional sub-filters to evaluate before the alert will fire. - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days ```json { \"type\": \"event_unique_user_frequency_count\", \"comparison\": { \"value\": 100, \"filters\": [{\"key\": \"foo\", \"match\": \"eq\", \"value\": \"bar\"}], \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Number of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days ```json { \"type\": \"event_frequency_count\", \"comparison\": { \"value\": 100, \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Percent of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. ```json { \"type\": \"event_frequency_percent\", \"comparison\": { \"value\": 100, \"interval\": \"1h\", \"comparisonInterval\": \"1w\" }, \"conditionResult\": true } ``` **Percentage of Sessions Affected Count** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days ```json { \"type\": \"percent_sessions_count\", \"comparison\": { \"value\": 10, \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Percentage of Sessions Affected Percent** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. ```json { \"type\": \"percent_sessions_percent\", \"comparison\": { \"value\": 10, \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Event Attribute** The event's `attribute` value `match` `value` - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`. - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. ```json { \"type\": \"event_attribute\", \"comparison\": { \"match\": \"co\", \"value\": \"bar\", \"attribute\": \"message\" }, \"conditionResult\": true } ``` **Tagged Event** The event's tags `key` match `value` - `key`: The tag value - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. ```json { \"type\": \"tagged_event\", \"comparison\": { \"key\": \"level\", \"match\": \"eq\", \"value\": \"error\" }, \"conditionResult\": true } ``` **Latest Release** The event is from the latest release ```json { \"type\": \"latest_release\", \"comparison\": true, \"conditionResult\": true } ``` **Release Age** ```json { \"type\": \"latest_adopted_release\", \"comparison\": { \"environment\": \"12345\", \"ageComparison\": \"older\", \"releaseAgeType\": \"oldest\" }, \"conditionResult\": true } ``` **Event Level** The event's level is `match` `level` - `match`: The comparison operator - `eq`: Equal - `gte`: Greater than or equal - `lte`: Less than or equal - `level`: The event level - `50`: Fatal - `40`: Error - `30`: Warning - `20`: Info - `10`: Debug - `0`: Sample ```json { \"type\": \"level\", \"comparison\": { \"level\": 50, \"match\": \"eq\" }, \"conditionResult\": true } ``` ## Actions A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions. **Notify on Preferred Channel** - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team. - `fallthroughType` - `ActiveMembers` - `AllMembers` - `NoOne` - `config`: A dictionary with the configuration options for notification. - `targetType`: The type of recipient to notify - `user`: User - `team`: Team - `issue_owners`: Suggested Assignees - `targetDisplay`: null - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees. ```json { \"type\":\"email\", \"integrationId\":null, \"data\":{}, \"config\":{ \"targetType\":\"user\", \"targetDisplay\":null, \"targetIdentifier\":\"232692\" }, \"status\":\"active\" }, { \"type\":\"email\", \"integrationId\":null, \"data\":{ \"fallthroughType\":\"ActiveMembers\" }, \"config\":{ \"targetType\":\"issue_owners\", \"targetDisplay\":null, \"targetIdentifier\":\"\"} , \"status\":\"active\" } ``` **Notify on Slack** - `targetDisplay`: The name of the channel to notify in. `integrationId`: The stringified ID of the integration. ```json { \"type\":\"slack\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"\", \"targetDisplay\":\"notify-errors\" }, \"integrationId\":\"1\", \"data\":{}, \"status\":\"active\" } ``` **Notify on PagerDuty** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data[\"priority\"]`: The severity level for the notification. ```json { \"type\":\"pagerduty\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"123456\", \"targetDisplay\":\"Error Service\" }, \"integrationId\":\"2345\", \"data\":{ \"priority\":\"default\" }, \"status\":\"active\" } ``` **Notify on Discord** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data[\"tags\"]`: Comma separated list of tags to add to the notification. ```json { \"type\":\"discord\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"12345\", \"targetDisplay\":\"\", }, \"integrationId\":\"1234\", \"data\":{ \"tags\":\"transaction,environment\" }, \"status\":\"active\" } ``` **Notify on MSTeams** - `targetIdentifier` - The integration ID associated with the Microsoft Teams team. - `targetDisplay` - The name of the channel to send the notification to. - `integrationId`: The stringified ID of the integration. ```json { \"type\":\"msteams\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"19:a4b3kghaghgkjah357y6847@thread.skype\", \"targetDisplay\":\"notify-errors\" }, \"integrationId\":\"1\", \"data\":{}, \"status\":\"active\" } ``` **Notify on OpsGenie** - `targetDisplay`: The name of the Opsgenie team. - `targetIdentifier`: The ID of the Opsgenie team to send the notification to. - `integrationId`: The stringified ID of the integration. - `data[\"priority\"]`: The priority level for the notification. ```json { \"type\":\"opsgenie\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"123456-Error-Service\", \"targetDisplay\":\"Error Service\" }, \"integrationId\":\"2345\", \"data\":{ \"priority\":\"P3\" }, \"status\":\"active\" } ``` **Notify on Azure DevOps** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"vsts\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{...}, \"status\":\"active\" } ``` **Create a Jira ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"jira\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{...}, \"status\":\"active\" } ``` **Create a Jira Server ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"jira_server\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{...}, \"status\":\"active\" } ``` **Create a GitHub issue** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"github\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{ \"additional_fields\": { \"assignee\": \"\", \"integration\": \"2345\", \"labels\": [], \"repo\": \"example-repo\", }, \"dynamic_form_fields\": [ { \"choices\": [[\"YourOrg/example-repo\", \"example-repo\"]], \"default\": \"YourOrg/example-repo\", \"label\": \"GitHub Repository\", \"name\": \"repo\", \"required\": true \"type\": \"select\", \"updatesForm\": true, \"url\": \"/extensions/github/search/example-repo/1234567/\", }, ], }, \"status\":\"active\" } ```"
},
"config": {
"type": "object",
"description": "Typically the frequency at which the alert will fire, in minutes. - `0`: 0 minutes - `5`: 5 minutes - `10`: 10 minutes - `30`: 30 minutes - `60`: 1 hour - `180`: 3 hours - `720`: 12 hours - `1440`: 24 hours ```json { \"frequency\":3600 } ```"
},
"detector_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs."
},
"enabled": {
"type": "boolean",
"description": "Whether the alert is enabled or disabled"
},
"environment": {
"type": [
"string",
"null"
],
"description": "The name of the environment for the alert to evaluate in"
},
"id": {
"type": "string",
"description": "The ID of the existing alert"
},
"name": {
"type": "string",
"description": "The name of the alert"
},
"owner": {
"type": [
"string",
"null"
],
"description": "The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** ```json \"user:123456\" ``` **Team** ```json \"team:456789\" ```"
},
"triggers": {
"description": "The conditions on which the alert will trigger. See available options below. ```json \"triggers\": { \"organizationId\": \"1\", \"logicType\": \"any-short\", \"conditions\": [ { \"type\": \"first_seen_event\", \"comparison\": true, \"conditionResult\": true }, { \"type\": \"issue_resolved_trigger\", \"comparison\": true, \"conditionResult\": true }, { \"type\": \"reappeared_event\", \"comparison\": true, \"conditionResult\": true }, { \"type\": \"regression_event\", \"comparison\": true, \"conditionResult\": true } ], \"actions\": [] } ```"
}
},
"required": [
"PCID",
"organization_id_or_slug",
"name"
]
}
````
***
## sentry\_monitors\_delete\_a\_monitor
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Delete a monitor
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `detector_id` | integer | Yes | — | The ID of the monitor you'd like to query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"detector_id": {
"type": "integer",
"description": "The ID of the monitor you'd like to query."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"detector_id"
]
}
```
***
## sentry\_monitors\_delete\_an\_alert
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Deletes an alert.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `workflow_id` | integer | Yes | — | The ID of the alert you'd like to query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"workflow_id": {
"type": "integer",
"description": "The ID of the alert you'd like to query."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"workflow_id"
]
}
```
***
## sentry\_monitors\_edit\_an\_organization\_s\_custom\_dashboard
Edit an organization's custom dashboard as well as any bulk edits on widgets that may have been made. (For example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.)
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------- | ----------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `dashboard_id` | integer | Yes | — | The ID of the dashboard you'd like to retrieve. | |
| `end` | string | null | No | — | The saved end time for this dashboard. |
| `environment` | string\[] | No | — | The saved environment filter for this dashboard. | |
| `filters` | object | No | — | The saved filters for this dashboard. | |
| `id` | string | No | — | A dashboard's unique id. | |
| `period` | string | null | No | — | The saved time range period for this dashboard. |
| `permissions` | object | No | — | Permissions that restrict users from editing dashboards | |
| `projects` | integer\[] | No | — | The saved projects filter for this dashboard. | |
| `start` | string | null | No | — | The saved start time for this dashboard. |
| `title` | string | No | — | The user-defined dashboard title. | |
| `utc` | boolean | No | — | Setting that lets you display saved time range for this dashboard in UTC. | |
| `widgets` | object\[] | No | — | A json list of widgets saved in this dashboard. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"dashboard_id": {
"type": "integer",
"description": "The ID of the dashboard you'd like to retrieve."
},
"end": {
"type": [
"string",
"null"
],
"description": "The saved end time for this dashboard."
},
"environment": {
"type": "array",
"items": {
"type": "string"
},
"description": "The saved environment filter for this dashboard."
},
"filters": {
"type": "object",
"description": "The saved filters for this dashboard."
},
"id": {
"type": "string",
"description": "A dashboard's unique id."
},
"period": {
"type": [
"string",
"null"
],
"description": "The saved time range period for this dashboard."
},
"permissions": {
"description": "Permissions that restrict users from editing dashboards"
},
"projects": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The saved projects filter for this dashboard."
},
"start": {
"type": [
"string",
"null"
],
"description": "The saved start time for this dashboard."
},
"title": {
"type": "string",
"description": "The user-defined dashboard title."
},
"utc": {
"type": "boolean",
"description": "Setting that lets you display saved time range for this dashboard in UTC."
},
"widgets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"title": {
"type": "string",
"description": "The title value"
},
"description": {
"type": "string",
"description": "The description value"
},
"thresholds": {
"type": "object",
"description": "The thresholds value"
},
"display_type": {
"type": "string",
"enum": [
"line",
"area",
"stacked_area",
"bar",
"table",
"big_number",
"top_n",
"details",
"categorical_bar",
"wheel",
"rage_and_dead_clicks",
"server_tree",
"text",
"agents_traces_table"
],
"description": "* `line` * `area` * `stacked_area` * `bar` * `table` * `big_number` * `top_n` * `details` * `categorical_bar` * `wheel` * `rage_and_dead_clicks` * `server_tree` * `text` * `agents_traces_table`"
},
"interval": {
"type": "string",
"description": "The interval value"
},
"queries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"fields": {
"type": "array"
},
"aggregates": {
"type": "array"
},
"columns": {
"type": "array"
},
"field_aliases": {
"type": "array"
},
"name": {
"type": "string"
},
"conditions": {
"type": "string"
},
"orderby": {
"type": "string"
},
"is_hidden": {
"type": "boolean"
},
"on_demand_extraction": {
"type": "object",
"description": "Allows parameters to be defined in snake case, but passed as camel case. Errors are output in camel case."
},
"on_demand_extraction_disabled": {
"type": "boolean"
},
"selected_aggregate": {
"type": "integer"
},
"linked_dashboards": {
"type": "array"
}
}
},
"description": "The queries value"
},
"widget_type": {
"type": "string",
"enum": [
"discover",
"issue",
"metrics",
"error-events",
"transaction-like",
"spans",
"logs",
"tracemetrics",
"preprod-app-size"
],
"description": "* `discover` * `issue` * `metrics` * `error-events` * `transaction-like` * `spans` * `logs` * `tracemetrics` * `preprod-app-size`"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"layout": {
"description": "The layout value"
},
"axis_range": {
"type": "string",
"enum": [
"auto",
"dataMin"
],
"description": "* `auto` * `dataMin`"
},
"legend_type": {
"type": "string",
"enum": [
"default",
"breakdown"
],
"description": "* `default` * `breakdown`"
}
}
},
"description": "A json list of widgets saved in this dashboard."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"dashboard_id"
]
}
```
***
## sentry\_monitors\_fetch\_a\_monitor
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Return details on an individual monitor
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `detector_id` | integer | Yes | — | The ID of the monitor you'd like to query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"detector_id": {
"type": "integer",
"description": "The ID of the monitor you'd like to query."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"detector_id"
]
}
```
***
## sentry\_monitors\_fetch\_alerts
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Returns a list of alerts for a given organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ---------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `sortBy` | string | No | — | The field to sort results by. If not specified, the results are sorted by id. Available fields are: - `name` - `id` - `dateCreated` - `dateUpdated` - `connectedDetectors` - `actions` - `priorityDetector` Prefix with `-` to sort in descending order. |
| `query` | string | No | — | An optional search query for filtering alerts. |
| `id` | integer\[] | No | — | The ID of the alert you'd like to query. |
| `project` | integer\[] | No | — | The IDs of projects to filter by. `-1` means all available projects. For example, the following are valid parameters: - `/?project=1234&project=56789` - `/?project=-1` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"sortBy": {
"type": "string",
"description": "The field to sort results by. If not specified, the results are sorted by id. Available fields are: - `name` - `id` - `dateCreated` - `dateUpdated` - `connectedDetectors` - `actions` - `priorityDetector` Prefix with `-` to sort in descending order."
},
"query": {
"type": "string",
"description": "An optional search query for filtering alerts."
},
"id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ID of the alert you'd like to query."
},
"project": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of projects to filter by. `-1` means all available projects. For example, the following are valid parameters: - `/?project=1234&project=56789` - `/?project=-1`"
}
},
"required": [
"PCID",
"organization_id_or_slug"
]
}
```
***
## sentry\_monitors\_fetch\_an\_alert
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Returns an alert.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `workflow_id` | integer | Yes | — | The ID of the alert you'd like to query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"workflow_id": {
"type": "integer",
"description": "The ID of the alert you'd like to query."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"workflow_id"
]
}
```
***
## sentry\_monitors\_fetch\_an\_organization\_s\_monitors
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. List an Organization's Monitors
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `project` | integer\[] | No | — | The IDs of projects to filter by. `-1` means all available projects. For example, the following are valid parameters: - `/?project=1234&project=56789` - `/?project=-1` |
| `query` | string | No | — | An optional search query for filtering monitors. Available fields are: - `name` - `type`: e.g. `error`, `metric_issue`, `issue_stream` - `assignee`: email, username, #team, me, none |
| `sortBy` | string | No | — | The property to sort results by. If not specified, the results are sorted by id. Available fields are: - `name` - `id` - `type` - `connectedWorkflows` - `latestGroup` - `openIssues` Prefix with `-` to sort in descending order. |
| `id` | integer\[] | No | — | The ID of the monitor you'd like to query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"project": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of projects to filter by. `-1` means all available projects. For example, the following are valid parameters: - `/?project=1234&project=56789` - `/?project=-1`"
},
"query": {
"type": "string",
"description": "An optional search query for filtering monitors. Available fields are: - `name` - `type`: e.g. `error`, `metric_issue`, `issue_stream` - `assignee`: email, username, #team, me, none"
},
"sortBy": {
"type": "string",
"description": "The property to sort results by. If not specified, the results are sorted by id. Available fields are: - `name` - `id` - `type` - `connectedWorkflows` - `latestGroup` - `openIssues` Prefix with `-` to sort in descending order."
},
"id": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ID of the monitor you'd like to query."
}
},
"required": [
"PCID",
"organization_id_or_slug"
]
}
```
***
## sentry\_monitors\_list\_an\_organization\_s\_custom\_dashboards
Retrieve a list of custom dashboards that are associated with the given organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `per_page` | integer | No | — | Limit the number of rows to return in the result. Default and maximum allowed is 100. |
| `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"per_page": {
"type": "integer",
"description": "Limit the number of rows to return in the result. Default and maximum allowed is 100."
},
"cursor": {
"type": "string",
"description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results."
}
},
"required": [
"PCID",
"organization_id_or_slug"
]
}
```
***
## sentry\_monitors\_retrieve\_a\_monitor
Retrieves details for a monitor.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | --------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `monitor_id_or_slug` | string | Yes | — | The ID or slug of the monitor. |
| `environment` | string\[] | No | — | The name of environments to filter by. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"monitor_id_or_slug": {
"type": "string",
"description": "The ID or slug of the monitor."
},
"environment": {
"type": "array",
"items": {
"type": "string"
},
"description": "The name of environments to filter by."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"monitor_id_or_slug"
]
}
```
***
## sentry\_monitors\_retrieve\_an\_organization\_s\_custom\_dashboard
Return details about an organization's custom dashboard.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `dashboard_id` | integer | Yes | — | The ID of the dashboard you'd like to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"dashboard_id": {
"type": "integer",
"description": "The ID of the dashboard you'd like to retrieve."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"dashboard_id"
]
}
```
***
## sentry\_monitors\_retrieve\_check\_ins\_for\_a\_monitor
Retrieve a list of check-ins for a monitor
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `monitor_id_or_slug` | string | Yes | — | The ID or slug of the monitor. |
| `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"monitor_id_or_slug": {
"type": "string",
"description": "The ID or slug of the monitor."
},
"cursor": {
"type": "string",
"description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"monitor_id_or_slug"
]
}
```
***
## sentry\_monitors\_retrieve\_monitors\_for\_an\_organization
Lists monitors, including nested monitor environments. May be filtered to a project or environment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. |
| `project` | integer\[] | No | — | The IDs of projects to filter by. `-1` means all available projects. For example, the following are valid parameters: - `/?project=1234&project=56789` - `/?project=-1` |
| `environment` | string\[] | No | — | The name of environments to filter by. |
| `owner` | string | No | — | The owner of the monitor, in the format `user:id` or `team:id`. May be specified multiple times. |
| `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"project": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of projects to filter by. `-1` means all available projects. For example, the following are valid parameters: - `/?project=1234&project=56789` - `/?project=-1`"
},
"environment": {
"type": "array",
"items": {
"type": "string"
},
"description": "The name of environments to filter by."
},
"owner": {
"type": "string",
"description": "The owner of the monitor, in the format `user:id` or `team:id`. May be specified multiple times."
},
"cursor": {
"type": "string",
"description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results."
}
},
"required": [
"PCID",
"organization_id_or_slug"
]
}
```
***
## sentry\_monitors\_update\_a\_monitor
Update a monitor.
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `monitor_id_or_slug` | string | Yes | — | The ID or slug of the monitor. | |
| `config` | object | Yes | — | The configuration for the monitor. | |
| `is_muted` | boolean | No | — | Disable creation of monitor incidents | |
| `name` | string | Yes | — | Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name. | |
| `owner` | string | null | No | — | The ID of the team or user that owns the monitor. (eg. user:51 or team:6) |
| `project` | string | Yes | — | The project slug to associate the monitor to. | |
| `slug` | string | No | — | Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls. | |
| `status` | string | No | — | Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota. \* `active` \* `disabled` | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"monitor_id_or_slug": {
"type": "string",
"description": "The ID or slug of the monitor."
},
"config": {
"description": "The configuration for the monitor."
},
"is_muted": {
"type": "boolean",
"description": "Disable creation of monitor incidents"
},
"name": {
"type": "string",
"description": "Name of the monitor. Used for notifications. If not set the slug will be derived from your monitor name."
},
"owner": {
"type": [
"string",
"null"
],
"description": "The ID of the team or user that owns the monitor. (eg. user:51 or team:6)"
},
"project": {
"type": "string",
"description": "The project slug to associate the monitor to."
},
"slug": {
"type": "string",
"description": "Uniquely identifies your monitor within your organization. Changing this slug will require updates to any instrumented check-in calls."
},
"status": {
"type": "string",
"description": "Status of the monitor. Disabled monitors will not accept events and will not count towards the monitor quota. * `active` * `disabled`",
"enum": [
"active",
"disabled"
]
}
},
"required": [
"PCID",
"organization_id_or_slug",
"monitor_id_or_slug",
"config",
"name",
"project"
]
}
```
***
## sentry\_monitors\_update\_a\_monitor\_by\_id
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Update an existing monitor
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `detector_id` | integer | Yes | — | The ID of the monitor you'd like to query. | |
| `condition_group` | object | No | — | Issue detection configuration for when to create an issue and at what priority level. - `logicType`: `any` - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic) - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. "Create a metric issue when there are more than 5 unresolved error events". - If creating a **dynamic** monitor, see the options below. - `seasonality`: `auto` - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high` - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold. - `0`: Above - `1`: Below - `2`: Above and below - `conditionResult`: The issue state change when the threshold is crossed. - `75`: High priority - `50`: Low priority - `0`: Resolved **Threshold and Change Monitor** `json "logicType": "any", "conditions": [ { "type": "gt", "comparison": 10, "conditionResult": 75 }, { "type": "lte", "comparison": 10, "conditionResult": 0 } ], "actions": [] ` **Threshold Monitor with Medium Priority** `json "logicType": "any", "conditions": [ { type: "gt", comparison: 5, conditionResult: 75 }, { type: "gt", comparison: 2, conditionResult: 50 }, { type: "lte", comparison: 2, conditionResult: 0 } ], "actions": [] ` **Dynamic Monitor** `json "logicType": "any", "conditions": [ { "type": "anomaly_detection", "comparison": { "seasonality": "auto", "sensitivity": "medium", "thresholdType": 2 }, "conditionResult": 75 } ], "actions": [] ` | |
| `config` | object | No | — | The issue detection type configuration. - `detectionType` - `static`: Threshold based monitor - `percent`: Change based monitor - `dynamic`: Dynamic monitor - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes. For example, a value of 3600 compares the metric tracked against data 1 hour ago. - `300`: 5 minutes - `900`: 15 minutes - `3600`: 1 hour - `86400`: 1 day - `604800`: 1 week - `2592000`: 1 month **Threshold** `json { "detectionType": "static", } ` **Change** `json { "detectionType": "percent", "comparisonDelta": 3600, } ` **Dynamic** `json { "detectionType": "dynamic", } ` | |
| `data_sources` | any\[] | No | — | The data sources for the monitor to use based on what you want to measure. **Number of Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. `json [ { "aggregate": "count()", "dataset" : "events", "environment": "prod", "eventTypes": ["default", "error"], "query": "is:unresolved", "queryType": 0, "timeWindow": 3600, }, ], ` **Users Experiencing Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. `json [ { "aggregate": "count_unique(tags[sentry:user])", "dataset" : "events", "environment": "prod", "eventTypes": ["default", "error"], "query": "is:unresolved", "queryType": 0, "timeWindow": 3600, }, ], ` **Throughput Metric Monitor** `json [ { "aggregate":"count(span.duration)", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Duration Metric Monitor** `json [ { "aggregate":"p95(span.duration)", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Failure Rate Metric Monitor** `json [ { "aggregate":"failure_rate()", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Largest Contentful Paint Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile. `json [ { "aggregate":"p95(measurements.lcp)", "dataset":"events_analytics_platform", "environment":"prod", "eventTypes":["trace_item_span"] "query":"", "queryType":1, "timeWindow":3600, "extrapolationMode":"unknown", }, ], ` **Custom Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are: `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile. `failure_rate()` `apdex(x)`, where `x` is the value of the Apdex score. `count()` \`\`\`json \[ \{ "aggregate": "p75(measurements.ttfb)" "dataset": "events\_analytics\_platform", "queryType": 1, }, ], | |
| `description` | string | null | No | — | A description of the monitor. Will be used in the resulting issue. |
| `enabled` | boolean | No | — | Set to False if you want to disable the monitor. | |
| `name` | string | Yes | — | Name of the monitor. | |
| `owner` | string | null | No | — | The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** `json "user:123456" ` **Team** `json "team:456789" ` |
| `type` | string | Yes | — | The type of monitor - `metric_issue`. | |
| `workflow_ids` | integer\[] | No | — | The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs. | |
````json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"detector_id": {
"type": "integer",
"description": "The ID of the monitor you'd like to query."
},
"condition_group": {
"description": "Issue detection configuration for when to create an issue and at what priority level. - `logicType`: `any` - `type`: Any of `gt` (greater than), `lte` (less than or equal), or `anomaly_detection` (dynamic) - `comparison`: Any positive integer. This is threshold that must be crossed for the monitor to create an issue, e.g. \"Create a metric issue when there are more than 5 unresolved error events\". - If creating a **dynamic** monitor, see the options below. - `seasonality`: `auto` - `sensitivity`: Level of responsiveness. Options are one of `low`, `medium`, or `high` - `thresholdType`: If you want to be alerted to anomalies that are moving above, below, or in both directions in relation to your threshold. - `0`: Above - `1`: Below - `2`: Above and below - `conditionResult`: The issue state change when the threshold is crossed. - `75`: High priority - `50`: Low priority - `0`: Resolved **Threshold and Change Monitor** ```json \"logicType\": \"any\", \"conditions\": [ { \"type\": \"gt\", \"comparison\": 10, \"conditionResult\": 75 }, { \"type\": \"lte\", \"comparison\": 10, \"conditionResult\": 0 } ], \"actions\": [] ``` **Threshold Monitor with Medium Priority** ```json \"logicType\": \"any\", \"conditions\": [ { type: \"gt\", comparison: 5, conditionResult: 75 }, { type: \"gt\", comparison: 2, conditionResult: 50 }, { type: \"lte\", comparison: 2, conditionResult: 0 } ], \"actions\": [] ``` **Dynamic Monitor** ```json \"logicType\": \"any\", \"conditions\": [ { \"type\": \"anomaly_detection\", \"comparison\": { \"seasonality\": \"auto\", \"sensitivity\": \"medium\", \"thresholdType\": 2 }, \"conditionResult\": 75 } ], \"actions\": [] ```"
},
"config": {
"type": "object",
"description": "The issue detection type configuration. - `detectionType` - `static`: Threshold based monitor - `percent`: Change based monitor - `dynamic`: Dynamic monitor - `comparisonDelta`: If selecting a **change** detection type, the comparison delta is the time period at which to compare against in minutes. For example, a value of 3600 compares the metric tracked against data 1 hour ago. - `300`: 5 minutes - `900`: 15 minutes - `3600`: 1 hour - `86400`: 1 day - `604800`: 1 week - `2592000`: 1 month **Threshold** ```json { \"detectionType\": \"static\", } ``` **Change** ```json { \"detectionType\": \"percent\", \"comparisonDelta\": 3600, } ``` **Dynamic** ```json { \"detectionType\": \"dynamic\", } ```"
},
"data_sources": {
"type": "array",
"description": "The data sources for the monitor to use based on what you want to measure. **Number of Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. ```json [ { \"aggregate\": \"count()\", \"dataset\" : \"events\", \"environment\": \"prod\", \"eventTypes\": [\"default\", \"error\"], \"query\": \"is:unresolved\", \"queryType\": 0, \"timeWindow\": 3600, }, ], ``` **Users Experiencing Errors Metric Monitor** - `eventTypes`: Any of `error` or `default`. ```json [ { \"aggregate\": \"count_unique(tags[sentry:user])\", \"dataset\" : \"events\", \"environment\": \"prod\", \"eventTypes\": [\"default\", \"error\"], \"query\": \"is:unresolved\", \"queryType\": 0, \"timeWindow\": 3600, }, ], ``` **Throughput Metric Monitor** ```json [ { \"aggregate\":\"count(span.duration)\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Duration Metric Monitor** ```json [ { \"aggregate\":\"p95(span.duration)\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Failure Rate Metric Monitor** ```json [ { \"aggregate\":\"failure_rate()\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Largest Contentful Paint Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are `avg(measurements.lcp)`, `p50(measurements.lcp)`, `p75(measurements.lcp)`, `p95(measurements.lcp)`, `p99(measurements.lcp)`, `p100(measurements.lcp)`, and `percentile(measurements.lcp,x)`, where `x` is your custom percentile. ```json [ { \"aggregate\":\"p95(measurements.lcp)\", \"dataset\":\"events_analytics_platform\", \"environment\":\"prod\", \"eventTypes\":[\"trace_item_span\"] \"query\":\"\", \"queryType\":1, \"timeWindow\":3600, \"extrapolationMode\":\"unknown\", }, ], ``` **Custom Metric Monitor** - `dataset`: If a custom percentile is used, dataset is `transactions`. Otherwise, dataset is `events_analytics_platform`. - `aggregate`: Valid values are: `avg(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p50(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p75(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p95(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p99(x)`, where x is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `p100(x)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`. `percentile(x,y)`, where `x` is `transaction.duration`, `measurements.cls`, `measurements.fcp`, `measurements.fid`, `measurements.fp`, `measurements.lcp`, `measurements.ttfb`, or `measurements.ttfb.requesttime`, and `y` is the custom percentile. `failure_rate()` `apdex(x)`, where `x` is the value of the Apdex score. `count()` ```json [ { \"aggregate\": \"p75(measurements.ttfb)\" \"dataset\": \"events_analytics_platform\", \"queryType\": 1, }, ],"
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the monitor. Will be used in the resulting issue."
},
"enabled": {
"type": "boolean",
"description": "Set to False if you want to disable the monitor."
},
"name": {
"type": "string",
"description": "Name of the monitor."
},
"owner": {
"type": [
"string",
"null"
],
"description": "The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** ```json \"user:123456\" ``` **Team** ```json \"team:456789\" ```"
},
"type": {
"type": "string",
"description": "The type of monitor - `metric_issue`."
},
"workflow_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the alerts to connect this monitor to. Use the 'Fetch Alerts' endpoint to find the IDs."
}
},
"required": [
"PCID",
"organization_id_or_slug",
"detector_id",
"name",
"type"
]
}
````
***
## sentry\_monitors\_update\_an\_alert\_by\_id
⚠️ This endpoint is currently in **beta** and may be subject to change. It is supported by New Monitors and Alerts and may not be viewable in the UI today. Updates an alert.
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------- | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | |
| `workflow_id` | integer | Yes | — | The ID of the alert you'd like to query. | |
| `action_filters` | any\[] | No | — | The filters to run before the action will fire and the action(s) to fire. `logicType` can be one of `any-short`, `all`, or `none`. Below is a basic example. See below for all other options. `json "actionFilters": [ { "logicType": "any", "conditions": [ { "type": "level", "comparison": { "level": 50, "match": "eq" }, "conditionResult": true } ], "actions": [ { "id": "123", "type": "email", "integrationId": null, "data": {}, "config": { "targetType": "user", "targetDisplay": null, "targetIdentifier": "56789" }, "status": "active" } ] } ] ` ## Conditions **Issue Age** - `time`: One of `minute`, `hour`, `day`, or `week`. - `value`: A positive integer. - `comparisonType`: One of `older` or `newer`. `json { "type": "age_comparison", "comparison": { "time": "minute", "value": 10, "comparisonType": "older" }, "conditionResult": true } ` **Issue Assignment** - `targetType`: Who the issue is assigned to - `Unassigned`: Unassigned - `Member`: Assigned to a user - `Team`: Assigned to a team - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter "" if `targetType` is `Unassigned`. `json { "type": "assigned_to", "comparison": { "targetType": "Member", "targetIdentifier": 123456 }, "conditionResult": true } ` **Issue Category** - `value`: The issue category to filter to. - `1`: Error issues - `6`: Feedback issues - `10`: Outage issues - `11`: Metric issues - `12`: DB Query issues - `13`: HTTP Client issues - `14`: Front end issues - `15`: Mobile issues `json { "type": "issue_category", "comparison": { "value": 1 }, "conditionResult": true } ` **Issue Frequency** - `value`: A positive integer representing how many times the issue has to happen before the alert will fire. `json { "type": "issue_occurrences", "comparison": { "value": 10 }, "conditionResult": true } ` **De-escalation** `json { "type": "issue_priority_deescalating", "comparison": true, "conditionResult": true } ` **Issue Priority** - `comparison`: The priority the issue must be for the alert to fire. - `75`: High priority - `50`: Medium priority - `25`: Low priority `json { "type": "issue_priority_greater_or_equal", "comparison": 75, "conditionResult": true } ` **Number of Users Affected** - `value`: A positive integer representing the number of users that must be affected before the alert will fire. - `filters`: A list of additional sub-filters to evaluate before the alert will fire. - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days `json { "type": "event_unique_user_frequency_count", "comparison": { "value": 100, "filters": [{"key": "foo", "match": "eq", "value": "bar"}], "interval": "1h" }, "conditionResult": true } ` **Number of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days `json { "type": "event_frequency_count", "comparison": { "value": 100, "interval": "1h" }, "conditionResult": true } ` **Percent of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. `json { "type": "event_frequency_percent", "comparison": { "value": 100, "interval": "1h", "comparisonInterval": "1w" }, "conditionResult": true } ` **Percentage of Sessions Affected Count** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days `json { "type": "percent_sessions_count", "comparison": { "value": 10, "interval": "1h" }, "conditionResult": true } ` **Percentage of Sessions Affected Percent** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. `json { "type": "percent_sessions_percent", "comparison": { "value": 10, "interval": "1h" }, "conditionResult": true } ` **Event Attribute** The event's `attribute` value `match` `value` - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`. - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. `json { "type": "event_attribute", "comparison": { "match": "co", "value": "bar", "attribute": "message" }, "conditionResult": true } ` **Tagged Event** The event's tags `key` match `value` - `key`: The tag value - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. `json { "type": "tagged_event", "comparison": { "key": "level", "match": "eq", "value": "error" }, "conditionResult": true } ` **Latest Release** The event is from the latest release `json { "type": "latest_release", "comparison": true, "conditionResult": true } ` **Release Age** `json { "type": "latest_adopted_release", "comparison": { "environment": "12345", "ageComparison": "older", "releaseAgeType": "oldest" }, "conditionResult": true } ` **Event Level** The event's level is `match` `level` - `match`: The comparison operator - `eq`: Equal - `gte`: Greater than or equal - `lte`: Less than or equal - `level`: The event level - `50`: Fatal - `40`: Error - `30`: Warning - `20`: Info - `10`: Debug - `0`: Sample `json { "type": "level", "comparison": { "level": 50, "match": "eq" }, "conditionResult": true } ` ## Actions A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions. **Notify on Preferred Channel** - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team. - `fallthroughType` - `ActiveMembers` - `AllMembers` - `NoOne` - `config`: A dictionary with the configuration options for notification. - `targetType`: The type of recipient to notify - `user`: User - `team`: Team - `issue_owners`: Suggested Assignees - `targetDisplay`: null - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees. `json { "type":"email", "integrationId":null, "data":{}, "config":{ "targetType":"user", "targetDisplay":null, "targetIdentifier":"232692" }, "status":"active" }, { "type":"email", "integrationId":null, "data":{ "fallthroughType":"ActiveMembers" }, "config":{ "targetType":"issue_owners", "targetDisplay":null, "targetIdentifier":""} , "status":"active" } ` **Notify on Slack** - `targetDisplay`: The name of the channel to notify in. `integrationId`: The stringified ID of the integration. `json { "type":"slack", "config":{ "targetType":"specific", "targetIdentifier":"", "targetDisplay":"notify-errors" }, "integrationId":"1", "data":{}, "status":"active" } ` **Notify on PagerDuty** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data["priority"]`: The severity level for the notification. `json { "type":"pagerduty", "config":{ "targetType":"specific", "targetIdentifier":"123456", "targetDisplay":"Error Service" }, "integrationId":"2345", "data":{ "priority":"default" }, "status":"active" } ` **Notify on Discord** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data["tags"]`: Comma separated list of tags to add to the notification. `json { "type":"discord", "config":{ "targetType":"specific", "targetIdentifier":"12345", "targetDisplay":"", }, "integrationId":"1234", "data":{ "tags":"transaction,environment" }, "status":"active" } ` **Notify on MSTeams** - `targetIdentifier` - The integration ID associated with the Microsoft Teams team. - `targetDisplay` - The name of the channel to send the notification to. - `integrationId`: The stringified ID of the integration. `json { "type":"msteams", "config":{ "targetType":"specific", "targetIdentifier":"19:a4b3kghaghgkjah357y6847@thread.skype", "targetDisplay":"notify-errors" }, "integrationId":"1", "data":{}, "status":"active" } ` **Notify on OpsGenie** - `targetDisplay`: The name of the Opsgenie team. - `targetIdentifier`: The ID of the Opsgenie team to send the notification to. - `integrationId`: The stringified ID of the integration. - `data["priority"]`: The priority level for the notification. `json { "type":"opsgenie", "config":{ "targetType":"specific", "targetIdentifier":"123456-Error-Service", "targetDisplay":"Error Service" }, "integrationId":"2345", "data":{ "priority":"P3" }, "status":"active" } ` **Notify on Azure DevOps** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"vsts", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{...}, "status":"active" } ` **Create a Jira ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"jira", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{...}, "status":"active" } ` **Create a Jira Server ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"jira_server", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{...}, "status":"active" } ` **Create a GitHub issue** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. `json { "type":"github", "config":{ "targetType":"specific", "targetIdentifier":", "targetDisplay":"" }, "integrationId":"2345", "data":{ "additional_fields": { "assignee": "", "integration": "2345", "labels": [], "repo": "example-repo", }, "dynamic_form_fields": [ { "choices": [["YourOrg/example-repo", "example-repo"]], "default": "YourOrg/example-repo", "label": "GitHub Repository", "name": "repo", "required": true "type": "select", "updatesForm": true, "url": "/extensions/github/search/example-repo/1234567/", }, ], }, "status":"active" } ` | |
| `config` | object | No | — | Typically the frequency at which the alert will fire, in minutes. - `0`: 0 minutes - `5`: 5 minutes - `10`: 10 minutes - `30`: 30 minutes - `60`: 1 hour - `180`: 3 hours - `720`: 12 hours - `1440`: 24 hours `json { "frequency":3600 } ` | |
| `detector_ids` | integer\[] | No | — | The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs. | |
| `enabled` | boolean | No | — | Whether the alert is enabled or disabled | |
| `environment` | string | null | No | — | The name of the environment for the alert to evaluate in |
| `id` | string | No | — | The ID of the existing alert | |
| `name` | string | Yes | — | The name of the alert | |
| `owner` | string | null | No | — | The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** `json "user:123456" ` **Team** `json "team:456789" ` |
| `triggers` | object | No | — | The conditions on which the alert will trigger. See available options below. `json "triggers": { "organizationId": "1", "logicType": "any-short", "conditions": [ { "type": "first_seen_event", "comparison": true, "conditionResult": true }, { "type": "issue_resolved_trigger", "comparison": true, "conditionResult": true }, { "type": "reappeared_event", "comparison": true, "conditionResult": true }, { "type": "regression_event", "comparison": true, "conditionResult": true } ], "actions": [] } ` | |
````json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id_or_slug": {
"type": "string",
"description": "The ID or slug of the organization the resource belongs to."
},
"workflow_id": {
"type": "integer",
"description": "The ID of the alert you'd like to query."
},
"action_filters": {
"type": "array",
"description": "The filters to run before the action will fire and the action(s) to fire. `logicType` can be one of `any-short`, `all`, or `none`. Below is a basic example. See below for all other options. ```json \"actionFilters\": [ { \"logicType\": \"any\", \"conditions\": [ { \"type\": \"level\", \"comparison\": { \"level\": 50, \"match\": \"eq\" }, \"conditionResult\": true } ], \"actions\": [ { \"id\": \"123\", \"type\": \"email\", \"integrationId\": null, \"data\": {}, \"config\": { \"targetType\": \"user\", \"targetDisplay\": null, \"targetIdentifier\": \"56789\" }, \"status\": \"active\" } ] } ] ``` ## Conditions **Issue Age** - `time`: One of `minute`, `hour`, `day`, or `week`. - `value`: A positive integer. - `comparisonType`: One of `older` or `newer`. ```json { \"type\": \"age_comparison\", \"comparison\": { \"time\": \"minute\", \"value\": 10, \"comparisonType\": \"older\" }, \"conditionResult\": true } ``` **Issue Assignment** - `targetType`: Who the issue is assigned to - `Unassigned`: Unassigned - `Member`: Assigned to a user - `Team`: Assigned to a team - `targetIdentifier`: The ID of the user or team from the `targetType`. Enter \"\" if `targetType` is `Unassigned`. ```json { \"type\": \"assigned_to\", \"comparison\": { \"targetType\": \"Member\", \"targetIdentifier\": 123456 }, \"conditionResult\": true } ``` **Issue Category** - `value`: The issue category to filter to. - `1`: Error issues - `6`: Feedback issues - `10`: Outage issues - `11`: Metric issues - `12`: DB Query issues - `13`: HTTP Client issues - `14`: Front end issues - `15`: Mobile issues ```json { \"type\": \"issue_category\", \"comparison\": { \"value\": 1 }, \"conditionResult\": true } ``` **Issue Frequency** - `value`: A positive integer representing how many times the issue has to happen before the alert will fire. ```json { \"type\": \"issue_occurrences\", \"comparison\": { \"value\": 10 }, \"conditionResult\": true } ``` **De-escalation** ```json { \"type\": \"issue_priority_deescalating\", \"comparison\": true, \"conditionResult\": true } ``` **Issue Priority** - `comparison`: The priority the issue must be for the alert to fire. - `75`: High priority - `50`: Medium priority - `25`: Low priority ```json { \"type\": \"issue_priority_greater_or_equal\", \"comparison\": 75, \"conditionResult\": true } ``` **Number of Users Affected** - `value`: A positive integer representing the number of users that must be affected before the alert will fire. - `filters`: A list of additional sub-filters to evaluate before the alert will fire. - `interval`: The time period in which to evaluate the value. e.g. Number of users affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days ```json { \"type\": \"event_unique_user_frequency_count\", \"comparison\": { \"value\": 100, \"filters\": [{\"key\": \"foo\", \"match\": \"eq\", \"value\": \"bar\"}], \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Number of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days ```json { \"type\": \"event_frequency_count\", \"comparison\": { \"value\": 100, \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Percent of Events** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Number of events in an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. ```json { \"type\": \"event_frequency_percent\", \"comparison\": { \"value\": 100, \"interval\": \"1h\", \"comparisonInterval\": \"1w\" }, \"conditionResult\": true } ``` **Percentage of Sessions Affected Count** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is more than `value` in `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days ```json { \"type\": \"percent_sessions_count\", \"comparison\": { \"value\": 10, \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Percentage of Sessions Affected Percent** - `value`: A positive integer representing the number of events in an issue that must come in before the alert will fire - `interval`: The time period in which to evaluate the value. e.g. Percentage of sessions affected by an issue is `comparisonInterval` percent higher `value` compared to `interval`. - `1min`: 1 minute - `5min`: 5 minutes - `15min`: 15 minutes - `1hr`: 1 hour - `1d`: 1 day - `1w`: 1 week - `30d`: 30 days - `comparisonInterval`: The time period to compare against. See `interval` for options. ```json { \"type\": \"percent_sessions_percent\", \"comparison\": { \"value\": 10, \"interval\": \"1h\" }, \"conditionResult\": true } ``` **Event Attribute** The event's `attribute` value `match` `value` - `attribute`: The event attribute to match on. Valid values are: `message`, `platform`, `environment`, `type`, `error.handled`, `error.unhandled`, `error.main_thread`, `exception.type`, `exception.value`, `user.id`, `user.email`, `user.username`, `user.ip_address`, `http.method`, `http.url`, `http.status_code`, `sdk.name`, `stacktrace.code`, `stacktrace.module`, `stacktrace.filename`, `stacktrace.abs_path`, `stacktrace.package`, `unreal.crash_type`, `app.in_foreground`. - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. ```json { \"type\": \"event_attribute\", \"comparison\": { \"match\": \"co\", \"value\": \"bar\", \"attribute\": \"message\" }, \"conditionResult\": true } ``` **Tagged Event** The event's tags `key` match `value` - `key`: The tag value - `match`: The comparison operator - `co`: Contains - `nc`: Does not contain - `eq`: Equals - `ne`: Does not equal - `sw`: Starts with - `ew`: Ends with - `is`: Is set - `ns`: Is not set - `value`: A string. Not required when match is `is` or `ns`. ```json { \"type\": \"tagged_event\", \"comparison\": { \"key\": \"level\", \"match\": \"eq\", \"value\": \"error\" }, \"conditionResult\": true } ``` **Latest Release** The event is from the latest release ```json { \"type\": \"latest_release\", \"comparison\": true, \"conditionResult\": true } ``` **Release Age** ```json { \"type\": \"latest_adopted_release\", \"comparison\": { \"environment\": \"12345\", \"ageComparison\": \"older\", \"releaseAgeType\": \"oldest\" }, \"conditionResult\": true } ``` **Event Level** The event's level is `match` `level` - `match`: The comparison operator - `eq`: Equal - `gte`: Greater than or equal - `lte`: Less than or equal - `level`: The event level - `50`: Fatal - `40`: Error - `30`: Warning - `20`: Info - `10`: Debug - `0`: Sample ```json { \"type\": \"level\", \"comparison\": { \"level\": 50, \"match\": \"eq\" }, \"conditionResult\": true } ``` ## Actions A list of actions that take place when all required conditions and filters for the alert are met. See below for a list of possible actions. **Notify on Preferred Channel** - `data`: A dictionary with the fallthrough type option when choosing to notify Suggested Assignees. Leave empty if notifying a user or team. - `fallthroughType` - `ActiveMembers` - `AllMembers` - `NoOne` - `config`: A dictionary with the configuration options for notification. - `targetType`: The type of recipient to notify - `user`: User - `team`: Team - `issue_owners`: Suggested Assignees - `targetDisplay`: null - `targetIdentifier`: The id of the user or team to notify. Leave null for Suggested Assignees. ```json { \"type\":\"email\", \"integrationId\":null, \"data\":{}, \"config\":{ \"targetType\":\"user\", \"targetDisplay\":null, \"targetIdentifier\":\"232692\" }, \"status\":\"active\" }, { \"type\":\"email\", \"integrationId\":null, \"data\":{ \"fallthroughType\":\"ActiveMembers\" }, \"config\":{ \"targetType\":\"issue_owners\", \"targetDisplay\":null, \"targetIdentifier\":\"\"} , \"status\":\"active\" } ``` **Notify on Slack** - `targetDisplay`: The name of the channel to notify in. `integrationId`: The stringified ID of the integration. ```json { \"type\":\"slack\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"\", \"targetDisplay\":\"notify-errors\" }, \"integrationId\":\"1\", \"data\":{}, \"status\":\"active\" } ``` **Notify on PagerDuty** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data[\"priority\"]`: The severity level for the notification. ```json { \"type\":\"pagerduty\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"123456\", \"targetDisplay\":\"Error Service\" }, \"integrationId\":\"2345\", \"data\":{ \"priority\":\"default\" }, \"status\":\"active\" } ``` **Notify on Discord** - `targetDisplay`: The name of the service to create the ticket in. - `integrationId`: The stringified ID of the integration. - `data[\"tags\"]`: Comma separated list of tags to add to the notification. ```json { \"type\":\"discord\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"12345\", \"targetDisplay\":\"\", }, \"integrationId\":\"1234\", \"data\":{ \"tags\":\"transaction,environment\" }, \"status\":\"active\" } ``` **Notify on MSTeams** - `targetIdentifier` - The integration ID associated with the Microsoft Teams team. - `targetDisplay` - The name of the channel to send the notification to. - `integrationId`: The stringified ID of the integration. ```json { \"type\":\"msteams\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"19:a4b3kghaghgkjah357y6847@thread.skype\", \"targetDisplay\":\"notify-errors\" }, \"integrationId\":\"1\", \"data\":{}, \"status\":\"active\" } ``` **Notify on OpsGenie** - `targetDisplay`: The name of the Opsgenie team. - `targetIdentifier`: The ID of the Opsgenie team to send the notification to. - `integrationId`: The stringified ID of the integration. - `data[\"priority\"]`: The priority level for the notification. ```json { \"type\":\"opsgenie\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\"123456-Error-Service\", \"targetDisplay\":\"Error Service\" }, \"integrationId\":\"2345\", \"data\":{ \"priority\":\"P3\" }, \"status\":\"active\" } ``` **Notify on Azure DevOps** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"vsts\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{...}, \"status\":\"active\" } ``` **Create a Jira ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"jira\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{...}, \"status\":\"active\" } ``` **Create a Jira Server ticket** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"jira_server\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{...}, \"status\":\"active\" } ``` **Create a GitHub issue** - `integrationId`: The stringified ID of the integration. - `data` - A list of any fields you want to include in the ticket as objects. ```json { \"type\":\"github\", \"config\":{ \"targetType\":\"specific\", \"targetIdentifier\":\", \"targetDisplay\":\"\" }, \"integrationId\":\"2345\", \"data\":{ \"additional_fields\": { \"assignee\": \"\", \"integration\": \"2345\", \"labels\": [], \"repo\": \"example-repo\", }, \"dynamic_form_fields\": [ { \"choices\": [[\"YourOrg/example-repo\", \"example-repo\"]], \"default\": \"YourOrg/example-repo\", \"label\": \"GitHub Repository\", \"name\": \"repo\", \"required\": true \"type\": \"select\", \"updatesForm\": true, \"url\": \"/extensions/github/search/example-repo/1234567/\", }, ], }, \"status\":\"active\" } ```"
},
"config": {
"type": "object",
"description": "Typically the frequency at which the alert will fire, in minutes. - `0`: 0 minutes - `5`: 5 minutes - `10`: 10 minutes - `30`: 30 minutes - `60`: 1 hour - `180`: 3 hours - `720`: 12 hours - `1440`: 24 hours ```json { \"frequency\":3600 } ```"
},
"detector_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the monitors to connect this alert to. Use 'Fetch an Organization's Monitors' to find the IDs."
},
"enabled": {
"type": "boolean",
"description": "Whether the alert is enabled or disabled"
},
"environment": {
"type": [
"string",
"null"
],
"description": "The name of the environment for the alert to evaluate in"
},
"id": {
"type": "string",
"description": "The ID of the existing alert"
},
"name": {
"type": "string",
"description": "The name of the alert"
},
"owner": {
"type": [
"string",
"null"
],
"description": "The ID user or team who owns the monitor or alert prefaced by the string 'user' or 'team'. **User** ```json \"user:123456\" ``` **Team** ```json \"team:456789\" ```"
},
"triggers": {
"description": "The conditions on which the alert will trigger. See available options below. ```json \"triggers\": { \"organizationId\": \"1\", \"logicType\": \"any-short\", \"conditions\": [ { \"type\": \"first_seen_event\", \"comparison\": true, \"conditionResult\": true }, { \"type\": \"issue_resolved_trigger\", \"comparison\": true, \"conditionResult\": true }, { \"type\": \"reappeared_event\", \"comparison\": true, \"conditionResult\": true }, { \"type\": \"regression_event\", \"comparison\": true, \"conditionResult\": true } ], \"actions\": [] } ```"
}
},
"required": [
"PCID",
"organization_id_or_slug",
"workflow_id",
"name"
]
}
````