Lytics

Lytics Segments API

Create and manage audience segments.

GitHub OpenAPI
Business capability
Customer Segmentation Management BC-420.20

Operations 7

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 /segment List audience segments · Get segments #
Ask an LLM
“Which audience segments exist on my account?”
“Can I list only valid segments of a certain kind?”
Tell an agent
List all my segments.
List {kind} segments on table {table} with valid set to {valid}.
POST /segment Create an audience segment · Create segment #
Ask an LLM
“How do I build a new audience from a SegmentQL definition?”
“Can I make a segment public with its own public name when creating it?”
Tell an agent
Create segment {name} defined as {segment_ql}.
Create a public segment {name} with slug {slug_name} and tags {tags}.
POST /segment/exclude/{operation} Add or remove a segment on the export exclusion list · Add/Remove segment in/from the exclusion list #
Ask an LLM
“Can I exclude everyone in a segment from export jobs?”
“How do I take a segment back off the exclusion list?”
Tell an agent
{operation} segment {segment_id} on the export exclusion list.
Apply exclusion operation {operation} for segment {segment_id} in workflow {workflow}.
DELETE /segment/{ids} Delete several segments at once · Delete segments #
Ask an LLM
“Can I delete a batch of segments in one call?”
“Is there a bulk delete for old audiences?”
Tell an agent destructive · confirm first
Delete segments {ids}.
Bulk remove the audiences with ids {ids}.
DELETE /segment/{id} Delete a single segment · Delete segment #
Ask an LLM
“How do I delete one audience segment?”
“Can I remove just a single segment by its id?”
Tell an agent destructive · confirm first
Delete segment {id}.
Remove only the audience {id}.
GET /segment/{id} Get one segment by id or slug · Get segment #
Ask an LLM
“How many users are in a particular segment?”
“Can I look up a segment by its slug instead of its id?”
Tell an agent
Show segment {id}.
Get segment {id} with sizes {sizes}.
PUT /segment/{id} Update a segment's definition · Update segment #
Ask an LLM
“Can I change the rules that define an existing audience?”
“Is it possible to rename a segment or retag it?”
Tell an agent
Change segment {id} to be defined as {segment_ql}.
Rename segment {id} to {name} and set its tags to {tags}.

Documentation

📖
Documentation
https://docs.lytics.com/reference
📖
APIReference
https://docs.lytics.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/openapi/lytics-segments-api-openapi.yml

Other Resources

🔗
OpenAPI Source
https://dash.readme.com/api/v1/api-registry/1y876emrv8pb2i
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/lytics/refs/heads/main/mcp/lytics-tool-crosswalk.yml
🔗
OpenAPI Source
https://dash.readme.com/api/v1/api-registry/10ej22ml8a94fx

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

GitHub Google LinkedIn

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

OpenAPI Specification

lytics-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@lytics.com
    name: Lytics Support
    url: https://support.lytics.com/hc/en-us
  description: Version 2 of the Lytics API
  termsOfService: https://www.lytics.com/terms-of-service/
  title: Lytics Segments API
  version: '2.0'
servers:
- url: https://api.lytics.io/v2
tags:
- description: Create and manage audience segments.
  name: Segments
paths:
  /segment:
    get:
      description: Get a list of segments for an account
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: Filter by table
        in: query
        name: table
        schema:
          type: string
      - description: Filter by valid (true|false|all)
        in: query
        name: valid
        schema:
          type: string
      - description: Filter by kind (segment|goal|aspect|conversion|managed|all)
        in: query
        name: kind
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      items:
                        $ref: '#/components/schemas/models.Segment'
                      type: array
                  type: object
          description: Segment List Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Get segments
      tags:
      - Segments
      operationId: getSegment
      x-operation-id-source: derived
    post:
      description: Create a segment
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/models.Segment'
        description: Segment Request
        required: true
        x-originalParamName: segment
      responses:
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.Segment'
                  type: object
          description: Segment Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Create segment
      tags:
      - Segments
      operationId: postSegment
      x-operation-id-source: derived
  /segment/exclude/{operation}:
    post:
      description: Adds/Removes the passed segment id in/from the exclusion list. Exclusion list allows to exclude all the users from the segment during the export job.
      parameters:
      - description: Operation add or remove
        in: path
        name: operation
        required: true
        schema:
          type: string
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: Workflow slug.
        in: query
        name: workflow
        schema:
          type: string
      - description: Segment id. The segment that needs to be added/removed in/from the exclusion list.
        in: query
        name: segment_id
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Add/Remove segment in/from the exclusion list
      tags:
      - Segments
      operationId: postSegmentExcludeByOperation
      x-operation-id-source: derived
  /segment/{ids}:
    delete:
      description: Delete multiple segments
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The segment IDs
        in: path
        name: ids
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.SegmentDeleteResp'
                  type: object
          description: Segment Delete Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Delete segments
      tags:
      - Segments
      operationId: deleteSegmentByIds
      x-operation-id-source: derived
  /segment/{id}:
    delete:
      description: Delete a segment
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The segment ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Delete segment
      tags:
      - Segments
      operationId: deleteSegmentById
      x-operation-id-source: derived
    get:
      description: Get a segment by ID or slug
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The segment ID or segment slug
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: Include size
        in: query
        name: sizes
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.Segment'
                  type: object
          description: Segment Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Get segment
      tags:
      - Segments
      operationId: getSegmentById
      x-operation-id-source: derived
    put:
      description: Update a segment
      parameters:
      - description: The account ID. Defaults to the user's default account.
        in: query
        name: account_id
        schema:
          type: string
      - description: The segment ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/models.Segment'
        description: Segment Request
        required: true
        x-originalParamName: segment
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/models.ApiResponse'
                - properties:
                    data:
                      $ref: '#/components/schemas/models.Segment'
                  type: object
          description: Segment Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ApiErrorResponse'
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      summary: Update segment
      tags:
      - Segments
      operationId: putSegmentById
      x-operation-id-source: derived
