Lytics Segment Collection API

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 called **Goals** which defines the main funnel of user conversions for your company. Definining this helps our Machine Learning understand goals. In addition, the Lytics App has a variety of collections for *Aspects* on the home page/reporting which are collections of segments on related themes. * *Email* Collection of aspects related to email behavior. * *Web* A variety of aspects of web users. * *Ecommerce*

Business capability
Customer Segmentation Management BC-420.20

Operations 5

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

GET /api/segmentcollection List segment collections · SegmentCollectionList #
Ask an LLM
“Which segment collections exist on my account?”
“Can I include the member segments when listing collections?”
Tell an agent
List my segment collections.
Show segment collections with sideloaded segments: {sideload}.
POST /api/segmentcollection Create a segment collection · SegmentCollection Create #
Ask an LLM
“Can I group existing segments into a named collection?”
“What do I need to make a new segment collection?”
Tell an agent
Create segment collection {name} from segments {collection}.
Make a new collection called {name}.
GET /api/segmentcollection/{id} Get a segment collection · SegmentCollection Fetch #
Ask an LLM
“Can I fetch one segment collection by slug?”
“Which segments are in a given collection?”
Tell an agent
Show segment collection {id}.
Fetch collection {id} with its segments sideloaded: {sideload}.
PUT /api/segmentcollection/{id} Update a segment collection · SegmentCollection Update #
Ask an LLM
“Can I rename a segment collection or change its segments?”
“Is it possible to edit an existing collection?”
Tell an agent
Rename segment collection {id} to {name}.
Set the segments in collection {id} to {collection}.
DELETE /api/segmentcollection/{id} Delete a segment collection · SegmentCollection Delete #
Ask an LLM
“Can I delete a segment collection?”
“Is a collection removable without touching its segments?”
Tell an agent destructive · confirm first
Delete segment collection {id}.
Remove collection {id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/lytics:lytics-segmentcollection-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

lytics-segmentcollection-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: V1 Lytics Segment Collection API
  version: 1.0.0
  description: 'The Lytics API is a _restful_ *JSON* api that includes:

    * *Data Collection* api''s for collection, and upload of custom data.'
servers:
- url: https://api.lytics.io
tags:
- name: SegmentCollection
  description: Segment Collections are grouped/named lists of segments.
paths:
  /api/segmentcollection:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SegmentCollectionListModel'
      security:
      - ApiKeyAuth: []
      summary: SegmentCollectionList
      operationId: SegmentCollectionList
      description: Get list **Segment Collections**
      tags:
      - SegmentCollection
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: sideload
        in: query
        description: should segments for collection should be sideloaded
        required: false
        example: 'true'
        schema:
          type: boolean
    post:
      responses:
        '201':
          description: Created
          headers: {}
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SegmentCollectionModel'
      security:
      - ApiKeyAuth: []
      summary: SegmentCollection Create
      operationId: SegmentCollectionCreate
      description: Create a new SegmentCollection from existing segments.
      tags:
      - SegmentCollection
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: sideload
        in: query
        description: should segments for collection should be sideloaded
        required: false
        example: 'true'
        schema:
          type: boolean
      requestBody:
        $ref: '#/components/requestBodies/SegmentCollection_CreateBody'
      x-operation-id-source: normalized
      x-operation-id-original: SegmentCollection Create
  /api/segmentcollection/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SegmentCollectionModel'
      security:
      - ApiKeyAuth: []
      summary: SegmentCollection Fetch
      operationId: SegmentCollectionFetch
      description: Fetch a segment collection by **id** or **slug**
      tags:
      - SegmentCollection
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: id of segment collection
        required: true
        example: 1234abcd
        schema:
          type: string
      - name: sideload
        in: query
        description: should segments for collection should be sideloaded
        required: false
        example: 'true'
        schema:
          type: boolean
      x-operation-id-source: normalized
      x-operation-id-original: SegmentCollection Fetch
    put:
      responses:
        '201':
          description: Created
          headers: {}
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SegmentCollectionModel'
      security:
      - ApiKeyAuth: []
      summary: SegmentCollection Update
      operationId: SegmentCollectionUpdate
      description: Update a SegmentCollection
      tags:
      - SegmentCollection
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: id of segment collection
        required: true
        example: 1234abcd
        schema:
          type: string
      - name: sideload
        in: query
        description: should segments for collection should be sideloaded
        required: false
        example: 'true'
        schema:
          type: boolean
      requestBody:
        $ref: '#/components/requestBodies/SegmentCollection_CreateBody'
      x-operation-id-source: normalized
      x-operation-id-original: SegmentCollection Update
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
      security:
      - ApiKeyAuth: []
      summary: SegmentCollection Delete
      operationId: SegmentCollectionDelete
      description: Delete a SegmentCollection model.
      tags:
      - SegmentCollection
      parameters:
      - name: account_id
        in: query
        description: Your Lytics account ID.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: ID of the SegmentCollection model to delete.
        required: true
        example: source::target
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: SegmentCollection Delete
components:
  schemas:
    SegmentCollectionModel: {}
    SegmentCollectionListModel: {}
  requestBodies:
    SegmentCollection_CreateBody:
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
              collection:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    order:
                      type: number
                  required:
                  - id
                  - order
            example:
              name: Collection Name
              collection:
              - id: 1234abcd
                order: 0
              - id: 3456abcd
                order: 1
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
x-readme:
  explorer-enabled: true
  proxy-enabled: true