Retrigger MetricCalculation

Retriggers a completed metric calculation. This will invalidate the results of the existing calculation and replace with the new results. Can only be done if the current calculation is completed and not already retriggered. Returns the new metric calculation.

POST /v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:retrigger

Retrigger MetricCalculation

cURL

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/scheduledMetricCalculations/{scheduledMetricCalculation}/metricCalculations/{metricCalculation}:retrigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "metricCalculationSpec": {},
  "startTime": {},
  "scheduleIteration": {},
  "times": {},
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "endTime": {},
  "exposureEndTime": {},
  "state": {},
  "metricResults": {},
  "schedule": "<string>",
  "sqlJob": "<string>",
  "supersededBy": "<string>",
  "sql": "<string>",
  "superseeds": "<string>",
  "retriggered": true,
  "outdatedSourceDataInfo": {},
  "error": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

scheduledMetricCalculation · string · required

metricCalculation · string · required

Body

application/json

The body is of type object.

Response

200 - application/json

OK

Represents the calculation of a metric for a specific time window.

metricCalculationSpec · object · required

The metric to calculate.

startTime · object · required

Start time of the calculation in terms of exposure.

scheduleIteration · object · required

The iteration of the schedule that this calculation belongs to.

times · object · required

Info about the start / end timestamps used for the calculation

createTime · object · required

Time when the metric calculation was first created.

updateTime · object · required

Time when the metric calculation was last updated.

creator · string · required

Reference to the identity that created this metric calculation.

updater · string · required

Reference to the identity that last updated this metric calculation.

name · string

Unique identifier of the metric calculation. For example: metricCalculations/0smva5nxuhv4yts6paxt

endTime · object

End time of the calculation in terms of facts. Must be set if exposure_end_time is not set, if exposure_end_time is set, this field will be set to the inferred fact end time.

exposureEndTime · object

End time of the calculation based on exposure, the final end time of the calculation will be set to the inferred fact end time.

state · object

Current state of the calculation.

metricResults · object

Holds the results of the metric calculate when completed.

schedule · string

Resource reference to the schedule if the calculation originated from a schedule.

sqlJob · string

Resource name of the corresponding job that performs the calculation.

supersededBy · string

Set if the metric calculation has been replaced by a newer calculation, occurs for example when parameters of the metric changes.

sql · string

The warehouse-specific query that is used to perform the calculation.

superseeds · string

Set if this metric calculation replaced an older metric calculation.

retriggered · boolean

Determines whether this calculation overlaps with a retriggered range

outdatedSourceDataInfo · object

If the underlying tables changed for the queried values since running the calculation, this contains information about what changed and where.

error · string

Descriptive error if the calculation failed.

labels · object[]

Custom labels for this metric calculation.

Show child attributes

owner · string

The owner of the resource. If not set will default to the creator.