Lytics Schema API
Manage how data sources populate profile fields.
Operations 28
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which data tables does my account have a schema for?”
“Can I list every table along with its schema?”
Tell an agent
List all my schema tables.
Show the tables and schemas on account {account_id}.
Ask an LLM
“Is there a POST version of the bulk schema upsert?”
“How do I post a batch of schema fields and ranks without deleting anything?”
Tell an agent
POST bulk schema changes with fields {fields} and ranks {ranks} for table {table}.
Send a POST bulk schema upsert for {table} with retention settings {retention_settings}.
Ask an LLM
“Can I create or update many schema fields and mappings in one PUT request?”
“Does the PUT bulk schema upsert leave existing objects in place?”
Tell an agent
PUT a bulk upsert of fields {fields} and mappings {mappings} into table {table}.
Use the PUT bulk endpoint to upsert schema for {table} as a patch {is_patch}.
Ask an LLM
“What would a mapping expression produce for a sample event?”
“Can I try out an ad hoc mapping expression before saving it?”
Tell an agent
Evaluate expression {expression} against event {data}.
Test mapping expression {expression} on a single event.
Ask an LLM
“Can I upload an LQL query to add fields and mappings to my schema?”
“Is there a way to migrate legacy LQL into the schema?”
Tell an agent
Upload this LQL query to update my schema fields and mappings.
Apply an LQL file to the schema of account {account_id}.
Ask an LLM
“What fields, mappings and ranks make up the user table schema?”
“Can I read the schema of a table at a specific draft version?”
Tell an agent
Show the current schema for table {table}.
Get the schema of {table} at version {version_id}.
Ask an LLM
“What changed between two versions of my schema?”
“Can I see a diff of my draft schema against another version?”
Tell an agent
Compare schema version {version_id} with {compare_id} on table {table}.
Diff the {table} schema versions.
Ask an LLM
“Will my published schema map test events the way I expect?”
“Can I run sample events through a table's schema?”
Tell an agent
Evaluate the {table} schema against test events.
Run test events through schema version {version_id} of {table}.
Ask an LLM
“Which fields are defined on my user table?”
“Can I filter the list of schema fields?”
Tell an agent
List the fields of table {table}.
List fields in {table} matching {filter}.
Ask an LLM
“How do I add a new field to my draft schema?”
“Can I mark a schema field as PII or as an identifier?”
Tell an agent
Add field {id} of type {type} to the {table} draft schema.
Upsert field {id} in {table} with PII set to {is_pii} and identifier {is_identifier}.
Ask an LLM
“Can I remove a field from my draft schema?”
“Is a deleted schema field soft-deleted or gone for good?”
Tell an agent destructive · confirm first
Delete field {field_id} from the {table} draft schema.
Drop schema field {field_id} on {table}.
Ask an LLM
“What type and merge behaviour does a particular field have?”
“Can I look up one schema field by its id?”
Tell an agent
Show field {field_id} in table {table}.
Get the definition of {table} field {field_id} at version {version_id}.
GET
/schema/{table}/idconfig
List identity merge settings for all fields · List all identity config
#
Ask an LLM
“How are graph compaction and many-to-one merging set up across my identity fields?”
“Can I see the identity config of every identifier at once?”
Tell an agent
List identity config for all fields in {table}.
Show graph compaction settings across {table} identity fields.
Ask an LLM
“Can I change how one identity field is compacted or merged?”
“How do I configure many-to-one merging for an identifier?”
Tell an agent
Create or update identity merge config for a field in {table}.
Save many-to-one merging settings for an identifier on {table}.
DELETE
/schema/{table}/idconfig/{field_id}
Remove identity merge config from a field · Delete ID Settings
#
Ask an LLM
“Can I clear the compaction and merge settings on one identifier?”
“How do I delete the ID settings from a schema field?”
Tell an agent destructive · confirm first
Delete the identity config of field {field_id} in {table}.
Clear ID settings on {table} field {field_id}.
GET
/schema/{table}/idconfig/{field_id}
Get identity merge config for one field · Get identity field config
#
Ask an LLM
“What merge settings apply to one particular identity field?”
“Is graph compaction turned on for a given identifier?”
Tell an agent
Show identity config for field {field_id} in {table}.
Get the merging settings of identifier {field_id} on {table}.
Ask an LLM
“Which data mappings feed my user table?”
“Can I see every mapping in the schema at a given version?”
Tell an agent
List the mappings of table {table}.
Show {table} mappings at version {version_id}.
Ask an LLM
“How do I map an incoming stream field into a schema field?”
“Can a mapping have a guard expression so it only applies sometimes?”
Tell an agent
Map stream {stream} into field {field} of {table} using {expr}.
Upsert a mapping for field {field} on {table} guarded by {guard_expr}.
DELETE
/schema/{table}/mapping/{mapping_id}
Delete a mapping from the draft schema · Delete mapping
#
Ask an LLM
“Can I remove a data mapping I added by mistake?”
“Is a deleted mapping soft-deleted from the draft?”
Tell an agent destructive · confirm first
Delete mapping {mapping_id} from the {table} draft schema.
Drop data mapping {mapping_id} on {table}.
Ask an LLM
“What expression does a particular mapping use?”
“Can I look up one mapping by its id?”
Tell an agent
Show mapping {mapping_id} in table {table}.
Get the definition of {table} mapping {mapping_id}.
Ask an LLM
“How do I make my draft schema changes go live?”
“Can I tag a schema version when publishing it?”
Tell an agent
Publish the draft schema for {table}.
Publish {table} schema changes with tag {tag} and note {description}.
Ask an LLM
“In what order are identifiers ranked when resolving profiles?”
“Which identity field ranks highest in my schema?”
Tell an agent
Show the identifier rank list for {table}.
Get {table} identifier ranks at version {version_id}.
Ask an LLM
“Can I reorder which identifiers take priority?”
“How do I change the identifier ranking in my draft schema?”
Tell an agent
Set the identifier rank order of {table} to {fields}.
Apply rank changes {changes} to {table}.
Ask an LLM
“How long is profile data kept for my table?”
“What retention capacity is set on a schema?”
Tell an agent
Show retention settings for {table}.
Get {table} retention at version {version_id}.
Ask an LLM
“Can I shorten how many days of data a table keeps?”
“How do I set a retention capacity on my schema?”
Tell an agent
Keep {keep_days} days of data in {table}.
Set retention capacity of {table} to {capacity}.
Ask an LLM
“Can I throw away my draft schema edits and go back to what is live?”
“How do I undo every unpublished change to a schema?”
Tell an agent destructive · confirm first
Revert the {table} draft schema to the live schema.
Discard changes in schema version {version_id} of {table}.
Ask an LLM
“Is my draft schema valid before I publish it?”
“What validation errors does a schema version have?”
Tell an agent
Validate the schema of {table}.
Check schema version {version_id} of {table} for errors.
Ask an LLM
“Who published which schema versions, and when?”
“Can I see the full history of a table's schema?”
Tell an agent
List every schema version of {table}.
Show the publish history for the {table} schema.