Method: projects.datasets.evaluateSlice

Stay organized with collections Save and categorize content based on your preferences.

Evaluate an explicit slice from a loaded DataSet.

HTTP request

POST https://timeseriesinsights.googleapis.com/v1/{dataset=projects/*/datasets/*}:evaluateSlice

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataset

string

Required. Loaded DataSet to be queried in the format of "projects/{project}/datasets/{dataset}"

Request body

The request body contains data with the following structure:

JSON representation
{
  "pinnedDimensions": [
    {
      object (PinnedDimension)
    }
  ],
  "detectionTime": string,
  "timeseriesParams": {
    object (TimeseriesParams)
  },
  "forecastParams": {
    object (ForecastParams)
  }
}
Fields
pinnedDimensions[]

object (PinnedDimension)

Required. Dimensions with pinned values that specify the slice for which we will fetch the time series.

detectionTime

string (Timestamp format)

Required. This is the point in time that we want to probe for anomalies.

See documentation for QueryDataSetRequest.detectionTime.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

timeseriesParams

object (TimeseriesParams)

Parameters controlling how we will build the time series used to predict the detectionTime value for this slice.

forecastParams

object (ForecastParams)

Parameters that control the time series forecasting models, such as the sensitivity of the anomaly detection.

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.