Skip to main content
PATCH
/
v1
/
exposureTables
/
{exposureTable}
Update ExposureTable
curl --request PATCH \
  --url https://metrics.eu.confidence.dev/v1/exposureTables/{exposureTable} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": "<string>",
  "displayName": "<string>",
  "entity": "<string>",
  "firstExposureTimeColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "entityIdColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "groupNameColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "exposureDataDeliveredUntilTime": {},
  "dimensions": [
    {
      "name": "<string>",
      "type": "COLUMN_TYPE_UNSPECIFIED",
      "repeated": true
    }
  ],
  "labels": [
    {}
  ],
  "owner": "<string>"
}
'
{
  "sql": "<string>",
  "displayName": "<string>",
  "entity": "<string>",
  "firstExposureTimeColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "entityIdColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "groupNameColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "state": "TABLE_STATE_UNSPECIFIED",
  "schemaValidationJob": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "exposureDataDeliveredUntilTime": {},
  "exposedEntitiesMetric": "<string>",
  "firstExposureTruncation": {
    "window": "TRUNCATION_WINDOW_UNSPECIFIED",
    "behaviour": "TRUNCATION_BEHAVIOR_UNSPECIFIED",
    "timeZone": "TRUNCATION_TIME_ZONE_UNSPECIFIED"
  },
  "exposureFilterColumn": {
    "name": "<string>",
    "type": "COLUMN_TYPE_UNSPECIFIED",
    "repeated": true
  },
  "dimensions": [
    {
      "name": "<string>",
      "type": "COLUMN_TYPE_UNSPECIFIED",
      "repeated": true
    }
  ],
  "error": {
    "message": "<string>",
    "details": [
      "<string>"
    ]
  },
  "labels": [
    {}
  ],
  "owner": "<string>",
  "scheduledExposureCalculation": "<string>",
  "exposureCalculation": "<string>",
  "deleteTime": {},
  "systemCreated": true
}

Documentation Index

Fetch the complete documentation index at: https://confidence.spotify.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
exposureTable
string
required

Query Parameters

​
updateMask
object

The list of fields to update. Fields are specified relative to the ExposureTable (e.g. display_name, sql; not exposure_table.display_name or exposure_table.sql).

Body

application/json
​
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.

​
exposureDataDeliveredUntilTime
object

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

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

​
labels
object[]

Custom labels for this exposure table.

​
owner
string

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

Response

200 - application/json

Returns a ExposureTable.

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
enum<string>
required

Current state of the table.

Available options:
TABLE_STATE_UNSPECIFIED,
TABLE_STATE_CREATING,
TABLE_STATE_ACTIVE,
TABLE_STATE_FAILED,
TABLE_STATE_UPDATING,
TABLE_STATE_DELETED
​
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.

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