Skip to main content
POST
/
v1
/
exposureCalculations
Create ExposureCalculation
curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/exposureCalculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "exposureCalculationSpec": {},
  "startTime": {},
  "endTime": {},
  "entity": "<string>",
  "state": {},
  "sqlJob": "<string>",
  "scheduleIteration": {},
  "sql": "<string>",
  "exposureTable": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "schedule": "<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.

Query Parameters

​
exposureCalculationId
string

The id to the give the created exposure calculation. If a not set a random one will be generated.

Body

application/json

The body is of type object.

Response

200 - application/json

OK

Represents the calculation of an a exposure table for a specific time window from an assignment table.

​
exposureCalculationSpec
object
required

The exposure table to calculate.

​
startTime
object
required

Start time of the calculation.

​
endTime
object
required

End time of the calculation.

​
entity
string
required

Resource name of the entity that is being exposed.

​
state
object
required

Current state of the calculation.

​
sqlJob
string
required

Resource name of the corresponding job.

​
scheduleIteration
object
required

The iteration of the schedule that this calculation belongs to.

​
sql
string
required

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

​
exposureTable
string
required

Resource name of the exposure table.

​
createTime
object
required

Time when the exposure calculation was first created.

​
updateTime
object
required

Time when the exposure calculation was last updated.

​
creator
string
required

Reference to the identity that created this exposure calculation.

​
updater
string
required

Reference to the identity that last updated this exposure calculation.

​
name
string

Unique identifier of the exposure calculation. For example: exposureCalculations/0smva5nxuhv4yts6paxt

​
schedule
string

Resource name of the calculation if originating from a schedule.

​
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 exposure calculation.

​
owner
string

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