components:
  schemas:
    models.Segment:
      properties:
        account_id:
          type: string
        aid:
          type: integer
        ast:
          $ref: '#/components/schemas/models.Expr'
        author_id:
          type: string
        category:
          type: string
        created:
          type: string
        datemath_calc:
          type: boolean
        deleted:
          type: boolean
        description:
          type: string
        field_changes_fields:
          items:
            type: string
          type: array
        fields:
          items:
            type: string
          type: array
        forward_datemath:
          type: boolean
        groups:
          items:
            type: string
          type: array
        id:
          type: string
        identities:
          items:
            type: string
          type: array
        includes:
          items:
            type: string
          type: array
        invalid:
          type: boolean
        invalid_reason:
          type: string
        is_public:
          type: boolean
        kind:
          type: string
        name:
          type: string
        public_name:
          type: string
        ql_resolved:
          type: string
        save_hist:
          type: boolean
        schedule_exit:
          type: boolean
        segment_ql:
          type: string
        size:
          type: integer
        slug_name:
          type: string
        table:
          type: string
        tags:
          items:
            type: string
          type: array
        updated:
          type: string
        withs_ql:
          type: string
      type: object
    models.ApiErrorResponse:
      properties:
        errors:
          description: Lytics API Errors
          items:
            $ref: '#/components/schemas/lioerrors.ApiV2ErrorOut'
          type: array
        request_id:
          type: string
        status:
          description: HTTP Status Code
          type: integer
      type: object
    models.SegmentDeleteStatus:
      properties:
        deleted:
          type: boolean
        id:
          type: string
        reason:
          type: string
        segments:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
      type: object
    models.SegmentDeleteResp:
      properties:
        deleted:
          items:
            type: string
          type: array
        not_deleted:
          items:
            type: string
          type: array
        segments:
          items:
            $ref: '#/components/schemas/models.SegmentDeleteStatus'
          type: array
      type: object
    models.ApiResponse:
      properties:
        _meta:
          additionalProperties: true
          description: Response Metadata
          type: object
        data:
          description: Response Payload
          type: object
        request_id:
          type: string
        status:
          description: HTTP Status Code
          type: integer
      type: object
    models.Expr:
      properties:
        args:
          items:
            $ref: '#/components/schemas/models.Expr'
          type: array
        ident:
          type: string
        op:
          type: string
        val:
          type: string
      type: object
    lioerrors.ApiV2ErrorOut:
      properties:
        code:
          description: Lytics Error Code
          enum:
          - UNKNOWN-000
          - BADREQ-001
          - JOB-BADREQ-002
          - NOTFOUND-003
          - JOB-NOTFOUND-004
          - WF-NOTFOUND-005
          - AUTH-NOTFOUND-006
          - AUTHTYPE-NOTFOUND-007
          - AUTH-BADREQ-008
          - TABLE-NOTFOUND-009
          - SCHEMA-NOTFOUND-010
          - SCHEMAVERSION-NOTFOUND-011
          - ENTITY-NOTFOUND-012
          - QUERY-NOTFOUND-013
          - STREAM-NOTFOUND-014
          - PROVIDER-BADREQ-015
          - PROVIDER-NOTFOUND-016
          - UNAUTHORIZED-017
          - SCHEMA-INVALID-018
          - INTERNAL-019
          - ROUTERULE-NOTFOUND-020
          - ACCOUNT-NOTFOUND-021
          - JOB-FAULT-022
          - USER-NOTFOUND-023
          - USER-BADREQ-024
          - JSON-BADREQ-025
          - FORBIDDEN-026
          type: string
        level:
          description: When the error was generated
          type: string
        message:
          description: A description of the error that occurred
          type: string
        timestamp:
          description: The time the error occurred
          format: date-time
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey