Google Analytics · Schema

Segments

An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name Type Description
items array A list of segments.
itemsPerPage integer The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified
kind string Collection type for segments.
nextLink string Link to next page for this segment collection.
previousLink string Link to previous page for this segment collection.
startIndex integer The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
totalResults integer The total number of results for the query, regardless of the number of results in the response.
username string Email ID of the authenticated user
View JSON Schema on GitHub

JSON Schema

google-analytics-segments-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Segments",
  "title": "Segments",
  "description": "An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.",
  "properties": {
    "items": {
      "description": "A list of segments.",
      "items": {
        "$ref": "#/components/schemas/Segment"
      },
      "type": "array"
    },
    "itemsPerPage": {
      "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.",
      "format": "int32",
      "type": "integer"
    },
    "kind": {
      "default": "analytics#segments",
      "description": "Collection type for segments.",
      "type": "string"
    },
    "nextLink": {
      "description": "Link to next page for this segment collection.",
      "type": "string"
    },
    "previousLink": {
      "description": "Link to previous page for this segment collection.",
      "type": "string"
    },
    "startIndex": {
      "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.",
      "format": "int32",
      "type": "integer"
    },
    "totalResults": {
      "description": "The total number of results for the query, regardless of the number of results in the response.",
      "format": "int32",
      "type": "integer"
    },
    "username": {
      "description": "Email ID of the authenticated user",
      "type": "string"
    }
  },
  "type": "object"
}