diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 937403aeb0a..70c223164e4 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -10938,6 +10938,114 @@ menu: - AggregateRUMEvents unstable: [] order: 3 + - name: RUM User Segments + url: /api/latest/rum-user-segments/ + identifier: rum-user-segments + generated: true + - name: Update a RUM segment + url: '#update-a-rum-segment' + identifier: rum-user-segments-update-a-rum-segment + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - UpdateRumSegment + unstable: + - v2 + order: 8 + - name: Get a RUM segment + url: '#get-a-rum-segment' + identifier: rum-user-segments-get-a-rum-segment + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - GetRumSegment + unstable: + - v2 + order: 7 + - name: Delete a RUM segment + url: '#delete-a-rum-segment' + identifier: rum-user-segments-delete-a-rum-segment + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - DeleteRumSegment + unstable: + - v2 + order: 6 + - name: List RUM segment templates + url: '#list-rum-segment-templates' + identifier: rum-user-segments-list-rum-segment-templates + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - ListRumSegmentTemplates + unstable: + - v2 + order: 5 + - name: Create a static RUM segment + url: '#create-a-static-rum-segment' + identifier: rum-user-segments-create-a-static-rum-segment + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - CreateRumStaticSegment + unstable: + - v2 + order: 4 + - name: Initialize RUM segments + url: '#initialize-rum-segments' + identifier: rum-user-segments-initialize-rum-segments + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - InitializeRumSegments + unstable: + - v2 + order: 3 + - name: Create a RUM segment + url: '#create-a-rum-segment' + identifier: rum-user-segments-create-a-rum-segment + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - CreateRumSegment + unstable: + - v2 + order: 2 + - name: List all RUM segments + url: '#list-all-rum-segments' + identifier: rum-user-segments-list-all-rum-segments + parent: rum-user-segments + generated: true + params: + versions: + - v2 + operationids: + - ListRumSegments + unstable: + - v2 + order: 1 - name: Reference Tables url: /api/latest/reference-tables/ identifier: reference-tables diff --git a/content/en/api/latest/rum-user-segments/_index.md b/content/en/api/latest/rum-user-segments/_index.md new file mode 100644 index 00000000000..02856d0ec27 --- /dev/null +++ b/content/en/api/latest/rum-user-segments/_index.md @@ -0,0 +1,3 @@ +--- +title: RUM User Segments +--- diff --git a/content/en/api/v2/rum-user-segments/_index.md b/content/en/api/v2/rum-user-segments/_index.md new file mode 100644 index 00000000000..2e23bbefab4 --- /dev/null +++ b/content/en/api/v2/rum-user-segments/_index.md @@ -0,0 +1,4 @@ +--- +title: RUM User Segments +headless: true +--- diff --git a/content/en/api/v2/rum-user-segments/examples.json b/content/en/api/v2/rum-user-segments/examples.json new file mode 100644 index 00000000000..153461d2475 --- /dev/null +++ b/content/en/api/v2/rum-user-segments/examples.json @@ -0,0 +1,1170 @@ +{ + "ListRumSegments": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created_at": "2024-03-15T10:30:00Z", + "created_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "data_query": { + "combination": "(logs && apm_home) && NOT(apm_trace)", + "event_platforms": [ + { + "facet": "@usr.id", + "from": 1709888355000, + "name": "logs", + "query": "@type:view @view.url_path:/logs", + "to": 1710493155000 + } + ], + "journeys": [ + { + "conversion_type": "any", + "group_by": "@usr.id", + "name": "my_journey", + "search": "@type:view" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "filter_query": "", + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "from": 1709888355000, + "parameters": { + "": "string" + }, + "template_id": "stickiness-v1", + "to": 1710493155000 + } + ] + }, + "description": "Users who visited the homepage.", + "modified_at": "2024-03-15T10:30:00Z", + "modified_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "name": "My Segment", + "org_id": 123456, + "row_count": 500, + "source": "user_created", + "tags": [ + "team:frontend" + ], + "type": "event_platform", + "uuid": "a1b2c3d4-1234-5678-9abc-123456789abc", + "version": 1 + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "segment" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of segments.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a segment in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The creation timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_query [required]

\n
\n

object

\n

Query definition for the segment. Contains one or more query blocks and an optional combination formula.

\n
\n
\n
\n
\n
\n

combination

\n
\n

string

\n

Boolean expression combining multiple query blocks.

\n
\n \n
\n
\n
\n
\n
\n

event_platforms

\n
\n

[object]

\n

List of event platform query blocks.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The facet to extract user identifiers from.

\n
\n \n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

journeys

\n
\n

[object]

\n

List of journey-based query blocks.

\n
\n
\n
\n
\n
\n

conversion_type

\n
\n

string

\n

The type of conversion to track.

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

The facet to group journey results by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of this journey query block.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

reference_tables

\n
\n

[object]

\n

List of reference table query blocks.

\n
\n
\n
\n
\n
\n

columns [required]

\n
\n

[object]

\n

The columns to include from the reference table.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the column.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter_query

\n
\n

string

\n

An optional filter query for the reference table data.

\n
\n \n
\n
\n
\n
\n
\n

join_condition [required]

\n
\n

object

\n

The join condition for a reference table query block.

\n
\n
\n
\n
\n
\n

column_name [required]

\n
\n

string

\n

The reference table column to join on.

\n
\n \n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The RUM facet to join on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

static

\n
\n

[object]

\n

List of static user list blocks.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the static list.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static list.

\n
\n \n
\n
\n
\n
\n
\n

user_count [required]

\n
\n

int64

\n

The number of users in the static list.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

templates

\n
\n

[object]

\n

List of template-based query blocks.

\n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The template parameters as key-value pairs.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

template_id [required]

\n
\n

string

\n

The identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the segment.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The last modification timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the segment.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The organization identifier.

\n
\n \n
\n
\n
\n
\n
\n

row_count [required]

\n
\n

int64

\n

The number of users in the segment.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of a segment. \nAllowed enum values: user_created,initial

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags for the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of a segment based on its data query configuration. \nAllowed enum values: static,event_platform,combination,journeys,reference_table,templates

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The version number of the segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment resource. \nAllowed enum values: segment

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateRumSegment": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created_at": "2024-03-15T10:30:00Z", + "created_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "data_query": { + "combination": "(logs && apm_home) && NOT(apm_trace)", + "event_platforms": [ + { + "facet": "@usr.id", + "from": 1709888355000, + "name": "logs", + "query": "@type:view @view.url_path:/logs", + "to": 1710493155000 + } + ], + "journeys": [ + { + "conversion_type": "any", + "group_by": "@usr.id", + "name": "my_journey", + "search": "@type:view" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "filter_query": "", + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "from": 1709888355000, + "parameters": { + "": "string" + }, + "template_id": "stickiness-v1", + "to": 1710493155000 + } + ] + }, + "description": "Users who visited the homepage.", + "modified_at": "2024-03-15T10:30:00Z", + "modified_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "name": "My Segment", + "org_id": 123456, + "row_count": 500, + "source": "user_created", + "tags": [ + "team:frontend" + ], + "type": "event_platform", + "uuid": "a1b2c3d4-1234-5678-9abc-123456789abc", + "version": 1 + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "segment" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a segment in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a segment in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The creation timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_query [required]

\n
\n

object

\n

Query definition for the segment. Contains one or more query blocks and an optional combination formula.

\n
\n
\n
\n
\n
\n

combination

\n
\n

string

\n

Boolean expression combining multiple query blocks.

\n
\n \n
\n
\n
\n
\n
\n

event_platforms

\n
\n

[object]

\n

List of event platform query blocks.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The facet to extract user identifiers from.

\n
\n \n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

journeys

\n
\n

[object]

\n

List of journey-based query blocks.

\n
\n
\n
\n
\n
\n

conversion_type

\n
\n

string

\n

The type of conversion to track.

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

The facet to group journey results by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of this journey query block.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

reference_tables

\n
\n

[object]

\n

List of reference table query blocks.

\n
\n
\n
\n
\n
\n

columns [required]

\n
\n

[object]

\n

The columns to include from the reference table.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the column.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter_query

\n
\n

string

\n

An optional filter query for the reference table data.

\n
\n \n
\n
\n
\n
\n
\n

join_condition [required]

\n
\n

object

\n

The join condition for a reference table query block.

\n
\n
\n
\n
\n
\n

column_name [required]

\n
\n

string

\n

The reference table column to join on.

\n
\n \n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The RUM facet to join on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

static

\n
\n

[object]

\n

List of static user list blocks.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the static list.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static list.

\n
\n \n
\n
\n
\n
\n
\n

user_count [required]

\n
\n

int64

\n

The number of users in the static list.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

templates

\n
\n

[object]

\n

List of template-based query blocks.

\n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The template parameters as key-value pairs.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

template_id [required]

\n
\n

string

\n

The identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the segment.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The last modification timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the segment.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The organization identifier.

\n
\n \n
\n
\n
\n
\n
\n

row_count [required]

\n
\n

int64

\n

The number of users in the segment.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of a segment. \nAllowed enum values: user_created,initial

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags for the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of a segment based on its data query configuration. \nAllowed enum values: static,event_platform,combination,journeys,reference_table,templates

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The version number of the segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment resource. \nAllowed enum values: segment

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "409": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "data_query": { + "event_platforms": [ + { + "facet": "@usr.id", + "name": "logs", + "query": "@type:view @view.url_path:/logs" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "template_id": "stickiness-v1" + } + ] + }, + "name": "My Segment" + }, + "type": "segment" + } + }, + "json": { + "data": { + "attributes": { + "data_query": { + "combination": "(logs && apm_home) && NOT(apm_trace)", + "event_platforms": [ + { + "facet": "@usr.id", + "from": 1709888355000, + "name": "logs", + "query": "@type:view @view.url_path:/logs", + "to": 1710493155000 + } + ], + "journeys": [ + { + "conversion_type": "any", + "group_by": "@usr.id", + "name": "my_journey", + "search": "@type:view" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "filter_query": "", + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "from": 1709888355000, + "parameters": { + "": "string" + }, + "template_id": "stickiness-v1", + "to": 1710493155000 + } + ] + }, + "description": "Users who visited the homepage.", + "name": "My Segment", + "tags": [ + "team:frontend" + ] + }, + "type": "segment" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a segment creation request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a new segment.

\n
\n
\n
\n
\n
\n

data_query [required]

\n
\n

object

\n

Query definition for the segment. Contains one or more query blocks and an optional combination formula.

\n
\n
\n
\n
\n
\n

combination

\n
\n

string

\n

Boolean expression combining multiple query blocks.

\n
\n \n
\n
\n
\n
\n
\n

event_platforms

\n
\n

[object]

\n

List of event platform query blocks.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The facet to extract user identifiers from.

\n
\n \n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

journeys

\n
\n

[object]

\n

List of journey-based query blocks.

\n
\n
\n
\n
\n
\n

conversion_type

\n
\n

string

\n

The type of conversion to track.

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

The facet to group journey results by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of this journey query block.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

reference_tables

\n
\n

[object]

\n

List of reference table query blocks.

\n
\n
\n
\n
\n
\n

columns [required]

\n
\n

[object]

\n

The columns to include from the reference table.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the column.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter_query

\n
\n

string

\n

An optional filter query for the reference table data.

\n
\n \n
\n
\n
\n
\n
\n

join_condition [required]

\n
\n

object

\n

The join condition for a reference table query block.

\n
\n
\n
\n
\n
\n

column_name [required]

\n
\n

string

\n

The reference table column to join on.

\n
\n \n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The RUM facet to join on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

static

\n
\n

[object]

\n

List of static user list blocks.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the static list.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static list.

\n
\n \n
\n
\n
\n
\n
\n

user_count [required]

\n
\n

int64

\n

The number of users in the static list.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

templates

\n
\n

[object]

\n

List of template-based query blocks.

\n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The template parameters as key-value pairs.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

template_id [required]

\n
\n

string

\n

The identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the segment.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the segment.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags for the segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment resource. \nAllowed enum values: segment

\n
\n \n
\n
\n
\n
" + } + }, + "InitializeRumSegments": { + "responses": { + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateRumStaticSegment": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created_at": "2024-03-15T10:30:00Z", + "created_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "data_query": { + "combination": "(logs && apm_home) && NOT(apm_trace)", + "event_platforms": [ + { + "facet": "@usr.id", + "from": 1709888355000, + "name": "logs", + "query": "@type:view @view.url_path:/logs", + "to": 1710493155000 + } + ], + "journeys": [ + { + "conversion_type": "any", + "group_by": "@usr.id", + "name": "my_journey", + "search": "@type:view" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "filter_query": "", + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "from": 1709888355000, + "parameters": { + "": "string" + }, + "template_id": "stickiness-v1", + "to": 1710493155000 + } + ] + }, + "description": "Users who visited the homepage.", + "modified_at": "2024-03-15T10:30:00Z", + "modified_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "name": "My Segment", + "org_id": 123456, + "row_count": 500, + "source": "user_created", + "tags": [ + "team:frontend" + ], + "type": "event_platform", + "uuid": "a1b2c3d4-1234-5678-9abc-123456789abc", + "version": 1 + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "segment" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a segment in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a segment in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The creation timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_query [required]

\n
\n

object

\n

Query definition for the segment. Contains one or more query blocks and an optional combination formula.

\n
\n
\n
\n
\n
\n

combination

\n
\n

string

\n

Boolean expression combining multiple query blocks.

\n
\n \n
\n
\n
\n
\n
\n

event_platforms

\n
\n

[object]

\n

List of event platform query blocks.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The facet to extract user identifiers from.

\n
\n \n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

journeys

\n
\n

[object]

\n

List of journey-based query blocks.

\n
\n
\n
\n
\n
\n

conversion_type

\n
\n

string

\n

The type of conversion to track.

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

The facet to group journey results by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of this journey query block.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

reference_tables

\n
\n

[object]

\n

List of reference table query blocks.

\n
\n
\n
\n
\n
\n

columns [required]

\n
\n

[object]

\n

The columns to include from the reference table.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the column.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter_query

\n
\n

string

\n

An optional filter query for the reference table data.

\n
\n \n
\n
\n
\n
\n
\n

join_condition [required]

\n
\n

object

\n

The join condition for a reference table query block.

\n
\n
\n
\n
\n
\n

column_name [required]

\n
\n

string

\n

The reference table column to join on.

\n
\n \n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The RUM facet to join on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

static

\n
\n

[object]

\n

List of static user list blocks.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the static list.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static list.

\n
\n \n
\n
\n
\n
\n
\n

user_count [required]

\n
\n

int64

\n

The number of users in the static list.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

templates

\n
\n

[object]

\n

List of template-based query blocks.

\n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The template parameters as key-value pairs.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

template_id [required]

\n
\n

string

\n

The identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the segment.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The last modification timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the segment.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The organization identifier.

\n
\n \n
\n
\n
\n
\n
\n

row_count [required]

\n
\n

int64

\n

The number of users in the segment.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of a segment. \nAllowed enum values: user_created,initial

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags for the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of a segment based on its data query configuration. \nAllowed enum values: static,event_platform,combination,journeys,reference_table,templates

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The version number of the segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment resource. \nAllowed enum values: segment

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "409": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "description": "Users from a specific journey.", + "journey_query_object": { + "nodes": [ + { + "filters": [ + { + "attribute": "@type", + "value": "view" + } + ] + } + ] + }, + "name": "My Static Segment" + }, + "type": "create_static_segment_request" + } + }, + "json": { + "data": { + "attributes": { + "description": "Users from a specific journey.", + "journey_query_object": { + "nodes": [ + { + "filters": [ + { + "attribute": "@type", + "value": "view" + } + ] + } + ] + }, + "name": "My Static Segment", + "tags": [ + "team:frontend" + ] + }, + "type": "create_static_segment_request" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a static segment creation request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for creating a new static segment.

\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the static segment.

\n
\n \n
\n
\n
\n
\n
\n

journey_query_object [required]

\n
\n

object

\n

The journey query object used to compute the static segment user list.

\n
\n
\n
\n
\n
\n

nodes [required]

\n
\n

[object]

\n

The list of journey nodes defining the query.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[object]

\n

The list of filters for this node.

\n
\n
\n
\n
\n
\n

attribute [required]

\n
\n

string

\n

The attribute to filter on.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

string

\n

The value to match.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static segment.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags for the static segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the static segment creation request resource. \nAllowed enum values: create_static_segment_request

\n
\n \n
\n
\n
\n
" + } + }, + "ListRumSegmentTemplates": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "category": "engagement", + "created_at": "2024-01-01T00:00:00Z", + "description": "Users who visited at least N times.", + "modified_at": "2024-01-01T00:00:00Z", + "name": "stickiness-v1", + "parameters": { + "": { + "default": "5", + "description": "The minimum number of sessions.", + "validate": "required" + } + }, + "status": "active", + "version": 1 + }, + "id": "stickiness-v1", + "type": "template_metadata" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of segment templates.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a segment template in a response.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the template.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The creation timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The last modification timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the template.

\n
\n \n
\n
\n
\n
\n
\n

parameters [required]

\n
\n

object

\n

The template parameter definitions.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

A parameter definition for a segment template.

\n
\n
\n
\n
\n
\n

default [required]

\n
\n

string

\n

The default value for the parameter.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the parameter.

\n
\n \n
\n
\n
\n
\n
\n

validate [required]

\n
\n

string

\n

Validation rules for the parameter.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of a segment template. \nAllowed enum values: active,deprecated,archived

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The version number of the template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment template resource. \nAllowed enum values: template_metadata

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "DeleteRumSegment": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "disabled_at": "2024-03-15T10:30:00Z", + "disabled_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "name": "My Segment", + "uuid": "a1b2c3d4-1234-5678-9abc-123456789abc" + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "deleted_segment" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a deleted segment response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a deleted segment response.

\n
\n
\n
\n
\n
\n

disabled_at [required]

\n
\n

date-time

\n

The timestamp when the segment was disabled in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

disabled_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the deleted segment.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the deleted segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier for the deleted segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the deleted segment resource. \nAllowed enum values: deleted_segment

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetRumSegment": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2024-03-15T10:30:00Z", + "created_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "data_query": { + "combination": "(logs && apm_home) && NOT(apm_trace)", + "event_platforms": [ + { + "facet": "@usr.id", + "from": 1709888355000, + "name": "logs", + "query": "@type:view @view.url_path:/logs", + "to": 1710493155000 + } + ], + "journeys": [ + { + "conversion_type": "any", + "group_by": "@usr.id", + "name": "my_journey", + "search": "@type:view" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "filter_query": "", + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "from": 1709888355000, + "parameters": { + "": "string" + }, + "template_id": "stickiness-v1", + "to": 1710493155000 + } + ] + }, + "description": "Users who visited the homepage.", + "modified_at": "2024-03-15T10:30:00Z", + "modified_by": { + "handle": "john.doe@example.com", + "icon": "https://example.com/icon.png", + "id": "12", + "name": "John Doe", + "uuid": "user-uuid-123" + }, + "name": "My Segment", + "org_id": 123456, + "row_count": 500, + "source": "user_created", + "tags": [ + "team:frontend" + ], + "type": "event_platform", + "uuid": "a1b2c3d4-1234-5678-9abc-123456789abc", + "version": 1 + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "segment" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a segment in a response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a segment in a response.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The creation timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_query [required]

\n
\n

object

\n

Query definition for the segment. Contains one or more query blocks and an optional combination formula.

\n
\n
\n
\n
\n
\n

combination

\n
\n

string

\n

Boolean expression combining multiple query blocks.

\n
\n \n
\n
\n
\n
\n
\n

event_platforms

\n
\n

[object]

\n

List of event platform query blocks.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The facet to extract user identifiers from.

\n
\n \n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

journeys

\n
\n

[object]

\n

List of journey-based query blocks.

\n
\n
\n
\n
\n
\n

conversion_type

\n
\n

string

\n

The type of conversion to track.

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

The facet to group journey results by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of this journey query block.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

reference_tables

\n
\n

[object]

\n

List of reference table query blocks.

\n
\n
\n
\n
\n
\n

columns [required]

\n
\n

[object]

\n

The columns to include from the reference table.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the column.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter_query

\n
\n

string

\n

An optional filter query for the reference table data.

\n
\n \n
\n
\n
\n
\n
\n

join_condition [required]

\n
\n

object

\n

The join condition for a reference table query block.

\n
\n
\n
\n
\n
\n

column_name [required]

\n
\n

string

\n

The reference table column to join on.

\n
\n \n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The RUM facet to join on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

static

\n
\n

[object]

\n

List of static user list blocks.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the static list.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static list.

\n
\n \n
\n
\n
\n
\n
\n

user_count [required]

\n
\n

int64

\n

The number of users in the static list.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

templates

\n
\n

[object]

\n

List of template-based query blocks.

\n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The template parameters as key-value pairs.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

template_id [required]

\n
\n

string

\n

The identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the segment.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The last modification timestamp in RFC 3339 format.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

object

\n

A user who performed an action on a segment.

\n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The email handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

The URL of the user icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The numeric identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The display name of the user.

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the segment.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The organization identifier.

\n
\n \n
\n
\n
\n
\n
\n

row_count [required]

\n
\n

int64

\n

The number of users in the segment.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of a segment. \nAllowed enum values: user_created,initial

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of tags for the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of a segment based on its data query configuration. \nAllowed enum values: static,event_platform,combination,journeys,reference_table,templates

\n
\n \n
\n
\n
\n
\n
\n

uuid [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The version number of the segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the segment.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment resource. \nAllowed enum values: segment

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateRumSegment": { + "responses": { + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "409": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "data_query": { + "event_platforms": [ + { + "facet": "@usr.id", + "name": "logs", + "query": "@type:view @view.url_path:/logs" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "template_id": "stickiness-v1" + } + ] + } + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "segment" + } + }, + "json": { + "data": { + "attributes": { + "data_query": { + "combination": "(logs && apm_home) && NOT(apm_trace)", + "event_platforms": [ + { + "facet": "@usr.id", + "from": 1709888355000, + "name": "logs", + "query": "@type:view @view.url_path:/logs", + "to": 1710493155000 + } + ], + "journeys": [ + { + "conversion_type": "any", + "group_by": "@usr.id", + "name": "my_journey", + "search": "@type:view" + } + ], + "reference_tables": [ + { + "columns": [ + { + "name": "user_id" + } + ], + "filter_query": "", + "join_condition": { + "column_name": "user_id", + "facet": "@usr.id" + }, + "name": "my_ref_table", + "table_name": "my_table" + } + ], + "static": [ + { + "id": "static-list-1", + "name": "My Static List", + "user_count": 500 + } + ], + "templates": [ + { + "from": 1709888355000, + "parameters": { + "": "string" + }, + "template_id": "stickiness-v1", + "to": 1710493155000 + } + ] + }, + "description": "Updated description.", + "name": "Updated Segment Name", + "tags": [ + "team:backend" + ] + }, + "id": "a1b2c3d4-1234-5678-9abc-123456789abc", + "type": "segment" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a segment update request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes for updating a segment. All fields are optional.

\n
\n
\n
\n
\n
\n

data_query

\n
\n

object

\n

Query definition for the segment. Contains one or more query blocks and an optional combination formula.

\n
\n
\n
\n
\n
\n

combination

\n
\n

string

\n

Boolean expression combining multiple query blocks.

\n
\n \n
\n
\n
\n
\n
\n

event_platforms

\n
\n

[object]

\n

List of event platform query blocks.

\n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The facet to extract user identifiers from.

\n
\n \n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

journeys

\n
\n

[object]

\n

List of journey-based query blocks.

\n
\n
\n
\n
\n
\n

conversion_type

\n
\n

string

\n

The type of conversion to track.

\n
\n \n
\n
\n
\n
\n
\n

group_by

\n
\n

string

\n

The facet to group journey results by.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of this journey query block.

\n
\n \n
\n
\n
\n
\n
\n

search

\n
\n

string

\n

The search query for filtering events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

reference_tables

\n
\n

[object]

\n

List of reference table query blocks.

\n
\n
\n
\n
\n
\n

columns [required]

\n
\n

[object]

\n

The columns to include from the reference table.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the column.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

filter_query

\n
\n

string

\n

An optional filter query for the reference table data.

\n
\n \n
\n
\n
\n
\n
\n

join_condition [required]

\n
\n

object

\n

The join condition for a reference table query block.

\n
\n
\n
\n
\n
\n

column_name [required]

\n
\n

string

\n

The reference table column to join on.

\n
\n \n
\n
\n
\n
\n
\n

facet [required]

\n
\n

string

\n

The RUM facet to join on.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this query block.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

static

\n
\n

[object]

\n

List of static user list blocks.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the static list.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the static list.

\n
\n \n
\n
\n
\n
\n
\n

user_count [required]

\n
\n

int64

\n

The number of users in the static list.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

templates

\n
\n

[object]

\n

List of template-based query blocks.

\n
\n
\n
\n
\n
\n

from

\n
\n

int64

\n

The start of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n

parameters

\n
\n

object

\n

The template parameters as key-value pairs.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

template_id [required]

\n
\n

string

\n

The identifier of the template.

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

int64

\n

The end of the time range in milliseconds since epoch.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The updated description of the segment.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The updated name of the segment.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The updated list of tags for the segment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the segment to update.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the segment resource. \nAllowed enum values: segment

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index d33fea9c8a0..e79790d497b 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -51551,6 +51551,713 @@ components: $ref: '#/components/schemas/RumRetentionFilterData' type: array type: object + RumSegmentCreateAttributes: + description: Attributes for creating a new segment. + properties: + data_query: + $ref: '#/components/schemas/RumSegmentDataQuery' + description: + description: A description of the segment. + example: Users who visited the homepage. + type: string + name: + description: The name of the segment. + example: My Segment + type: string + tags: + description: A list of tags for the segment. + example: + - team:frontend + items: + type: string + type: array + required: + - name + - data_query + type: object + RumSegmentCreateData: + description: Data object for a segment creation request. + properties: + attributes: + $ref: '#/components/schemas/RumSegmentCreateAttributes' + type: + $ref: '#/components/schemas/RumSegmentResourceType' + required: + - type + - attributes + type: object + RumSegmentCreateRequest: + description: Request body for creating a new segment. + properties: + data: + $ref: '#/components/schemas/RumSegmentCreateData' + required: + - data + type: object + RumSegmentDataQuery: + description: Query definition for the segment. Contains one or more query blocks + and an optional combination formula. + properties: + combination: + description: Boolean expression combining multiple query blocks. + example: (logs && apm_home) && NOT(apm_trace) + type: string + event_platforms: + description: List of event platform query blocks. + items: + $ref: '#/components/schemas/RumSegmentEventPlatform' + type: array + journeys: + description: List of journey-based query blocks. + items: + $ref: '#/components/schemas/RumSegmentJourney' + type: array + reference_tables: + description: List of reference table query blocks. + items: + $ref: '#/components/schemas/RumSegmentReferenceTable' + type: array + static: + description: List of static user list blocks. + items: + $ref: '#/components/schemas/RumSegmentStaticEntry' + type: array + templates: + description: List of template-based query blocks. + items: + $ref: '#/components/schemas/RumSegmentTemplateInstance' + type: array + type: object + RumSegmentDeleteAttributes: + description: Attributes of a deleted segment response. + properties: + disabled_at: + description: The timestamp when the segment was disabled in RFC 3339 format. + example: '2024-03-15T10:30:00Z' + format: date-time + type: string + disabled_by: + $ref: '#/components/schemas/RumSegmentUser' + name: + description: The name of the deleted segment. + example: My Segment + type: string + uuid: + description: The unique identifier of the deleted segment. + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + required: + - uuid + - name + - disabled_at + - disabled_by + type: object + RumSegmentDeleteData: + description: Data object for a deleted segment response. + properties: + attributes: + $ref: '#/components/schemas/RumSegmentDeleteAttributes' + id: + description: Unique identifier for the deleted segment. + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + type: + $ref: '#/components/schemas/RumSegmentDeleteType' + required: + - id + - type + - attributes + type: object + RumSegmentDeleteResponse: + description: Response for a segment deletion. + properties: + data: + $ref: '#/components/schemas/RumSegmentDeleteData' + required: + - data + type: object + RumSegmentDeleteType: + description: Type of the deleted segment resource. + enum: + - deleted_segment + example: deleted_segment + type: string + x-enum-varnames: + - DELETED_SEGMENT + RumSegmentEventPlatform: + description: An event platform query block within a segment data query. + properties: + facet: + description: The facet to extract user identifiers from. + example: '@usr.id' + type: string + from: + description: The start of the time range in milliseconds since epoch. + example: 1709888355000 + format: int64 + type: integer + name: + description: The name of this query block. + example: logs + type: string + query: + description: The search query for filtering events. + example: '@type:view @view.url_path:/logs' + type: string + to: + description: The end of the time range in milliseconds since epoch. + example: 1710493155000 + format: int64 + type: integer + required: + - name + - query + - facet + type: object + RumSegmentJourney: + description: A journey-based query block within a segment data query. + properties: + conversion_type: + description: The type of conversion to track. + example: any + type: string + group_by: + description: The facet to group journey results by. + example: '@usr.id' + type: string + name: + description: The name of this journey query block. + example: my_journey + type: string + search: + description: The search query for filtering events. + example: '@type:view' + type: string + type: object + RumSegmentListResponse: + description: Response for listing segments. + properties: + data: + description: The list of segments. + items: + $ref: '#/components/schemas/RumSegmentResponseData' + type: array + required: + - data + type: object + RumSegmentReferenceTable: + description: A reference table query block within a segment data query. + properties: + columns: + description: The columns to include from the reference table. + items: + $ref: '#/components/schemas/RumSegmentReferenceTableColumn' + type: array + filter_query: + description: An optional filter query for the reference table data. + example: '' + type: string + join_condition: + $ref: '#/components/schemas/RumSegmentReferenceTableJoinCondition' + name: + description: The name of this query block. + example: my_ref_table + type: string + table_name: + description: The name of the reference table. + example: my_table + type: string + required: + - name + - table_name + - columns + - join_condition + type: object + RumSegmentReferenceTableColumn: + description: A column definition in a reference table query block. + properties: + name: + description: The name of the column. + example: user_id + type: string + required: + - name + type: object + RumSegmentReferenceTableJoinCondition: + description: The join condition for a reference table query block. + properties: + column_name: + description: The reference table column to join on. + example: user_id + type: string + facet: + description: The RUM facet to join on. + example: '@usr.id' + type: string + required: + - facet + - column_name + type: object + RumSegmentResourceType: + description: Type of the segment resource. + enum: + - segment + example: segment + type: string + x-enum-varnames: + - SEGMENT + RumSegmentResponse: + description: Response containing a single segment. + properties: + data: + $ref: '#/components/schemas/RumSegmentResponseData' + required: + - data + type: object + RumSegmentResponseAttributes: + description: Attributes of a segment in a response. + properties: + created_at: + description: The creation timestamp in RFC 3339 format. + example: '2024-03-15T10:30:00Z' + format: date-time + type: string + created_by: + $ref: '#/components/schemas/RumSegmentUser' + data_query: + $ref: '#/components/schemas/RumSegmentDataQuery' + description: + description: A description of the segment. + example: Users who visited the homepage. + type: string + modified_at: + description: The last modification timestamp in RFC 3339 format. + example: '2024-03-15T10:30:00Z' + format: date-time + type: string + modified_by: + $ref: '#/components/schemas/RumSegmentUser' + name: + description: The name of the segment. + example: My Segment + type: string + org_id: + description: The organization identifier. + example: 123456 + format: int64 + type: integer + row_count: + description: The number of users in the segment. + example: 500 + format: int64 + type: integer + source: + $ref: '#/components/schemas/RumSegmentSource' + tags: + description: A list of tags for the segment. + example: + - team:frontend + items: + type: string + type: array + type: + $ref: '#/components/schemas/RumSegmentSegmentType' + uuid: + description: The unique identifier of the segment. + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + version: + description: The version number of the segment. + example: 1 + format: int64 + type: integer + required: + - uuid + - org_id + - name + - description + - data_query + - created_by + - modified_by + - created_at + - modified_at + - row_count + - version + - tags + - type + - source + type: object + RumSegmentResponseData: + description: Data object for a segment in a response. + properties: + attributes: + $ref: '#/components/schemas/RumSegmentResponseAttributes' + id: + description: The unique identifier of the segment. + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + type: + $ref: '#/components/schemas/RumSegmentResourceType' + required: + - id + - type + - attributes + type: object + RumSegmentSegmentType: + description: The type of a segment based on its data query configuration. + enum: + - static + - event_platform + - combination + - journeys + - reference_table + - templates + example: event_platform + type: string + x-enum-varnames: + - STATIC + - EVENT_PLATFORM + - COMBINATION + - JOURNEYS + - REFERENCE_TABLE + - TEMPLATES + RumSegmentSource: + description: The source of a segment. + enum: + - user_created + - initial + example: user_created + type: string + x-enum-varnames: + - USER_CREATED + - INITIAL + RumSegmentStaticEntry: + description: A static user list entry within a segment data query. + properties: + id: + description: The identifier of the static list. + example: static-list-1 + type: string + name: + description: The name of the static list. + example: My Static List + type: string + user_count: + description: The number of users in the static list. + example: 500 + format: int64 + type: integer + required: + - id + - name + - user_count + type: object + RumSegmentTemplateInstance: + description: A template-based query block within a segment data query. + properties: + from: + description: The start of the time range in milliseconds since epoch. + example: 1709888355000 + format: int64 + type: integer + parameters: + additionalProperties: + type: string + description: The template parameters as key-value pairs. + example: + threshold: '5' + type: object + template_id: + description: The identifier of the template. + example: stickiness-v1 + type: string + to: + description: The end of the time range in milliseconds since epoch. + example: 1710493155000 + format: int64 + type: integer + required: + - template_id + type: object + RumSegmentTemplateListResponse: + description: Response for listing segment templates. + properties: + data: + description: The list of segment templates. + items: + $ref: '#/components/schemas/RumSegmentTemplateResponseData' + type: array + required: + - data + type: object + RumSegmentTemplateParameterDef: + description: A parameter definition for a segment template. + properties: + default: + description: The default value for the parameter. + example: '5' + type: string + description: + description: A description of the parameter. + example: The minimum number of sessions. + type: string + validate: + description: Validation rules for the parameter. + example: required + type: string + required: + - description + - default + - validate + type: object + RumSegmentTemplateResourceType: + description: Type of the segment template resource. + enum: + - template_metadata + example: template_metadata + type: string + x-enum-varnames: + - TEMPLATE_METADATA + RumSegmentTemplateResponseAttributes: + description: Attributes of a segment template in a response. + properties: + category: + description: The category of the template. + example: engagement + type: string + created_at: + description: The creation timestamp in RFC 3339 format. + example: '2024-01-01T00:00:00Z' + format: date-time + type: string + description: + description: A description of the template. + example: Users who visited at least N times. + type: string + modified_at: + description: The last modification timestamp in RFC 3339 format. + example: '2024-01-01T00:00:00Z' + format: date-time + type: string + name: + description: The name of the template. + example: stickiness-v1 + type: string + parameters: + additionalProperties: + $ref: '#/components/schemas/RumSegmentTemplateParameterDef' + description: The template parameter definitions. + type: object + status: + $ref: '#/components/schemas/RumSegmentTemplateStatus' + version: + description: The version number of the template. + example: 1 + format: int64 + type: integer + required: + - name + - description + - category + - parameters + - status + - version + - created_at + - modified_at + type: object + RumSegmentTemplateResponseData: + description: Data object for a segment template in a response. + properties: + attributes: + $ref: '#/components/schemas/RumSegmentTemplateResponseAttributes' + id: + description: The unique identifier of the template. + example: stickiness-v1 + type: string + type: + $ref: '#/components/schemas/RumSegmentTemplateResourceType' + required: + - id + - type + - attributes + type: object + RumSegmentTemplateStatus: + description: The status of a segment template. + enum: + - active + - deprecated + - archived + example: active + type: string + x-enum-varnames: + - ACTIVE + - DEPRECATED + - ARCHIVED + RumSegmentUpdateAttributes: + description: Attributes for updating a segment. All fields are optional. + properties: + data_query: + $ref: '#/components/schemas/RumSegmentDataQuery' + description: + description: The updated description of the segment. + example: Updated description. + type: string + name: + description: The updated name of the segment. + example: Updated Segment Name + type: string + tags: + description: The updated list of tags for the segment. + example: + - team:backend + items: + type: string + type: array + type: object + RumSegmentUpdateData: + description: Data object for a segment update request. + properties: + attributes: + $ref: '#/components/schemas/RumSegmentUpdateAttributes' + id: + description: The identifier of the segment to update. + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + type: + $ref: '#/components/schemas/RumSegmentResourceType' + required: + - id + - type + - attributes + type: object + RumSegmentUpdateRequest: + description: Request body for updating a segment. + properties: + data: + $ref: '#/components/schemas/RumSegmentUpdateData' + required: + - data + type: object + RumSegmentUser: + description: A user who performed an action on a segment. + properties: + handle: + description: The email handle of the user. + example: john.doe@example.com + type: string + icon: + description: The URL of the user icon. + example: https://example.com/icon.png + type: string + id: + description: The numeric identifier of the user. + example: '12' + type: string + name: + description: The display name of the user. + example: John Doe + type: string + uuid: + description: The unique identifier of the user. + example: user-uuid-123 + type: string + required: + - id + - uuid + - name + - handle + - icon + type: object + RumStaticSegmentCreateAttributes: + description: Attributes for creating a new static segment. + properties: + description: + description: A description of the static segment. + example: Users from a specific journey. + type: string + journey_query_object: + $ref: '#/components/schemas/RumStaticSegmentJourneyQueryObject' + name: + description: The name of the static segment. + example: My Static Segment + type: string + tags: + description: A list of tags for the static segment. + example: + - team:frontend + items: + type: string + type: array + required: + - name + - description + - journey_query_object + type: object + RumStaticSegmentCreateData: + description: Data object for a static segment creation request. + properties: + attributes: + $ref: '#/components/schemas/RumStaticSegmentCreateAttributes' + type: + $ref: '#/components/schemas/RumStaticSegmentRequestType' + required: + - type + - attributes + type: object + RumStaticSegmentCreateRequest: + description: Request body for creating a new static segment. + properties: + data: + $ref: '#/components/schemas/RumStaticSegmentCreateData' + required: + - data + type: object + RumStaticSegmentJourneyFilter: + description: A filter within a journey query node. + properties: + attribute: + description: The attribute to filter on. + example: '@type' + type: string + value: + description: The value to match. + example: view + type: string + required: + - attribute + - value + type: object + RumStaticSegmentJourneyNode: + description: A node in a journey query object. + properties: + filters: + description: The list of filters for this node. + items: + $ref: '#/components/schemas/RumStaticSegmentJourneyFilter' + type: array + required: + - filters + type: object + RumStaticSegmentJourneyQueryObject: + description: The journey query object used to compute the static segment user + list. + properties: + nodes: + description: The list of journey nodes defining the query. + items: + $ref: '#/components/schemas/RumStaticSegmentJourneyNode' + type: array + required: + - nodes + type: object + RumStaticSegmentRequestType: + description: Type of the static segment creation request resource. + enum: + - create_static_segment_request + example: create_static_segment_request + type: string + x-enum-varnames: + - CREATE_STATIC_SEGMENT_REQUEST RunRetentionFilterName: description: The name of a RUM retention filter. example: Retention filter for session @@ -93848,6 +94555,337 @@ paths: tags: - Rum Replay Viewership x-menu-order: 1 + /api/v2/rum/segment: + get: + description: List all user segments for the current organization. Supports sorting + and pagination. + operationId: ListRumSegments + parameters: + - description: Sort order for the segments list. + in: query + name: sort + required: false + schema: + example: name + type: string + - description: Maximum number of segments to return. + in: query + name: limit + required: false + schema: + example: 25 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentListResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List all RUM segments + tags: + - RUM User Segments + x-menu-order: 1 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + post: + description: Create a new user segment for the current organization. + operationId: CreateRumSegment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentCreateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentResponse' + description: Created + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Conflict + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a RUM segment + tags: + - RUM User Segments + x-menu-order: 2 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/rum/segment/initialize: + post: + description: Initialize default segments for the current organization. This + creates a set of predefined segments if they do not already exist. + operationId: InitializeRumSegments + responses: + '200': + description: OK + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Initialize RUM segments + tags: + - RUM User Segments + x-menu-order: 3 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/rum/segment/static: + post: + description: Create a new static user segment from a journey query. Static segments + contain a fixed list of users computed from the query at creation time. + operationId: CreateRumStaticSegment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RumStaticSegmentCreateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentResponse' + description: Created + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Conflict + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a static RUM segment + tags: + - RUM User Segments + x-menu-order: 4 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/rum/segment/templates: + get: + description: List all available segment templates. Templates provide predefined + segment configurations that can be customized with parameters. + operationId: ListRumSegmentTemplates + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentTemplateListResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List RUM segment templates + tags: + - RUM User Segments + x-menu-order: 5 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/rum/segment/{segment_id}: + delete: + description: Delete a user segment by its identifier. + operationId: DeleteRumSegment + parameters: + - description: The identifier of the segment. + in: path + name: segment_id + required: true + schema: + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentDeleteResponse' + description: OK + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Not Found + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete a RUM segment + tags: + - RUM User Segments + x-menu-order: 6 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + get: + description: Get a specific user segment by its identifier. + operationId: GetRumSegment + parameters: + - description: The identifier of the segment. + in: path + name: segment_id + required: true + schema: + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Not Found + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get a RUM segment + tags: + - RUM User Segments + x-menu-order: 7 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + put: + description: Update an existing user segment. All fields in the request body + are optional. + operationId: UpdateRumSegment + parameters: + - description: The identifier of the segment. + in: path + name: segment_id + required: true + schema: + example: a1b2c3d4-1234-5678-9abc-123456789abc + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RumSegmentUpdateRequest' + required: true + responses: + '204': + description: No Content + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Forbidden + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Not Found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Conflict + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update a RUM segment + tags: + - RUM User Segments + x-menu-order: 8 + x-unstable: '**Note**: This endpoint is in preview and is subject to change. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/saml_configurations/idp_metadata: post: description: 'Endpoint for uploading IdP metadata for SAML setup. @@ -106258,6 +107296,8 @@ tags: aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/) for more information name: RUM +- description: Manage RUM user segments for audience targeting and analysis. + name: RUM User Segments - description: View and manage Reference Tables in your organization. name: Reference Tables - description: 'A restriction policy defines the access control rules for a resource, diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index a32ae0440fc..332e02a3274 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -2924,6 +2924,44 @@ "description": "List watched sessions.", "summary": "List rum replay viewership history sessions" }, + "ListRumSegments": { + "description": "List all user segments for the current organization. Supports sorting and pagination.", + "summary": "List all RUM segments" + }, + "CreateRumSegment": { + "description": "Create a new user segment for the current organization.", + "summary": "Create a RUM segment", + "request_description": "", + "request_schema_description": "Request body for creating a new segment." + }, + "InitializeRumSegments": { + "description": "Initialize default segments for the current organization. This creates a set of predefined segments if they do not already exist.", + "summary": "Initialize RUM segments" + }, + "CreateRumStaticSegment": { + "description": "Create a new static user segment from a journey query. Static segments contain a fixed list of users computed from the query at creation time.", + "summary": "Create a static RUM segment", + "request_description": "", + "request_schema_description": "Request body for creating a new static segment." + }, + "ListRumSegmentTemplates": { + "description": "List all available segment templates. Templates provide predefined segment configurations that can be customized with parameters.", + "summary": "List RUM segment templates" + }, + "DeleteRumSegment": { + "description": "Delete a user segment by its identifier.", + "summary": "Delete a RUM segment" + }, + "GetRumSegment": { + "description": "Get a specific user segment by its identifier.", + "summary": "Get a RUM segment" + }, + "UpdateRumSegment": { + "description": "Update an existing user segment. All fields in the request body are optional.", + "summary": "Update a RUM segment", + "request_description": "", + "request_schema_description": "Request body for updating a segment." + }, "UploadIdPMetadata": { "description": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration.", "summary": "Upload IdP metadata", diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 1c2f1eb8987..130694331e3 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -271,6 +271,10 @@ "name": "RUM", "description": "Manage your Real User Monitoring (RUM) applications, and search or aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/) for more information" }, + "rum-user-segments": { + "name": "RUM User Segments", + "description": "Manage RUM user segments for audience targeting and analysis." + }, "reference-tables": { "name": "Reference Tables", "description": "View and manage Reference Tables in your organization."