How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lytics

V1 Lytics API

Version 1 of the Lytics API — the data collection, personalization, segmentation, content and catalog surface. Includes the /collect data upload endpoints, the personalization and entity lookup APIs, segment scan and segment ML, content classification and recommendation, the schema catalog, and account management.

Documentation Provider Profile APIs.io OpenAPI GitHub

V1 Lytics API is one of 2 APIs that Lytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Upload, Segment, Personalization, Content, and Catalog. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 136 operations across 88 paths, organized into 20 resource areas, and defines 93 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.lytics.io.

136 operations 88 paths 93 schemas 18 DELETE69 GET4 PATCH37 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.lytics.io
Authentication
API Key
Resource Areas
20

Authentication & Security 1

V1 Lytics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth).

Paths & Operations 136

Across 88 paths, the API surfaces 136 operations — 18 DELETE, 69 GET, 4 PATCH, 37 POST, 8 PUT. They span 20 resource areas, including DataUpload, Segment, SegmentCollection, Subscription, Personalization, Content, System Events, Catalog, and 12 more. Each is listed below with its method, path, parameters, and response codes.

DataUpload 3

APIs for collecting or uploading data. There are two main APIs, one for uploading Large files (bulk, millions of records) and another for sending real-time, or slightly batched ev…

POST
/collect/bulk/{stream}
BulkCSVUpload
BulkCSVUpload 10 params → 200
POST
/collect/bulk/{streamname}
BulkJSONUpload
BulkJSONUpload 6 params → 200
POST
/collect/json/{stream}
Data JSON Upload
Data JSON Upload 6 params → 200
Segment 13

Segments are named, logical expressions of users. These segments may logically be built using other segments as well. The segment api provides a list of segments built by both the…

GET
/api/segment
SegmentList
SegmentList 3 params → 200
POST
/api/segment
Segment Create
Segment Create → 201
GET
/api/segment/{id}
Segment Fetch
Segment Fetch 2 params → 200
PUT
/api/segment/{id}
Segment Update
Segment Update 2 params → 200
DELETE
/api/segment/{id}
Segment Delete
Segment Delete 2 params → 204
POST
/api/segment/size
SegmentSize
SegmentSize → 200
POST
/api/segment/validate
SegmentValidate
SegmentValidate → 200
GET
/api/segment/sizes
SegmentSizes
SegmentSizes 2 params → 200
GET
/api/segment/{segId}/scan
SegmentScan
SegmentScan 12 params → 200
DELETE
/api/segment/{segId}/scan
Segment Batch Delete
Segment Batch Delete 12 params → 204
GET
/api/segment/{segId}/attribution
SegmentAttribution
SegmentAttribution 4 params → 200
GET
/api/segment/attribution
SegmentAttributionList
SegmentAttributionList 4 params → 200
GET
/api/segment/{segId}/fieldinfo
SegmentFieldInfo
SegmentFieldInfo 4 params → 200
SegmentCollection 5

Segment Collections are grouped/named lists of segments. Segments that participate in a collection such as Goals are related. The Lytics App ui has one predefined collection calle…

GET
/api/segmentcollection
SegmentCollectionList
SegmentCollectionList 2 params → 200
POST
/api/segmentcollection
SegmentCollection Create
SegmentCollection Create 2 params body → 201
GET
/api/segmentcollection/{id}
SegmentCollection Fetch
SegmentCollection Fetch 3 params → 200
PUT
/api/segmentcollection/{id}
SegmentCollection Update
SegmentCollection Update 3 params body → 201
DELETE
/api/segmentcollection/{id}
SegmentCollection Delete
SegmentCollection Delete 2 params → 204
Subscription 4

BETA API Subscriptions are queries into real-time events in Lytics, most commonly listening to a list of users entering/leaving segments ie triggers. Common Use Cases Upon Enterin…

GET
/api/subscription
SubscriptionList
SubscriptionList 3 params → 200
POST
/api/subscription
Subscription Upsert
Subscription Upsert 1 param body → 200
GET
/api/subscription/{id}
Subscription Fetch
Subscription Fetch 2 params → 200
DELETE
/api/subscription/{id}
Subscription Delete
Subscription Delete 2 params → 204
Personalization 5

Entity API, ie Personalization or Profile API. Retrieve attributes and segments an entity (most likely a user) is a member of. The Entity is a User most likely, but since Lytics i…

GET
/api/me/{fieldname}/{fieldval}
User Me
User Me 9 params → 200
GET
/api/entity/{table}/{fieldname}/{fieldval}
Personalization
Personalization 10 params → 200
DELETE
/api/entity/{table}/{fieldname}/{fieldval}
Profile Delete Request
Profile Delete Request 4 params → 200
GET
/api/entity/{table}/{fieldval}
Web Personalization
Web Personalization 9 params → 200
GET
/api/entity/deletestatus/{request_id}
ProfileDeletion Status
ProfileDeletion Status 2 params → 200
Content 26

Content APIs for Lytics Content Affinity Engine, allow for adding content into lytics, getting lists of content, and understanding the content and content-topics. Content Classifi…

GET
/api/content/topic
ContentTopics
ContentTopics 2 params → 200
GET
/api/content/topic/{topic}
ContentTopicSummary
ContentTopicSummary 2 params → 200
GET
/api/content/rollup/{label}
ContentTopicRollupSummary
ContentTopicRollupSummary 2 params → 200
GET
/api/content/topicrollup
ContentTopicRollupList
ContentTopicRollupList → 200
GET
/api/content/topicblocklist
Content Topic Blacklist Fetch
Content Topic Blacklist Fetch → 200
POST
/api/content/topicblocklist
Content Topic Blacklist Create
Content Topic Blacklist Create → 200
PUT
/api/content/topicblocklist
Content Topic Blacklist Update
Content Topic Blacklist Update → 200
GET
/api/content/topicrollup/{id}
ContentTopicRollup Fetch
ContentTopicRollup Fetch 2 params → 200
POST
/api/content/topicrollup/{id}
ContentTopicRollup Create
ContentTopicRollup Create 2 params → 201
DELETE
/api/content/topicrollup/{id}
ContentTopicRollup Delete
ContentTopicRollup Delete 2 params → 204
GET
/api/content/doc
ContentDocument
ContentDocument 3 params → 200
GET
/api/content/doc/classify
Content Classify
Content Classify Debug 3 params → 200
POST
/api/content/doc/classify
Content Classify
Content Classify 3 params → 200
GET
/api/content/recommend/user/{fieldname}/{fieldval}
Content Recommendation
Content Recommendation 12 params → 200
GET
/api/content/recommend/segment/{segId}
Content Segment Recommendation
Content Segment Recommendation 6 params → 200
GET
/api/content/recommend/{account}/user/{fieldname}/{fieldval}
Public Content Recommendation
Public Content Recommendation 13 params → 200
GET
/api/content/taxonomy
Content Taxonomy
Content Taxonomy 8 params → 200
POST
/api/content/corpus
Content Corpus
Content Corpus 4 params → 200
GET
/api/content/filter/topic
Content Plot
Content Plot 5 params → 200
POST
/api/content/doc/{docField}/{docId}/topic/{topicLabel}
Topic Add
Topic Add 5 params → 200
DELETE
/api/content/doc/{docField}/{docId}/topic/{topicLabel}
Topic Remove
Topic Remove 5 params → 204
POST
/api/content/crawl
Content Crawl
Content Crawl 3 params → 200
GET
/api/content/metrics
Content Metrics
Content Metrics → 200
GET
/api/content/topic/cluster
Content Topic Clusters
Content Topic Clusters 5 params → 200
POST
/api/content/topic/cluster
Create Content Topic Clusters
Create Content Topic Clusters 5 params → 200
GET
/api/content/topic/cluster/{topicId}
Content Topic Cluster
Content Topic Cluster 5 params → 200
System Events 2

Get internal Lytics system events. These events are generally related to internal changes to state of an account. Common changes are CRUD Operations (Create, Update, Delete) of Ac…

GET
/api/event
System Events Query
System Events Query 7 params → 200
GET
/api/event/:id
System Event Fetch
System Event Fetch → 200
Catalog 6

Catalog exposes info about the schema of the data in Lytics. Entities are Object Types, the primary one being a User although most accounts also have Content and Campaign as well.…

GET
/api/schema/_streams
Streams
Streams → 200
POST
/api/schema/_streams/{stream},{hidden}
Stream Hide
Stream Hide 3 params → 204
POST
/api/schema/_streams/{stream},{name},{hidden}
Field Hide
Field Hide 4 params → 204
GET
/api/schema/{table}
Schema Fields
Schema Fields 2 params → 200
GET
/api/schema/{table}/fieldinfo
FieldInfo For Table
FieldInfo For Table 4 params → 200
GET
/api/schema/{table}/fieldsuggest/{field}
FieldSuggest
FieldSuggest 3 params → 200
Metric 2

The Metric API provides access to a variety of metrics that are recorded in the Lytics platform. With this API, you can access segment-size metrics, events received per-hour, as w…

GET
/api/metric/
Metric
Metric 12 params → 200
POST
/api/metric
Metric
Metrics 1 param body → 200
Account 4

Account related resources of the Lytics API. The Account resource describes an account. An account can be a Master account, which means that it is a billing account. Master accoun…

GET
/api/account/{id}
Retrieve a Single Account
Retrieve a Single Account 2 params → 200
PUT
/api/account/{id}
Account Update
Account Update 2 params body → 200
POST
/api/account
Account Create
Account Create 1 param body → 201
GET
/api/account
Accounts List
Accounts List → 200
Account Settings 4

Account Settings describe features/settings for a Lytics account.

GET
/api/account/setting/{setting}
Retrieve a Single Account Setting
Retrieve a Single Account Setting 2 params → 200
PUT
/api/account/setting/{setting}
Account Setting Update
Account Setting Update 2 params body → 200
DELETE
/api/account/setting/{setting}
Account Setting Delete
Account Setting Delete 2 params → 204
GET
/api/account/setting
Account Setting List
Account Setting List → 200
User 5

Info about Administrative Lytics account users Lytics users are unique across accounts They get invited to have access to your account

GET
/api/user/{userid}
User Fetch
User Fetch 2 params → 200
PUT
/api/user/{userid}
User Update
User Update 2 params → 200
POST
/api/user
User Create
User Create 2 params body → 201
GET
/api/user
User List
User List → 200
POST
/api/user/{userid}/setpassword
User SetPassword
User SetPassword 2 params body → 201
Work 7

Work is an integration unit, typically for imports and exports. Most run continually, while some run to completion. You generally would only use it through the Webadmin Integratio…

GET
/api/work
Work List
Work List 5 params → 200
POST
/api/work
Work Create
Work Create 1 param body → 201
GET
/api/work/{id}
Work Fetch
Work Fetch 2 params → 200
DELETE
/api/work/{id}
Work Delete
Work Delete 2 params → 204
GET
/api/work/_status
Retrieve Work Status
Retrieve Work Status 5 params → 200
POST
/api/work/{id}/{cmd}
Work Command Post
Work Command Post 4 params → 200
POST
/api/work/_bounceall
Work Bounce
Work Bounce 4 params → 200
Auth 5

API for creation or storage of auth tokens. Most of these tokens are created from the Integrations/Imports setup for Lytics integrations. Additionally, api tokens can be created/m…

GET
/api/auth/{id}
Retrieve a Single Auth
Retrieve a Single Auth 3 params → 200
POST
/api/auth/{id}
Create Auth
Create Auth 3 params body → 201
PUT
/api/auth/{id}
Update Auth
Update Auth 3 params → 200
DELETE
/api/auth/{id}
Remove an Auth
Remove an Auth 3 params → 204
POST
/api/auth/createtoken
Auth Create Token
Auth Create Token 1 param body → 201
Provider 3

Provider is a 3rd party Lytics Integrates with (Mailchimp, Optimizely, Mixpanel, Facebook etc)

GET
/api/provider
Provider List
Provider List → 200
GET
/api/provider/:provider_slug
Provider Fetch
Provider Fetch → 200
DELETE
/api/provider/:provider_slug
Remove a Provider
Remove a Provider → 204
Workflow 1

Workflow is a specification for a work unit

GET
/api/workflow
Retrieve Workflow List
Retrieve Workflow List → 200
Query 6

Schema management api to add/edit queries and user-fields. Lytics Query Language ============================= The Lytics Query Language is used to define the transformation of up…

GET
/api/query
Query List
Query List → 200
POST
/api/query
Query Upsert
Query Upsert 2 params → 200
GET
/api/query/{idOrAlias}
Query Fetch
Query Fetch 2 params → 200
DELETE
/api/query/{idOrAlias}
Query Delete
Query Delete 2 params → 204
POST
/api/query/_validate
Query Validation
Query Validation 2 params → 200
POST
/api/query/_test
Query Test Evaluation
Query Test Evaluation → 200
SegmentML 4

SegmentML provides a framework for building custom machine learning models directly in Lytics. Lytics SegmentML models are self-training, continuously-updating and real-time. Segm…

GET
/api/segmentml/{id}
SegmentML Model Fetch
SegmentML Model Fetch 2 params → 200
DELETE
/api/segmentml/{id}
SegmentML Delete
SegmentML Delete 2 params → 204
POST
/api/segmentml
SegmentML Create
SegmentML Create 18 params → 201
GET
/api/segmentml/_dependencies/{modelname}
SegmentML Dependencies
SegmentML Dependencies 2 params → 200
Stream 5

API for creating stream models. A stream is the same as a [data stream](https://learn.lytics.com/product-docs/data-management/using-data-streamswhat-are-data-streams? ) and is con…

GET
/api/stream/{id}
Retrieve a Single Stream
Retrieve a Single Stream 2 params → 200
PUT
/api/stream/{id}
Update a Stream
Update a Stream 2 params → 200
DELETE
/api/stream/{id}
Delete a Stream
Delete a Stream 2 params → 200
GET
/api/stream
Retrieve a List of Streams from Account
Retrieve a List of Streams from Account → 200
POST
/api/stream
Create a Stream
Create a Stream → 200
Experience 26

API for creating and managing Experiences as well as all related and/or dependent models such as but not limited to Groups, Templates, Candidates, etc.

GET
/api/experience
List
ListExperience 4 params → 200
POST
/api/experience
Create
CreateExperience → 201
GET
/api/experience/{id}
Fetch
FetchExperience 3 params → 200
PATCH
/api/experience/{id}
Update
UpdateExperience 3 params → 200
DELETE
/api/experience/{id}
Delete
DeleteExperience 4 params → 204
GET
/api/experience/import
Fetch
FetchImport 4 params → 200
POST
/api/experience/import
Create
CreateImport → 201207
GET
/api/experience/template
List
ListTemplate → 200
POST
/api/experience/template
Create
CreateTemplate → 201
GET
/api/experience/template/{id}
Fetch
FetchTemplate 2 params → 200
PATCH
/api/experience/template/{id}
Update
UpdateTemplate 2 params → 200
DELETE
/api/experience/template/{id}
Delete
DeleteTemplate 2 params → 204
GET
/api/experience/candidate
List
ListCandidate → 200
GET
/api/experience/preview/{accountid}/{id}/config.js
Preview Config
Preview Config 3 params → 200
GET
/api/experience/candidate/{accountid}/config.js
Production Config
Production Config 2 params → 200
GET
/api/experience/group
List
ListGroup 3 params → 200
POST
/api/experience/group
Create
CreateGroup → 201
GET
/api/experience/group/{id}
Fetch
FetchGroup 3 params → 200
PATCH
/api/experience/group/{id}
Update
UpdateGroup 2 params → 200
DELETE
/api/experience/group/{id}
Delete
DeleteGroup 4 params → 204
GET
/api/experience/prioritization
List
ListPrioritization → 200
POST
/api/experience/prioritization
Create
CreatePrioritization → 201
GET
/api/experience/prioritization/{id}
Fetch
FetchPrioritization 2 params → 200
PATCH
/api/experience/prioritization/{id}
Update
UpdatePrioritization 2 params → 200
DELETE
/api/experience/prioritization/{id}
Delete
DeletePrioritization 3 params → 204
POST
/api/experience/group/priority
Master Group Priority
Master Group Priority → 200

Schemas 93

The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are AccountModel (8 properties), AccountSettingModel (6 properties), SegmentMLModel (5 properties), PersonalizationModel (4 properties). Each schema is shown below with its type and property counts.

BulkCSVUpload
BulkdCSVUploadModel
object
3 properties
BulkJSONUpload
BulkJSONUploadModel
object
3 properties
DataUpload
DataUploadModel
object
3 properties
SegmentList
SegmentListModel
object
1 property
Segment
SegmentModel
object
1 property
SegmentSize
SegmentSizeModel
object
1 property
SegmentValidate
SegmentValidateModel
object
3 properties
SegmentSizes
SegmentSizesModel
object
1 property
SegmentScan
SegmentScanModel
SegmentAttribution
SegmentAttributionModel
object
1 property
SegmentAttributionList
SegmentAttributionListModel
object
1 property
SegmentFieldInfo
SegmentFieldInfoModel
SegmentApply
SegmentCollectionList
SegmentCollectionListModel
SegmentCollection
SegmentCollectionModel
SubscriptionList
SubscriptionListModel
object
1 property
Subscription
SubscriptionModel
object
1 property
Personalization
PersonalizationModel
object
4 properties
ProfileDeletion
ProfileDeletionModel
object
3 properties
ContentTopics
ContentTopicsModel
object
3 properties
ContentTopicSummaryModel
object
3 properties
ContentTopicRollupSummaryModel
object
3 properties
ContentTopicRollupList
ContentTopicRollupListModel
object
1 property
ContentTopicBlocklist
ContentTopicBlocklistModel
object
3 properties
ContentTopicRollup
ContentTopicRollupModel
object
1 property
ContentDocument
ContentDocumentModel
object
3 properties
ContentClassifyModel
object
3 properties
ContentRecommendationModel
object
3 properties
ContentSegmentRecommendationModel
object
3 properties
ContentTaxonomyModel
object
3 properties
ContentCorpusModel
object
3 properties
ContentPlotModel
object
3 properties
TopicCurationModel
object
3 properties
ContentCrawlModel
ContentMetricsModel
object
3 properties
ContentTopicClustersModel
object
3 properties
ContentTopicClusterModel
object
3 properties
SystemEventsModel
object
3 properties
SystemEventModel
object
3 properties
StreamsModel
object
1 property
SchemaModel
object
1 property
FieldInfoModel
object
1 property
FieldSuggestModel
MetricModel
object
3 properties
AccountModel
object
8 properties
AccountsListModel
object
2 properties
AccountSettingModel
object
6 properties
AccountSettingListModel
object
2 properties
UserModel
object
1 property
UserListModel
object
1 property
UserSetPassword
WorkListModel
object
1 property
WorkModel
object
1 property
AuthModel
object
2 properties
AuthApiTokenModel
object
2 properties
ProviderListModel
ProviderModel
object
1 property
WorkflowModel
object
1 property
QueryListModel
object
2 properties
QueryModel
object
2 properties
SegmentMLModel
object
5 properties
SegmentMLDependenciesModel
object
3 properties
StreamModel
object
3 properties
Experience
ExperienceModel
Import
Template
Candidate
Group
Prioritization

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lytics-api-v1-openapi.json Raw ↑

Other APIs Lytics publishes across the network.

Lytics API v2
AE Profile APIs.io
#Data Upload#Segment#Personalization#Content#Catalog#Experience#Stream#Query#Work
← Back to V APIs
API Details
ID
lytics:lytics-api-v1
Base URL
https://api.lytics.io
Docs
https://docs.lytics.com/reference
Provider
Lytics
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lytics-api-v1&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lytics-api-v1"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of V1 Lytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.