Skip to content

Add OpenAPI spec for RUM user segments #3202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI spec for RUM user segments #3202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,032 changes: 1,032 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,13 @@ datadog\_api\_client.v2.api.rum\_retention\_filters\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.rum\_user\_segments\_api module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.rum_user_segments_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.seats\_api module
---------------------------------------------

Expand Down
273 changes: 273 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22642,6 +22642,230 @@ datadog\_api\_client.v2.model.rum\_search\_events\_request module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_create\_attributes module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_create_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_create\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_create\_request module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_data\_query module
--------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_data_query
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_delete\_attributes module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_delete_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_delete\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_delete_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_delete\_response module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_delete_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_delete\_type module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_delete_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_event\_platform module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_event_platform
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_journey module
----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_journey
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_list\_response module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_list_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_reference\_table module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_reference_table
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_reference\_table\_column module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_reference_table_column
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_reference\_table\_join\_condition module
------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_reference_table_join_condition
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_resource\_type module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_resource_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_response module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_response\_attributes module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_response_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_response\_data module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_segment\_type module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_segment_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_source module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_source
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_static\_entry module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_static_entry
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_instance module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_instance
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_list\_response module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_list_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_parameter\_def module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_parameter_def
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_resource\_type module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_resource_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_response\_attributes module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_response_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_response\_data module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_template\_status module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_template_status
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_update\_attributes module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_update_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_update\_data module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_update_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_update\_request module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_segment\_user module
-------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_segment_user
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_sort module
----------------------------------------------

Expand All @@ -22656,6 +22880,55 @@ datadog\_api\_client.v2.model.rum\_sort\_order module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_create\_attributes module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_create_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_create\_data module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_create\_request module
--------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_journey\_filter module
--------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_journey_filter
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_journey\_node module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_journey_node
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_journey\_query\_object module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_journey_query_object
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_static\_segment\_request\_type module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.rum_static_segment_request_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_warning module
-------------------------------------------------

Expand Down
92 changes: 92 additions & 0 deletions examples/v2/rum-user-segments/CreateRumSegment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
"""
Create a RUM segment returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_user_segments_api import RUMUserSegmentsApi
from datadog_api_client.v2.model.rum_segment_create_attributes import RumSegmentCreateAttributes
from datadog_api_client.v2.model.rum_segment_create_data import RumSegmentCreateData
from datadog_api_client.v2.model.rum_segment_create_request import RumSegmentCreateRequest
from datadog_api_client.v2.model.rum_segment_data_query import RumSegmentDataQuery
from datadog_api_client.v2.model.rum_segment_event_platform import RumSegmentEventPlatform
from datadog_api_client.v2.model.rum_segment_journey import RumSegmentJourney
from datadog_api_client.v2.model.rum_segment_reference_table import RumSegmentReferenceTable
from datadog_api_client.v2.model.rum_segment_reference_table_column import RumSegmentReferenceTableColumn
from datadog_api_client.v2.model.rum_segment_reference_table_join_condition import RumSegmentReferenceTableJoinCondition
from datadog_api_client.v2.model.rum_segment_resource_type import RumSegmentResourceType
from datadog_api_client.v2.model.rum_segment_static_entry import RumSegmentStaticEntry
from datadog_api_client.v2.model.rum_segment_template_instance import RumSegmentTemplateInstance

body = RumSegmentCreateRequest(
data=RumSegmentCreateData(
attributes=RumSegmentCreateAttributes(
data_query=RumSegmentDataQuery(
combination="(logs && apm_home) && NOT(apm_trace)",
event_platforms=[
RumSegmentEventPlatform(
facet="@usr.id",
_from=1709888355000,
name="logs",
query="@type:view @view.url_path:/logs",
to=1710493155000,
),
],
journeys=[
RumSegmentJourney(
conversion_type="any",
group_by="@usr.id",
name="my_journey",
search="@type:view",
),
],
reference_tables=[
RumSegmentReferenceTable(
columns=[
RumSegmentReferenceTableColumn(
name="user_id",
),
],
filter_query="",
join_condition=RumSegmentReferenceTableJoinCondition(
column_name="user_id",
facet="@usr.id",
),
name="my_ref_table",
table_name="my_table",
),
],
static=[
RumSegmentStaticEntry(
id="static-list-1",
name="My Static List",
user_count=500,
),
],
templates=[
RumSegmentTemplateInstance(
_from=1709888355000,
parameters=dict(
threshold="5",
),
template_id="stickiness-v1",
to=1710493155000,
),
],
),
description="Users who visited the homepage.",
name="My Segment",
tags=[
"team:frontend",
],
),
type=RumSegmentResourceType.SEGMENT,
),
)

configuration = Configuration()
configuration.unstable_operations["create_rum_segment"] = True
with ApiClient(configuration) as api_client:
api_instance = RUMUserSegmentsApi(api_client)
response = api_instance.create_rum_segment(body=body)

print(response)
Loading