Get an Analysis
Get an existing Analysis.
Last updated
Get an existing Analysis.
Last updated
© 2024 PredictHQ Ltd
| An existing Beam Analysis ID. |
| Name of the Analysis.
E.g. |
|
E.g. |
|
E.g. |
|
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 present.
E.g. |
| External ID. Used to identify this Beam Analysis using an ID from another system. |
| Labels to categorize the Analysis. |
| 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. |
| Indicates the detected type of the uploaded demand data as well as other user-defined information about the demand data. Fields:
|
| E.g. Note: this field is populated automatically based on the location of the 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 has successfully completed processing. When you upload data for an Analysis the
E.g. |
| Status of the Analysis processing stages. All stages will be present here and are reset to E.g. |
| Status of the Analysis. Possible values:
E.g. |
The creation date time for the Analysis in format.
The last update date time for the Analysis in format.
The date time the Analysis was last processed in format.
The time zone of the Analysis in format.