Adobe Analytics · Schema

SegmentList

Paginated list of segments

AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Properties

Name Type Description
content array
totalElements integer Total number of segments available
totalPages integer Total number of pages
numberOfElements integer Number of elements on this page
View JSON Schema on GitHub

JSON Schema

adobe-analytics-segment-list-schema.json Raw ↑
{
  "type": "object",
  "description": "Paginated list of segments",
  "properties": {
    "content": {
      "type": "array",
      "example": [],
      "items": {
        "type": "object",
        "description": "An analytics segment definition",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique segment identifier",
            "example": "abc123"
          },
          "name": {
            "type": "string",
            "description": "Display name of the segment",
            "example": "Example Title"
          },
          "description": {
            "type": "string",
            "description": "Description of the segment's purpose",
            "example": "A sample description."
          },
          "rsid": {
            "type": "string",
            "description": "The report suite this segment is based on",
            "example": "500123"
          },
          "owner": {
            "type": "object",
            "description": "The owner of an Analytics component",
            "properties": {
              "id": {
                "type": "integer",
                "description": "Owner user ID",
                "example": "abc123"
              },
              "name": {
                "type": "string",
                "description": "Owner display name",
                "example": "Example Title"
              },
              "login": {
                "type": "string",
                "description": "Owner login identifier",
                "example": "example_value"
              }
            }
          },
          "definition": {
            "type": "object",
            "description": "The segment rule definition",
            "example": "example_value"
          },
          "modified": {
            "type": "string",
            "description": "Last modification timestamp",
            "format": "date-time",
            "example": "2026-01-15T10:30:00Z"
          },
          "tags": {
            "type": "array",
            "example": [],
            "items": {
              "type": "object",
              "description": "A tag applied to an Analytics component",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "Tag identifier",
                  "example": "abc123"
                },
                "name": {
                  "type": "string",
                  "description": "Tag name",
                  "example": "Example Title"
                },
                "description": {
                  "type": "string",
                  "description": "Tag description",
                  "example": "A sample description."
                },
                "components": {
                  "type": "array",
                  "description": "List of components this tag is applied to",
                  "example": [],
                  "items": {
                    "type": "object"
                  }
                }
              }
            }
          }
        }
      }
    },
    "totalElements": {
      "type": "integer",
      "description": "Total number of segments available",
      "example": 42
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages",
      "example": 42
    },
    "numberOfElements": {
      "type": "integer",
      "description": "Number of elements on this page",
      "example": 10
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SegmentList"
}