Get an Analysis
Get an existing Analysis.
Request
HTTP Request
Path Parameters
Parameter | Description |
---|---|
| An existing Beam Analysis ID. |
Response
Response Fields
Field | Description |
---|---|
| Name of the Analysis.
E.g. |
| The creation date time for the Analysis in ISO 8601 format format.
E.g. |
| The last update date time for the Analysis in ISO 8601 format format.
E.g. |
| The date time the Analysis was last processed in ISO 8601 format format.
E.g. |
| The ID of the user who created the Analysis. This is present for Analyses created in Control Center. For Analyses created via the API this field will not be populated.
E.g. |
| Indicates whether or not your subscription has access to the provided location. We allow creating Analyses for any location, even locations outside of your subscription. However, for locations outside of your subscription the Possible values:
E.g. |
| Location of the Analysis. E.g. |
| Specifies which rank type was set to use when calculating event impacts and anomaly detection. E.g. |
| The time zone of the Analysis in TZ Database format. E.g. Note: this field is being used in the Control Center Beam UI for the purpose of fetching a list of relevant events in the correct time zone. It no longer has bearing on the outcome of a Beam analysis. |
| Beam performs a number of validation checks on the data provided. The results of some of those checks are stored in this field. We don't recommend relying on the values in this field as the structure may change without warning. Instead, refer to the |
| The value of this field determines whether or not the Analysis is ready for correlation. When you upload data for an Analysis the
E.g. |
| Status of the Analysis. Possible values:
E.g. |
| Status of the analysis processing stages. Only present in newly created or refreshed analyses. E.g. |
Examples
Guides
Below are some guides relevant to this API:
Last updated