Get ExposureTable

Get the exposure table.

GET /v1/exposureTables/{exposureTable}

Get ExposureTable

cURL

curl --request GET \
  --url https://metrics.eu.confidence.dev/v1/exposureTables/{exposureTable} \
  --header 'Authorization: Bearer <token>'

200

{
  "sql": "<string>",
  "displayName": "<string>",
  "entity": "<string>",
  "firstExposureTimeColumn": {},
  "entityIdColumn": {},
  "groupNameColumn": {},
  "state": {},
  "schemaValidationJob": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "exposureDataDeliveredUntilTime": {},
  "exposedEntitiesMetric": "<string>",
  "firstExposureTruncation": {},
  "exposureFilterColumn": {},
  "dimensions": [
    {}
  ],
  "error": {},
  "labels": [
    {}
  ],
  "owner": "<string>",
  "scheduledExposureCalculation": "<string>",
  "exposureCalculation": "<string>",
  "deleteTime": {},
  "systemCreated": true
}

Authorizations

Authorization · string · header · required

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

Path Parameters

exposureTable · string · required

Response

200 - application/json

OK

An exposure table is describes how to compute exposures from assignments.

sql · string · required

A data warehouse-specific query to get the data from the exposure table table.

displayName · string · required

Human friendly name of the exposure table.

entity · string · required

Resource name of the entity that is being exposed.

firstExposureTimeColumn · object · required

The column of the table that represents the time of exposure.

entityIdColumn · object · required

Column of the table that represents the identifier of the entity.

groupNameColumn · object · required

Column of the table that contains the group name.

state · object · required

Current state of the table.

schemaValidationJob · string · required

Resource name of the sql job that was used to validate the schema of the exposure table.

createTime · object · required

Time when the exposure table was first created.

updateTime · object · required

Time when the exposure table was last updated.

creator · string · required

Reference to the identity that created this exposure table.

updater · string · required

Reference to the identity that last updated this exposure table.

name · string

Unique identifier of the exposure table. For example: exposureTables/0smva5nxuhv4yts6paxt

exposureDataDeliveredUntilTime · object

The current maximum time point where there is available data for the exposure table table.

exposedEntitiesMetric · string

Resource name of the metric that counts exposures.

firstExposureTruncation · object

Defines how time is truncated in the first_exposure_time_column.

exposureFilterColumn · object

Column of the table that contains what exposure filter this row refers to, if exposure filtering is enabled.

dimensions · object[]

Mapping between columns and dimensions.

error · object

Indicates whether an errors has occurred.

labels · object[]

Custom labels for this exposure table.

Show child attributes

owner · string

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

scheduledExposureCalculation · string

exposureCalculation · string

deleteTime · object

Time when the exposure table was deleted.

systemCreated · boolean

If this exposure table is automatically created.