Skip to main content
POST
Execute AddExploratoryAnalysis

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instance
string
required

Body

application/json
parameters
object

Parameters for the function.

Response

200 - application/json

OK

createTime
string
required

The create time

id
string
required

The analysis id

messages
string[]
required

Messages

metrics
object[]
required

The metrics to analyze

name
string
required

The analysis name

state
enum<string>
required

The analysis state

Available options:
STATE_UNSPECIFIED,
EMPTY,
CALCULATING,
DONE,
ERROR,
STALE
updateTime
string
required

The update time

analysisResults
object[]

Analysis results

conclusion
object

The conclusion

createdBy
string

A resource name on the format users/abc

endTime
string

The end time of the analysis time window

labels
object[]

Labels

splitByExposureFilters
boolean

Whether to split by exposure filters

startTime
string

The start time of the analysis time window

useCustomDateRange
boolean

Whether the analysis uses a custom date range

useScheduledCalculation
boolean

Use scheduled calculations instead of one-time calculations