- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Examples
Evaluate an explicit slice from a loaded DataSet
.
HTTP request
POST https://timeseriesinsights.googleapis.com/v1/{dataset=projects/*/locations/*/datasets/*}:evaluateSlice
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
dataset |
Required. Loaded DataSet to be queried in the format of "projects/{project}/locations/{location}/datasets/{dataset}" |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "pinnedDimensions": [ { object ( |
Fields | |
---|---|
pinnedDimensions[] |
Required. Dimensions with pinned values that specify the slice for which we will fetch the time series. |
detectionTime |
Required. This is the point in time that we want to probe for anomalies. See documentation for A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
timeseriesParams |
Parameters controlling how we will build the time series used to predict the |
forecastParams |
Parameters that control the time series forecasting models, such as the sensitivity of the anomaly detection. |
omitTimeseries |
If true, the history timeseries will be omitted from the response. |
Response body
If successful, the response body contains an instance of EvaluatedSlice
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the dataset
resource:
timeseriesinsights.datasets.evaluate
For more information, see the IAM documentation.