datadog-dashboards

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "author_handle": {
      "type": "string",
      "description": "Identifier of the dashboard author."
    },
    "author_name": {
      "type": "string",
      "description": "Name of the dashboard author."
    },
    "created_at": {
      "type": "string",
      "description": "Creation date of the dashboard."
    },
    "description": {
      "type": "string",
      "description": "Description of the dashboard."
    },
    "id": {
      "type": "string",
      "description": "ID of the dashboard."
    },
    "is_read_only": {
      "type": "boolean",
      "description": "Whether this dashboard is read-only. If True, only the author and admins can make changes to it.  This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards."
    },
    "layout_type": {
      "type": "string",
      "description": "Layout type of the dashboard.",
      "enum": [
        "ordered",
        "free"
      ]
    },
    "modified_at": {
      "type": "string",
      "description": "Modification date of the dashboard."
    },
    "notify_list": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of handles of users to notify when changes are made to this dashboard."
    },
    "reflow_type": {
      "type": "string",
      "description": "Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.",
      "enum": [
        "auto",
        "fixed"
      ]
    },
    "restricted_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard."
    },
    "tabs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID of the tab."
          },
          "name": {
            "type": "string",
            "description": "Name of the tab."
          },
          "widget_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "List of widget IDs belonging to this tab. The backend also accepts positional references in @N format (1-indexed) as a convenience for Terraform and other declarative tools."
          }
        },
        "required": [
          "id",
          "name",
          "widget_ids"
        ]
      },
      "description": "List of tabs for organizing dashboard widgets into groups."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of team names representing ownership of a dashboard."
    },
    "template_variable_presets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "template_variables": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the variable."
                },
                "value": {
                  "type": "string",
                  "description": "(deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`."
                },
                "values": {
                  "type": "array",
                  "description": "One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`."
                }
              }
            },
            "description": "List of variables."
          }
        }
      },
      "description": "Array of template variables saved views."
    },
    "template_variables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "available_values": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The list of values that the template variable drop-down is limited to."
          },
          "default": {
            "type": "string",
            "description": "(deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`."
          },
          "defaults": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`."
          },
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "prefix": {
            "type": "string",
            "description": "The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down."
          },
          "type": {
            "type": "string",
            "description": "The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by)."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "List of template variables for this dashboard."
    },
    "title": {
      "type": "string",
      "description": "Title of the dashboard."
    },
    "url": {
      "type": "string",
      "description": "The URL of the dashboard."
    },
    "widgets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "definition": {
            "description": "[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/)."
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "ID of the widget."
          },
          "layout": {
            "type": "object",
            "description": "The layout for a widget on a `free` or **new dashboard layout** dashboard."
          }
        },
        "required": [
          "definition"
        ]
      },
      "description": "List of widgets to display on the dashboard."
    }
  },
  "required": [
    "PCID",
    "layout_type",
    "title",
    "widgets"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "data": {
      "type": "object",
      "description": "The data for a notebook create request.",
      "properties": {
        "attributes": {
          "type": "object",
          "description": "The data attributes of a notebook."
        },
        "type": {
          "type": "string",
          "description": "Type of the Notebook resource.",
          "enum": [
            "notebooks"
          ]
        }
      },
      "required": [
        "type",
        "attributes"
      ]
    }
  },
  "required": [
    "PCID",
    "data"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "config": {
      "type": "object",
      "description": "Configuration object for a Synthetic API test.",
      "properties": {
        "assertions": {
          "type": "array",
          "description": "Array of assertions used for the test. Required for single API tests."
        },
        "configVariables": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of variables used for the test."
        },
        "request": {
          "type": "object",
          "description": "Object describing the Synthetic test request."
        },
        "steps": {
          "type": "array",
          "description": "When the test subtype is `multi`, the steps of the test."
        },
        "variablesFromScript": {
          "type": "string",
          "description": "Variables defined from JavaScript code."
        }
      }
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of locations used to run the test."
    },
    "message": {
      "type": "string",
      "description": "Notification message associated with the test."
    },
    "monitor_id": {
      "type": "integer",
      "description": "The associated monitor ID."
    },
    "name": {
      "type": "string",
      "description": "Name of the test."
    },
    "options": {
      "type": "object",
      "description": "Object describing the extra options for a Synthetic test.",
      "properties": {
        "accept_self_signed": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should allow self signed certificates."
        },
        "allow_insecure": {
          "type": "boolean",
          "description": "Allows loading insecure content for an HTTP request in an API test."
        },
        "blockedRequestPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of URL patterns to block."
        },
        "checkCertificateRevocation": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP."
        },
        "ci": {
          "type": "object",
          "description": "CI/CD options for a Synthetic test."
        },
        "device_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "For browser test, array with the different device IDs used to run the test."
        },
        "disableAiaIntermediateFetching": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA."
        },
        "disableCors": {
          "type": "boolean",
          "description": "Whether or not to disable CORS mechanism."
        },
        "disableCsp": {
          "type": "boolean",
          "description": "Disable Content Security Policy for browser tests."
        },
        "enableProfiling": {
          "type": "boolean",
          "description": "Enable profiling for browser tests."
        },
        "enableSecurityTesting": {
          "type": "boolean",
          "description": "Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used."
        },
        "follow_redirects": {
          "type": "boolean",
          "description": "For API HTTP test, whether or not the test should follow redirects."
        },
        "httpVersion": {
          "type": "string",
          "description": "HTTP version to use for a Synthetic test.",
          "enum": [
            "http1",
            "http2",
            "any"
          ]
        },
        "ignoreServerCertificateError": {
          "type": "boolean",
          "description": "Ignore server certificate error for browser tests."
        },
        "initialNavigationTimeout": {
          "type": "integer",
          "description": "Timeout before declaring the initial step as failed (in seconds) for browser tests."
        },
        "min_failure_duration": {
          "type": "integer",
          "description": "Minimum amount of time in failure required to trigger an alert."
        },
        "min_location_failed": {
          "type": "integer",
          "description": "Minimum number of locations in failure required to trigger an alert."
        },
        "monitor_name": {
          "type": "string",
          "description": "The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs."
        },
        "monitor_options": {
          "type": "object",
          "description": "Object containing the options for a Synthetic test as a monitor (for example, renotification)."
        },
        "monitor_priority": {
          "type": "integer",
          "description": "Integer from 1 (high) to 5 (low) indicating alert severity."
        },
        "noScreenshot": {
          "type": "boolean",
          "description": "Prevents saving screenshots of the steps."
        },
        "restricted_roles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions."
        },
        "retry": {
          "type": "object",
          "description": "Object describing the retry strategy to apply to a Synthetic test."
        },
        "rumSettings": {
          "type": "object",
          "description": "The RUM data collection settings for the Synthetic browser test. **Note:** There are 3 ways to format RUM settings:  `{ isEnabled: false }` RUM data is not collected.  `{ isEnabled: true }` RUM data is collected from the Synthetic test's default application.  `{ isEnabled: true, applicationId: \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\", clientTokenId: 12345 }` RUM data is collected using the specified application."
        },
        "scheduling": {
          "type": "object",
          "description": "Object containing timeframes and timezone used for advanced scheduling."
        },
        "tick_every": {
          "type": "integer",
          "description": "The frequency at which to run the Synthetic test (in seconds)."
        }
      }
    },
    "public_id": {
      "type": "string",
      "description": "The public ID for the test."
    },
    "status": {
      "type": "string",
      "description": "Define whether you want to start (`live`) or pause (`paused`) a Synthetic test.",
      "enum": [
        "live",
        "paused"
      ]
    },
    "subtype": {
      "type": "string",
      "description": "The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.",
      "enum": [
        "http",
        "ssl",
        "tcp",
        "dns",
        "multi",
        "icmp",
        "udp",
        "websocket",
        "grpc"
      ]
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of tags attached to the test."
    },
    "type": {
      "type": "string",
      "description": "Type of the Synthetic test, `api`.",
      "enum": [
        "api"
      ]
    }
  },
  "required": [
    "PCID",
    "config",
    "locations",
    "message",
    "name",
    "options",
    "type"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "config": {
      "type": "object",
      "description": "Configuration object for a Synthetic browser test.",
      "properties": {
        "assertions": {
          "type": "array",
          "description": "Array of assertions used for the test."
        },
        "configVariables": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of variables used for the test."
        },
        "request": {
          "type": "object",
          "description": "Object describing the Synthetic test request."
        },
        "setCookie": {
          "type": "string",
          "description": "Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax."
        },
        "variables": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of variables used for the test steps."
        }
      },
      "required": [
        "request",
        "assertions"
      ]
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of locations used to run the test."
    },
    "message": {
      "type": "string",
      "description": "Notification message associated with the test. Message can either be text or an empty string."
    },
    "monitor_id": {
      "type": "integer",
      "description": "The associated monitor ID."
    },
    "name": {
      "type": "string",
      "description": "Name of the test."
    },
    "options": {
      "type": "object",
      "description": "Object describing the extra options for a Synthetic test.",
      "properties": {
        "accept_self_signed": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should allow self signed certificates."
        },
        "allow_insecure": {
          "type": "boolean",
          "description": "Allows loading insecure content for an HTTP request in an API test."
        },
        "blockedRequestPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of URL patterns to block."
        },
        "checkCertificateRevocation": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP."
        },
        "ci": {
          "type": "object",
          "description": "CI/CD options for a Synthetic test."
        },
        "device_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "For browser test, array with the different device IDs used to run the test."
        },
        "disableAiaIntermediateFetching": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA."
        },
        "disableCors": {
          "type": "boolean",
          "description": "Whether or not to disable CORS mechanism."
        },
        "disableCsp": {
          "type": "boolean",
          "description": "Disable Content Security Policy for browser tests."
        },
        "enableProfiling": {
          "type": "boolean",
          "description": "Enable profiling for browser tests."
        },
        "enableSecurityTesting": {
          "type": "boolean",
          "description": "Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used."
        },
        "follow_redirects": {
          "type": "boolean",
          "description": "For API HTTP test, whether or not the test should follow redirects."
        },
        "httpVersion": {
          "type": "string",
          "description": "HTTP version to use for a Synthetic test.",
          "enum": [
            "http1",
            "http2",
            "any"
          ]
        },
        "ignoreServerCertificateError": {
          "type": "boolean",
          "description": "Ignore server certificate error for browser tests."
        },
        "initialNavigationTimeout": {
          "type": "integer",
          "description": "Timeout before declaring the initial step as failed (in seconds) for browser tests."
        },
        "min_failure_duration": {
          "type": "integer",
          "description": "Minimum amount of time in failure required to trigger an alert."
        },
        "min_location_failed": {
          "type": "integer",
          "description": "Minimum number of locations in failure required to trigger an alert."
        },
        "monitor_name": {
          "type": "string",
          "description": "The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs."
        },
        "monitor_options": {
          "type": "object",
          "description": "Object containing the options for a Synthetic test as a monitor (for example, renotification)."
        },
        "monitor_priority": {
          "type": "integer",
          "description": "Integer from 1 (high) to 5 (low) indicating alert severity."
        },
        "noScreenshot": {
          "type": "boolean",
          "description": "Prevents saving screenshots of the steps."
        },
        "restricted_roles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions."
        },
        "retry": {
          "type": "object",
          "description": "Object describing the retry strategy to apply to a Synthetic test."
        },
        "rumSettings": {
          "type": "object",
          "description": "The RUM data collection settings for the Synthetic browser test. **Note:** There are 3 ways to format RUM settings:  `{ isEnabled: false }` RUM data is not collected.  `{ isEnabled: true }` RUM data is collected from the Synthetic test's default application.  `{ isEnabled: true, applicationId: \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\", clientTokenId: 12345 }` RUM data is collected using the specified application."
        },
        "scheduling": {
          "type": "object",
          "description": "Object containing timeframes and timezone used for advanced scheduling."
        },
        "tick_every": {
          "type": "integer",
          "description": "The frequency at which to run the Synthetic test (in seconds)."
        }
      }
    },
    "public_id": {
      "type": "string",
      "description": "The public ID of the test."
    },
    "status": {
      "type": "string",
      "description": "Define whether you want to start (`live`) or pause (`paused`) a Synthetic test.",
      "enum": [
        "live",
        "paused"
      ]
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowFailure": {
            "type": "boolean",
            "description": "A boolean set to allow this step to fail."
          },
          "alwaysExecute": {
            "type": "boolean",
            "description": "A boolean set to always execute this step even if the previous step failed or was skipped."
          },
          "exitIfSucceed": {
            "type": "boolean",
            "description": "A boolean set to exit the test if the step succeeds."
          },
          "isCritical": {
            "type": "boolean",
            "description": "A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails."
          },
          "name": {
            "type": "string",
            "description": "The name of the step."
          },
          "noScreenshot": {
            "type": "boolean",
            "description": "A boolean set to skip taking a screenshot for the step."
          },
          "params": {
            "type": "object",
            "description": "The parameters of the step."
          },
          "public_id": {
            "type": "string",
            "description": "The public ID of the step."
          },
          "timeout": {
            "type": "integer",
            "format": "int64",
            "description": "The time before declaring a step failed."
          },
          "type": {
            "type": "string",
            "enum": [
              "assertCurrentUrl",
              "assertElementAttribute",
              "assertElementContent",
              "assertElementPresent",
              "assertEmail",
              "assertFileDownload",
              "assertFromJavascript",
              "assertPageContains",
              "assertPageLacks",
              "assertRequests",
              "click",
              "drag",
              "drop",
              "extractFromJavascript",
              "extractFromEmailBody",
              "extractVariable",
              "goToEmailLink",
              "goToUrl",
              "goToUrlAndMeasureTti",
              "hover",
              "playSubTest",
              "pressKey",
              "refresh",
              "runApiTest",
              "scroll",
              "selectOption",
              "typeText",
              "uploadFiles",
              "wait"
            ],
            "description": "Step type used in your Synthetic test."
          }
        }
      },
      "description": "Array of steps for the test."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of tags attached to the test."
    },
    "type": {
      "type": "string",
      "description": "Type of the Synthetic test, `browser`.",
      "enum": [
        "browser"
      ]
    }
  },
  "required": [
    "PCID",
    "config",
    "locations",
    "message",
    "name",
    "options",
    "type"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dashboard_id": {
      "type": "string",
      "description": "The ID of the dashboard."
    }
  },
  "required": [
    "PCID",
    "dashboard_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "notebook_id": {
      "type": "integer",
      "description": "Unique ID, assigned when you create the notebook."
    }
  },
  "required": [
    "PCID",
    "notebook_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "force_delete_dependencies": {
      "type": "boolean",
      "description": "Delete the Synthetic test even if it's referenced by other resources (for example, SLOs and composite monitors)."
    },
    "public_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of Synthetic test IDs you want to delete."
    }
  },
  "required": [
    "PCID",
    "public_ids"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "public_id": {
      "type": "string",
      "description": "The public ID of the test for which to search results for."
    },
    "from_ts": {
      "type": "integer",
      "description": "Timestamp in milliseconds from which to start querying results."
    },
    "to_ts": {
      "type": "integer",
      "description": "Timestamp in milliseconds up to which to query results."
    },
    "probe_dc": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locations for which to query results."
    }
  },
  "required": [
    "PCID",
    "public_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "public_id": {
      "type": "string",
      "description": "The public ID of the browser test for which to search results for."
    },
    "from_ts": {
      "type": "integer",
      "description": "Timestamp in milliseconds from which to start querying results."
    },
    "to_ts": {
      "type": "integer",
      "description": "Timestamp in milliseconds up to which to query results."
    },
    "probe_dc": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Locations for which to query results."
    }
  },
  "required": [
    "PCID",
    "public_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dashboard_id": {
      "type": "string",
      "description": "The ID of the dashboard."
    }
  },
  "required": [
    "PCID",
    "dashboard_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "notebook_id": {
      "type": "integer",
      "description": "Unique ID, assigned when you create the notebook."
    }
  },
  "required": [
    "PCID",
    "notebook_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "public_id": {
      "type": "string",
      "description": "The public ID of the test to get details from."
    }
  },
  "required": [
    "PCID",
    "public_id"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter[shared]": {
      "type": "boolean",
      "description": "When `true`, this query only returns shared custom created or cloned dashboards."
    },
    "filter[deleted]": {
      "type": "boolean",
      "description": "When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`."
    },
    "count": {
      "type": "integer",
      "description": "The maximum number of dashboards returned in the list."
    },
    "start": {
      "type": "integer",
      "description": "The specific offset to use as the beginning of the returned response."
    }
  },
  "required": [
    "PCID"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "author_handle": {
      "type": "string",
      "description": "Return notebooks created by the given `author_handle`."
    },
    "exclude_author_handle": {
      "type": "string",
      "description": "Return notebooks not created by the given `author_handle`."
    },
    "start": {
      "type": "integer",
      "description": "The index of the first notebook you want returned."
    },
    "count": {
      "type": "integer",
      "description": "The number of notebooks to be returned."
    },
    "sort_field": {
      "type": "string",
      "description": "Sort by field `modified`, `name`, or `created`."
    },
    "sort_dir": {
      "type": "string",
      "description": "Sort by direction `asc` or `desc`."
    },
    "query": {
      "type": "string",
      "description": "Return only notebooks with `query` string in notebook name or author handle."
    },
    "include_cells": {
      "type": "boolean",
      "description": "Value of `false` excludes the `cells` and global `time` for each notebook."
    },
    "is_template": {
      "type": "boolean",
      "description": "True value returns only template notebooks. Default is false (returns only non-template notebooks)."
    },
    "type": {
      "type": "string",
      "description": "If type is provided, returns only notebooks with that metadata type. Default does not have type filtering."
    }
  },
  "required": [
    "PCID"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page_size": {
      "type": "integer",
      "description": "Used for pagination. The number of tests returned in the page."
    },
    "page_number": {
      "type": "integer",
      "description": "Used for pagination. Which page you want to retrieve. Starts at zero."
    }
  },
  "required": [
    "PCID"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tests": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "description": "Metadata for the Synthetic tests run."
          },
          "public_id": {
            "type": "string",
            "description": "The public ID of the Synthetic test to trigger."
          }
        },
        "required": [
          "public_id"
        ]
      },
      "description": "List of Synthetic tests."
    }
  },
  "required": [
    "PCID",
    "tests"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "public_id": {
      "type": "string",
      "description": "The public ID of the test to get details from."
    },
    "config": {
      "type": "object",
      "description": "Configuration object for a Synthetic API test.",
      "properties": {
        "assertions": {
          "type": "array",
          "description": "Array of assertions used for the test. Required for single API tests."
        },
        "configVariables": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of variables used for the test."
        },
        "request": {
          "type": "object",
          "description": "Object describing the Synthetic test request."
        },
        "steps": {
          "type": "array",
          "description": "When the test subtype is `multi`, the steps of the test."
        },
        "variablesFromScript": {
          "type": "string",
          "description": "Variables defined from JavaScript code."
        }
      }
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of locations used to run the test."
    },
    "message": {
      "type": "string",
      "description": "Notification message associated with the test."
    },
    "monitor_id": {
      "type": "integer",
      "description": "The associated monitor ID."
    },
    "name": {
      "type": "string",
      "description": "Name of the test."
    },
    "options": {
      "type": "object",
      "description": "Object describing the extra options for a Synthetic test.",
      "properties": {
        "accept_self_signed": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should allow self signed certificates."
        },
        "allow_insecure": {
          "type": "boolean",
          "description": "Allows loading insecure content for an HTTP request in an API test."
        },
        "blockedRequestPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of URL patterns to block."
        },
        "checkCertificateRevocation": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP."
        },
        "ci": {
          "type": "object",
          "description": "CI/CD options for a Synthetic test."
        },
        "device_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "For browser test, array with the different device IDs used to run the test."
        },
        "disableAiaIntermediateFetching": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA."
        },
        "disableCors": {
          "type": "boolean",
          "description": "Whether or not to disable CORS mechanism."
        },
        "disableCsp": {
          "type": "boolean",
          "description": "Disable Content Security Policy for browser tests."
        },
        "enableProfiling": {
          "type": "boolean",
          "description": "Enable profiling for browser tests."
        },
        "enableSecurityTesting": {
          "type": "boolean",
          "description": "Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used."
        },
        "follow_redirects": {
          "type": "boolean",
          "description": "For API HTTP test, whether or not the test should follow redirects."
        },
        "httpVersion": {
          "type": "string",
          "description": "HTTP version to use for a Synthetic test.",
          "enum": [
            "http1",
            "http2",
            "any"
          ]
        },
        "ignoreServerCertificateError": {
          "type": "boolean",
          "description": "Ignore server certificate error for browser tests."
        },
        "initialNavigationTimeout": {
          "type": "integer",
          "description": "Timeout before declaring the initial step as failed (in seconds) for browser tests."
        },
        "min_failure_duration": {
          "type": "integer",
          "description": "Minimum amount of time in failure required to trigger an alert."
        },
        "min_location_failed": {
          "type": "integer",
          "description": "Minimum number of locations in failure required to trigger an alert."
        },
        "monitor_name": {
          "type": "string",
          "description": "The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs."
        },
        "monitor_options": {
          "type": "object",
          "description": "Object containing the options for a Synthetic test as a monitor (for example, renotification)."
        },
        "monitor_priority": {
          "type": "integer",
          "description": "Integer from 1 (high) to 5 (low) indicating alert severity."
        },
        "noScreenshot": {
          "type": "boolean",
          "description": "Prevents saving screenshots of the steps."
        },
        "restricted_roles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions."
        },
        "retry": {
          "type": "object",
          "description": "Object describing the retry strategy to apply to a Synthetic test."
        },
        "rumSettings": {
          "type": "object",
          "description": "The RUM data collection settings for the Synthetic browser test. **Note:** There are 3 ways to format RUM settings:  `{ isEnabled: false }` RUM data is not collected.  `{ isEnabled: true }` RUM data is collected from the Synthetic test's default application.  `{ isEnabled: true, applicationId: \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\", clientTokenId: 12345 }` RUM data is collected using the specified application."
        },
        "scheduling": {
          "type": "object",
          "description": "Object containing timeframes and timezone used for advanced scheduling."
        },
        "tick_every": {
          "type": "integer",
          "description": "The frequency at which to run the Synthetic test (in seconds)."
        }
      }
    },
    "status": {
      "type": "string",
      "description": "Define whether you want to start (`live`) or pause (`paused`) a Synthetic test.",
      "enum": [
        "live",
        "paused"
      ]
    },
    "subtype": {
      "type": "string",
      "description": "The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.",
      "enum": [
        "http",
        "ssl",
        "tcp",
        "dns",
        "multi",
        "icmp",
        "udp",
        "websocket",
        "grpc"
      ]
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of tags attached to the test."
    },
    "type": {
      "type": "string",
      "description": "Type of the Synthetic test, `api`.",
      "enum": [
        "api"
      ]
    }
  },
  "required": [
    "PCID",
    "public_id",
    "config",
    "locations",
    "message",
    "name",
    "options",
    "type"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "public_id": {
      "type": "string",
      "description": "The public ID of the test to edit."
    },
    "config": {
      "type": "object",
      "description": "Configuration object for a Synthetic browser test.",
      "properties": {
        "assertions": {
          "type": "array",
          "description": "Array of assertions used for the test."
        },
        "configVariables": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of variables used for the test."
        },
        "request": {
          "type": "object",
          "description": "Object describing the Synthetic test request."
        },
        "setCookie": {
          "type": "string",
          "description": "Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax."
        },
        "variables": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Array of variables used for the test steps."
        }
      },
      "required": [
        "request",
        "assertions"
      ]
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of locations used to run the test."
    },
    "message": {
      "type": "string",
      "description": "Notification message associated with the test. Message can either be text or an empty string."
    },
    "monitor_id": {
      "type": "integer",
      "description": "The associated monitor ID."
    },
    "name": {
      "type": "string",
      "description": "Name of the test."
    },
    "options": {
      "type": "object",
      "description": "Object describing the extra options for a Synthetic test.",
      "properties": {
        "accept_self_signed": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should allow self signed certificates."
        },
        "allow_insecure": {
          "type": "boolean",
          "description": "Allows loading insecure content for an HTTP request in an API test."
        },
        "blockedRequestPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of URL patterns to block."
        },
        "checkCertificateRevocation": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP."
        },
        "ci": {
          "type": "object",
          "description": "CI/CD options for a Synthetic test."
        },
        "device_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "For browser test, array with the different device IDs used to run the test."
        },
        "disableAiaIntermediateFetching": {
          "type": "boolean",
          "description": "For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA."
        },
        "disableCors": {
          "type": "boolean",
          "description": "Whether or not to disable CORS mechanism."
        },
        "disableCsp": {
          "type": "boolean",
          "description": "Disable Content Security Policy for browser tests."
        },
        "enableProfiling": {
          "type": "boolean",
          "description": "Enable profiling for browser tests."
        },
        "enableSecurityTesting": {
          "type": "boolean",
          "description": "Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used."
        },
        "follow_redirects": {
          "type": "boolean",
          "description": "For API HTTP test, whether or not the test should follow redirects."
        },
        "httpVersion": {
          "type": "string",
          "description": "HTTP version to use for a Synthetic test.",
          "enum": [
            "http1",
            "http2",
            "any"
          ]
        },
        "ignoreServerCertificateError": {
          "type": "boolean",
          "description": "Ignore server certificate error for browser tests."
        },
        "initialNavigationTimeout": {
          "type": "integer",
          "description": "Timeout before declaring the initial step as failed (in seconds) for browser tests."
        },
        "min_failure_duration": {
          "type": "integer",
          "description": "Minimum amount of time in failure required to trigger an alert."
        },
        "min_location_failed": {
          "type": "integer",
          "description": "Minimum number of locations in failure required to trigger an alert."
        },
        "monitor_name": {
          "type": "string",
          "description": "The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs."
        },
        "monitor_options": {
          "type": "object",
          "description": "Object containing the options for a Synthetic test as a monitor (for example, renotification)."
        },
        "monitor_priority": {
          "type": "integer",
          "description": "Integer from 1 (high) to 5 (low) indicating alert severity."
        },
        "noScreenshot": {
          "type": "boolean",
          "description": "Prevents saving screenshots of the steps."
        },
        "restricted_roles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions."
        },
        "retry": {
          "type": "object",
          "description": "Object describing the retry strategy to apply to a Synthetic test."
        },
        "rumSettings": {
          "type": "object",
          "description": "The RUM data collection settings for the Synthetic browser test. **Note:** There are 3 ways to format RUM settings:  `{ isEnabled: false }` RUM data is not collected.  `{ isEnabled: true }` RUM data is collected from the Synthetic test's default application.  `{ isEnabled: true, applicationId: \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\", clientTokenId: 12345 }` RUM data is collected using the specified application."
        },
        "scheduling": {
          "type": "object",
          "description": "Object containing timeframes and timezone used for advanced scheduling."
        },
        "tick_every": {
          "type": "integer",
          "description": "The frequency at which to run the Synthetic test (in seconds)."
        }
      }
    },
    "status": {
      "type": "string",
      "description": "Define whether you want to start (`live`) or pause (`paused`) a Synthetic test.",
      "enum": [
        "live",
        "paused"
      ]
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowFailure": {
            "type": "boolean",
            "description": "A boolean set to allow this step to fail."
          },
          "alwaysExecute": {
            "type": "boolean",
            "description": "A boolean set to always execute this step even if the previous step failed or was skipped."
          },
          "exitIfSucceed": {
            "type": "boolean",
            "description": "A boolean set to exit the test if the step succeeds."
          },
          "isCritical": {
            "type": "boolean",
            "description": "A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails."
          },
          "name": {
            "type": "string",
            "description": "The name of the step."
          },
          "noScreenshot": {
            "type": "boolean",
            "description": "A boolean set to skip taking a screenshot for the step."
          },
          "params": {
            "type": "object",
            "description": "The parameters of the step."
          },
          "public_id": {
            "type": "string",
            "description": "The public ID of the step."
          },
          "timeout": {
            "type": "integer",
            "format": "int64",
            "description": "The time before declaring a step failed."
          },
          "type": {
            "type": "string",
            "enum": [
              "assertCurrentUrl",
              "assertElementAttribute",
              "assertElementContent",
              "assertElementPresent",
              "assertEmail",
              "assertFileDownload",
              "assertFromJavascript",
              "assertPageContains",
              "assertPageLacks",
              "assertRequests",
              "click",
              "drag",
              "drop",
              "extractFromJavascript",
              "extractFromEmailBody",
              "extractVariable",
              "goToEmailLink",
              "goToUrl",
              "goToUrlAndMeasureTti",
              "hover",
              "playSubTest",
              "pressKey",
              "refresh",
              "runApiTest",
              "scroll",
              "selectOption",
              "typeText",
              "uploadFiles",
              "wait"
            ],
            "description": "Step type used in your Synthetic test."
          }
        }
      },
      "description": "Array of steps for the test."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of tags attached to the test."
    },
    "type": {
      "type": "string",
      "description": "Type of the Synthetic test, `browser`.",
      "enum": [
        "browser"
      ]
    }
  },
  "required": [
    "PCID",
    "public_id",
    "config",
    "locations",
    "message",
    "name",
    "options",
    "type"
  ]
}

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dashboard_id": {
      "type": "string",
      "description": "The ID of the dashboard."
    },
    "author_handle": {
      "type": "string",
      "description": "Identifier of the dashboard author."
    },
    "author_name": {
      "type": "string",
      "description": "Name of the dashboard author."
    },
    "created_at": {
      "type": "string",
      "description": "Creation date of the dashboard."
    },
    "description": {
      "type": "string",
      "description": "Description of the dashboard."
    },
    "id": {
      "type": "string",
      "description": "ID of the dashboard."
    },
    "is_read_only": {
      "type": "boolean",
      "description": "Whether this dashboard is read-only. If True, only the author and admins can make changes to it.  This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards."
    },
    "layout_type": {
      "type": "string",
      "description": "Layout type of the dashboard.",
      "enum": [
        "ordered",
        "free"
      ]
    },
    "modified_at": {
      "type": "string",
      "description": "Modification date of the dashboard."
    },
    "notify_list": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of handles of users to notify when changes are made to this dashboard."
    },
    "reflow_type": {
      "type": "string",
      "description": "Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.",
      "enum": [
        "auto",
        "fixed"
      ]
    },
    "restricted_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard."
    },
    "tabs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "UUID of the tab."
          },
          "name": {
            "type": "string",
            "description": "Name of the tab."
          },
          "widget_ids": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "List of widget IDs belonging to this tab. The backend also accepts positional references in @N format (1-indexed) as a convenience for Terraform and other declarative tools."
          }
        },
        "required": [
          "id",
          "name",
          "widget_ids"
        ]
      },
      "description": "List of tabs for organizing dashboard widgets into groups."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of team names representing ownership of a dashboard."
    },
    "template_variable_presets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "template_variables": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the variable."
                },
                "value": {
                  "type": "string",
                  "description": "(deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`."
                },
                "values": {
                  "type": "array",
                  "description": "One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`."
                }
              }
            },
            "description": "List of variables."
          }
        }
      },
      "description": "Array of template variables saved views."
    },
    "template_variables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "available_values": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The list of values that the template variable drop-down is limited to."
          },
          "default": {
            "type": "string",
            "description": "(deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`."
          },
          "defaults": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`."
          },
          "name": {
            "type": "string",
            "description": "The name of the variable."
          },
          "prefix": {
            "type": "string",
            "description": "The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down."
          },
          "type": {
            "type": "string",
            "description": "The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by)."
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "List of template variables for this dashboard."
    },
    "title": {
      "type": "string",
      "description": "Title of the dashboard."
    },
    "url": {
      "type": "string",
      "description": "The URL of the dashboard."
    },
    "widgets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "definition": {
            "description": "[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/)."
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "ID of the widget."
          },
          "layout": {
            "type": "object",
            "description": "The layout for a widget on a `free` or **new dashboard layout** dashboard."
          }
        },
        "required": [
          "definition"
        ]
      },
      "description": "List of widgets to display on the dashboard."
    }
  },
  "required": [
    "PCID",
    "dashboard_id",
    "layout_type",
    "title",
    "widgets"
  ]
}