/management/segments

GET

management

Lists segments to which the user has access.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://analytics.googleapis.com/analytics/v3/management/segments'

Response Example

{
  "items": [
    {
      "created": "2019-08-24T14:15:22Z",
      "definition": "string",
      "id": "string",
      "kind": "analytics#segment",
      "name": "string",
      "segmentId": "string",
      "selfLink": "string",
      "type": "string",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "itemsPerPage": 0,
  "kind": "analytics#segments",
  "nextLink": "string",
  "previousLink": "string",
  "startIndex": 0,
  "totalResults": 0,
  "username": "string"
}

Request

Query Params

max-results

integer

optional

The maximum number of segments to include in this response.

start-index

integer

optional

An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Responses

🟢200Successful response

application/json

Body

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

items

array[object (Segment) {9}]

optional

A list of segments.

created

string <date-time>

optional

Time the segment was created.

definition

string

optional

Segment definition.

string

optional

Segment ID.

kind

string

optional

Resource type for Analytics segment.

Default:

analytics#segment

name

string

optional

Segment name.

segmentId

string

optional

Segment ID. Can be used with the 'segment' parameter in Core Reporting API.

selfLink

string

optional

Link for this segment.

type

string

optional

Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".

updated

string <date-time>

optional

Time the segment was last modified.

itemsPerPage

integer <int32>

optional

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.

kind

string

optional

Collection type for segments.

Default:

analytics#segments

nextLink

string

optional

Link to next page for this segment collection.

previousLink

string

optional

Link to previous page for this segment collection.

startIndex

integer <int32>

optional

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.

totalResults

integer <int32>

optional

The total number of results for the query, regardless of the number of results in the response.

username

string

optional

Email ID of the authenticated user

Modified at 2023-08-15 05:39:07

/management/clientId:hashClientId

/metadata/{reportType}/columns