Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. V1
  5. SegmentCollection

SegmentCollection

markdownView as Markdown

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*

SegmentCollectionList

GEThttps://api.lytics.io/api/segmentcollection

Get list **Segment Collections**

Sample Response
Status|200 OK
1
null

SegmentCollection Create

POSThttps://api.lytics.io/api/segmentcollection

Create a new SegmentCollection from existing segments.

Sample Request
12345678910111213
{
  "name": "Collection Name",
  "collection": [
    {
      "id": "1234abcd",
      "order": 0
    },
    {
      "id": "3456abcd",
      "order": 1
    }
  ]
}
Sample Response
Status|201 Created
1
null

SegmentCollection Fetch

GEThttps://api.lytics.io/api/segmentcollection/{id}

Fetch a segment collection by **id** or **slug**

Sample Response
Status|200 OK
1
null

SegmentCollection Update

PUThttps://api.lytics.io/api/segmentcollection/{id}

Update a SegmentCollection

Sample Request
12345678910111213
{
  "name": "Collection Name",
  "collection": [
    {
      "id": "1234abcd",
      "order": 0
    },
    {
      "id": "3456abcd",
      "order": 1
    }
  ]
}
Sample Response
Status|201 Created
1
null

SegmentCollection Delete

DELETEhttps://api.lytics.io/api/segmentcollection/{id}

Delete a SegmentCollection model.

Sample Response
Status|204 No Content
1
No Content
Hide Parameters

Query Parameters

account_idoptionalstring

Your Lytics account ID.

sideloadoptionalstring

should segments for collection should be sideloaded

Example:

true

Headers

Authorizationoptionalstring

Hide Parameters

Query Parameters

account_idoptionalstring

Your Lytics account ID.

sideloadoptionalstring

should segments for collection should be sideloaded

Example:

true

Headers

Authorizationoptionalstring

Body Parameters

nameoptionalstring
collectionoptionalobject[]
collection[].idrequiredstring
collection[].orderrequirednumber
Hide Parameters

URL Parameters

idrequiredstring

id of segment collection

Example:

1234abcd

Query Parameters

account_idoptionalstring

Your Lytics account ID.

sideloadoptionalstring

should segments for collection should be sideloaded

Example:

true

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

id of segment collection

Example:

1234abcd

Query Parameters

account_idoptionalstring

Your Lytics account ID.

sideloadoptionalstring

should segments for collection should be sideloaded

Example:

true

Headers

Authorizationoptionalstring

Body Parameters

nameoptionalstring
collectionoptionalobject[]
collection[].idrequiredstring
collection[].orderrequirednumber
Hide Parameters

URL Parameters

idrequiredstring

ID of the SegmentCollection model to delete.

Example:

source::target

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring