List tables
GET
https://api.lytics.io/v2/schemaList tables with schema.
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"draft_id": "string",
"draft_version": 0,
"live_id": "string",
"table": "string"
}
],
"request_id": "string",
"status": 0
}Schema Bulk Upsert
POST
https://api.lytics.io/v2/schema/bulkSchema bulk upsert creates/updates multiple schema objects. It does not delete any existing schema objects.
Sample Request
{
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"diff": [
{
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
}
],
"from": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
},
"to": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
}
},
"request_id": "string",
"status": 0
}Schema Bulk Upsert
PUT
https://api.lytics.io/v2/schema/bulkSchema bulk upsert creates/updates multiple schema objects. It does not delete any existing schema objects.
Sample Request
{
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"diff": [
{
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
}
],
"from": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
},
"to": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
}
},
"request_id": "string",
"status": 0
}Evaluate Expression
POST
https://api.lytics.io/v2/schema/expression/evaluateEvaluate an adhoc mapping expression against a single event
Sample Request
{
"data": {},
"expression": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": "string",
"request_id": "string",
"status": 0
}Update schema with LQL query
POST
https://api.lytics.io/v2/schema/lqlUpload LQL query to update schema with corresponding fields and mappings.
Sample Request
"string"
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
]
},
"request_id": "string",
"status": 0
}Get schema
GET
https://api.lytics.io/v2/schema/{table}Retrieve current schema fields, mappings and ranks
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
},
"request_id": "string",
"status": 0
}Get schema comparison
GET
https://api.lytics.io/v2/schema/{table}/compareGet a diff of two schema versions
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"diff": [
{
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
}
],
"from": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
},
"to": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
}
},
"request_id": "string",
"status": 0
}Evaluate Schema
POST
https://api.lytics.io/v2/schema/{table}/evaluateEvaluate a schema against test events. Defaults to the draft; pass version_id for a specific version, or patch_id to evaluate a patch merged onto the live schema.
Sample Request
{
"property1": [
{}
],
"property2": [
{}
]
}Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{}
],
"request_id": "string",
"status": 0
}Get fields
GET
https://api.lytics.io/v2/schema/{table}/fieldRetrieve current fields
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"request_id": "string",
"status": 0
}Post field
POST
https://api.lytics.io/v2/schema/{table}/fieldUpsert a field in draft schema.
Sample Request
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
},
"request_id": "string",
"status": 0
}Get a field
GET
https://api.lytics.io/v2/schema/{table}/field/{field_id}Retrieve a field by its ID
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
},
"request_id": "string",
"status": 0
}Delete field
DELETE
https://api.lytics.io/v2/schema/{table}/field/{field_id}Soft-delete a schema field from this draft, or hard-delete it if new.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {},
"request_id": "string",
"status": 0
}List all identity config
GET
https://api.lytics.io/v2/schema/{table}/idconfigList graph compaction and many-to-one merging configuration for all identity fields.
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"request_id": "string",
"status": 0
}Post ID config
POST
https://api.lytics.io/v2/schema/{table}/idconfigCreate or update configuration for a single identity field.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"request_id": "string",
"status": 0
}Get identity field config
GET
https://api.lytics.io/v2/schema/{table}/idconfig/{field_id}Get graph compaction and many-to-one merging configuration for a single identity field.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"request_id": "string",
"status": 0
}Delete ID Settings
DELETE
https://api.lytics.io/v2/schema/{table}/idconfig/{field_id}Soft-delete graph compaction and many-to-one merging config from a single schema field, or hard-delete them if new.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {},
"request_id": "string",
"status": 0
}Get mappings
GET
https://api.lytics.io/v2/schema/{table}/mappingRetrive current mappings
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"request_id": "string",
"status": 0
}Post mapping
POST
https://api.lytics.io/v2/schema/{table}/mappingUpsert a mapping in draft schema.
Sample Request
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
},
"request_id": "string",
"status": 0
}Get a mapping
GET
https://api.lytics.io/v2/schema/{table}/mapping/{mapping_id}Retrieve a mapping by ID
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
},
"request_id": "string",
"status": 0
}Delete mapping
DELETE
https://api.lytics.io/v2/schema/{table}/mapping/{mapping_id}Soft-delete a data mapping from this draft, or hard-delete it if new.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {},
"request_id": "string",
"status": 0
}Publish schema
POST
https://api.lytics.io/v2/schema/{table}/publishPublish changes to your schema
Sample Request
{
"description": "string",
"tag": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
},
"request_id": "string",
"status": 0
}Get rank
GET
https://api.lytics.io/v2/schema/{table}/rankRetrieve current identifier rank list.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
},
"request_id": "string",
"status": 0
}Post ID rank list
POST
https://api.lytics.io/v2/schema/{table}/rankCreate or update identifier rank list.
Sample Request
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
},
"request_id": "string",
"status": 0
}Get retention settings
GET
https://api.lytics.io/v2/schema/{table}/retentionsettingsRetrieve current retention settings.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"request_id": "string",
"status": 0
}Post retention settings
POST
https://api.lytics.io/v2/schema/{table}/retentionsettingsCreate or update retention settings.
Sample Request
{
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
}Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"request_id": "string",
"status": 0
}Revert schema changes
POST
https://api.lytics.io/v2/schema/{table}/revertRestore an entire schema version to the state of the current live schema.
Sample Response
Status|200 OK
{
"_meta": {},
"data": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
},
"request_id": "string",
"status": 0
}Validate schema
GET
https://api.lytics.io/v2/schema/{table}/validateRun validation for schema
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"has_unpublished_changes": true,
"id": "string",
"parent_id": "string",
"table": "string",
"validation_errors": [
"string"
],
"version_number": 0
}
],
"request_id": "string",
"status": 0
}Get schema history
GET
https://api.lytics.io/v2/schema/{table}/versionGet a list of all schema versions in its history
Sample Response
Status|200 OK
{
"_meta": {},
"data": [
{
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"description": "string",
"draft_status": "string",
"fields": [
{
"assertions": {
"email": true,
"filter": [
"string"
],
"format": "alpha",
"length": {
"max": 0,
"min": 0
}
},
"capacity": 0,
"created": "2019-08-24T14:15:22Z",
"disable_indexing": true,
"edit_status": "string",
"id": "string",
"id_config": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
},
"is_identifier": true,
"is_pii": true,
"keep_days": 0,
"keep_duration": "string",
"longdesc": "string",
"managed_by": "string",
"mergeop": "string",
"modified": "string",
"shortdesc": "string",
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"is_patch": true,
"mappings": [
{
"created": "2019-08-24T14:15:22Z",
"edit_status": "string",
"expr": "string",
"field": "string",
"guard_expr": "string",
"id": "string",
"managed_by": "string",
"modified": "2019-08-24T14:15:22Z",
"stream": "string"
}
],
"modified": "2019-08-24T14:15:22Z",
"parent_id": "string",
"published_by": "string",
"ranks": {
"id_config": [
{
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"compact_after_days": 0,
"compact_over": 0,
"created": "string",
"edit_status": "string",
"field": "string",
"many_to": [
"string"
],
"modified": "string"
}
],
"id_ranks": {
"changes": {
"diff": [
{
"from_val": null,
"property": "string",
"to_val": null
}
],
"id": "string",
"subject": "mapping",
"verb": "created"
},
"created": "string",
"edit_status": "string",
"fields": [
"string"
],
"modified": "string"
}
},
"retention_settings": {
"capacity": 0,
"created": "string",
"edit_status": "string",
"keep_days": 0,
"modified": "string"
},
"status": "live",
"table": "string",
"tag": "string",
"version_number": 0
}
],
"request_id": "string",
"status": 0
}