Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
607 changes: 607 additions & 0 deletions .generator/schemas/v2/openapi.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
"""
Get funnel step suggestions returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.product_analytics_api import ProductAnalyticsApi
from datadog_api_client.v2.model.product_analytics_funnel_step_suggestions_request import (
ProductAnalyticsFunnelStepSuggestionsRequest,
)
from datadog_api_client.v2.model.product_analytics_funnel_step_suggestions_request_attributes import (
ProductAnalyticsFunnelStepSuggestionsRequestAttributes,
)
from datadog_api_client.v2.model.product_analytics_funnel_step_suggestions_request_data import (
ProductAnalyticsFunnelStepSuggestionsRequestData,
)
from datadog_api_client.v2.model.product_analytics_funnel_step_suggestions_request_type import (
ProductAnalyticsFunnelStepSuggestionsRequestType,
)

body = ProductAnalyticsFunnelStepSuggestionsRequest(
data=ProductAnalyticsFunnelStepSuggestionsRequestData(
attributes=ProductAnalyticsFunnelStepSuggestionsRequestAttributes(
application_id="40d8ca4b-2ac0-481f-b16e-f110699ecff6",
expression="node_0->node_1",
steps=dict(
node_0="@type:view @view.name:/checkout",
),
),
type=ProductAnalyticsFunnelStepSuggestionsRequestType.FUNNEL_SUGGESTIONS_STEPS_REQUEST,
),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["query_product_analytics_funnel_step_suggestions"] = True
with ApiClient(configuration) as api_client:
api_instance = ProductAnalyticsApi(api_client)
response = api_instance.query_product_analytics_funnel_step_suggestions(body=body)

print(response)
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Get feature suggestions returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.product_analytics_api import ProductAnalyticsApi
from datadog_api_client.v2.model.product_analytics_funnel_suggestions_request import (
ProductAnalyticsFunnelSuggestionsRequest,
)
from datadog_api_client.v2.model.product_analytics_funnel_suggestions_request_attributes import (
ProductAnalyticsFunnelSuggestionsRequestAttributes,
)
from datadog_api_client.v2.model.product_analytics_funnel_suggestions_request_data import (
ProductAnalyticsFunnelSuggestionsRequestData,
)
from datadog_api_client.v2.model.product_analytics_funnel_suggestions_request_type import (
ProductAnalyticsFunnelSuggestionsRequestType,
)

body = ProductAnalyticsFunnelSuggestionsRequest(
data=ProductAnalyticsFunnelSuggestionsRequestData(
attributes=ProductAnalyticsFunnelSuggestionsRequestAttributes(
application_id="40d8ca4b-2ac0-481f-b16e-f110699ecff6",
),
type=ProductAnalyticsFunnelSuggestionsRequestType.FUNNEL_SUGGESTIONS_REQUEST,
),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["query_product_analytics_funnel_suggestions"] = True
with ApiClient(configuration) as api_client:
api_instance = ProductAnalyticsApi(api_client)
response = api_instance.query_product_analytics_funnel_suggestions(body=body)

print(response)
130 changes: 130 additions & 0 deletions examples/v2/product-analytics/QueryProductAnalyticsJourneyDropOff.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
"""
Analyze journey drop-off returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.product_analytics_api import ProductAnalyticsApi
from datadog_api_client.v2.model.product_analytics_event_query import ProductAnalyticsEventQuery
from datadog_api_client.v2.model.product_analytics_event_query_data_source import ProductAnalyticsEventQueryDataSource
from datadog_api_client.v2.model.product_analytics_event_search import ProductAnalyticsEventSearch
from datadog_api_client.v2.model.product_analytics_join_keys import ProductAnalyticsJoinKeys
from datadog_api_client.v2.model.product_analytics_journey_audience_account_query import (
ProductAnalyticsJourneyAudienceAccountQuery,
)
from datadog_api_client.v2.model.product_analytics_journey_audience_filters import (
ProductAnalyticsJourneyAudienceFilters,
)
from datadog_api_client.v2.model.product_analytics_journey_audience_segment_query import (
ProductAnalyticsJourneyAudienceSegmentQuery,
)
from datadog_api_client.v2.model.product_analytics_journey_audience_user_query import (
ProductAnalyticsJourneyAudienceUserQuery,
)
from datadog_api_client.v2.model.product_analytics_journey_drop_off_query import ProductAnalyticsJourneyDropOffQuery
from datadog_api_client.v2.model.product_analytics_journey_drop_off_request import ProductAnalyticsJourneyDropOffRequest
from datadog_api_client.v2.model.product_analytics_journey_drop_off_request_attributes import (
ProductAnalyticsJourneyDropOffRequestAttributes,
)
from datadog_api_client.v2.model.product_analytics_journey_drop_off_request_data import (
ProductAnalyticsJourneyDropOffRequestData,
)
from datadog_api_client.v2.model.product_analytics_journey_drop_off_request_type import (
ProductAnalyticsJourneyDropOffRequestType,
)
from datadog_api_client.v2.model.product_analytics_journey_node_target import ProductAnalyticsJourneyNodeTarget
from datadog_api_client.v2.model.product_analytics_journey_node_target_type import ProductAnalyticsJourneyNodeTargetType
from datadog_api_client.v2.model.product_analytics_journey_search import ProductAnalyticsJourneySearch
from datadog_api_client.v2.model.product_analytics_journey_search_filters import ProductAnalyticsJourneySearchFilters
from datadog_api_client.v2.model.product_analytics_journey_search_graph_filter import (
ProductAnalyticsJourneySearchGraphFilter,
)
from datadog_api_client.v2.model.product_analytics_journey_search_graph_filter_name import (
ProductAnalyticsJourneySearchGraphFilterName,
)
from datadog_api_client.v2.model.product_analytics_journey_search_graph_filter_operator import (
ProductAnalyticsJourneySearchGraphFilterOperator,
)
from datadog_api_client.v2.model.product_analytics_sampling import ProductAnalyticsSampling

body = ProductAnalyticsJourneyDropOffRequest(
data=ProductAnalyticsJourneyDropOffRequestData(
attributes=ProductAnalyticsJourneyDropOffRequestAttributes(
_from=1756425600000,
query=ProductAnalyticsJourneyDropOffQuery(
sampling=ProductAnalyticsSampling(
enabled=False,
),
search=ProductAnalyticsJourneySearch(
expression="A -> B",
filters=ProductAnalyticsJourneySearchFilters(
audience_filters=ProductAnalyticsJourneyAudienceFilters(
accounts=[
ProductAnalyticsJourneyAudienceAccountQuery(
name="enterprise_accounts",
),
],
formula="power_users AND NOT trial_segment",
segments=[
ProductAnalyticsJourneyAudienceSegmentQuery(
name="trial_segment",
segment_id="00000000-0000-0000-0000-000000000000",
),
],
users=[
ProductAnalyticsJourneyAudienceUserQuery(
name="power_users",
),
],
),
graph_filters=[
ProductAnalyticsJourneySearchGraphFilter(
name=ProductAnalyticsJourneySearchGraphFilterName.TIME_TO_CONVERT,
operator=ProductAnalyticsJourneySearchGraphFilterOperator.LESS_THAN_OR_EQUAL,
target=ProductAnalyticsJourneyNodeTarget(
type=ProductAnalyticsJourneyNodeTargetType.NODE,
value="A",
),
value=60000,
),
],
),
join_keys=ProductAnalyticsJoinKeys(
primary="@session.id",
secondary=[],
),
node_objects=dict(
A=ProductAnalyticsEventQuery(
data_source=ProductAnalyticsEventQueryDataSource.PRODUCT_ANALYTICS,
search=ProductAnalyticsEventSearch(
query="@type:view @view.name:Login",
),
),
B=ProductAnalyticsEventQuery(
data_source=ProductAnalyticsEventQueryDataSource.PRODUCT_ANALYTICS,
search=ProductAnalyticsEventSearch(
query="@type:action @action.target.name:Submit",
),
),
),
),
target=ProductAnalyticsJourneyNodeTarget(
type=ProductAnalyticsJourneyNodeTargetType.NODE,
value="B",
),
top_issue_count=5,
),
to=1756857600000,
),
type=ProductAnalyticsJourneyDropOffRequestType.JOURNEY_DROP_OFF_ANALYSIS_REQUEST,
),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["query_product_analytics_journey_drop_off"] = True
with ApiClient(configuration) as api_client:
api_instance = ProductAnalyticsApi(api_client)
response = api_instance.query_product_analytics_journey_drop_off(body=body)

print(response)
3 changes: 3 additions & 0 deletions src/datadog_api_client/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -851,6 +851,9 @@ def __init__(
"v2.update_org_group_policy": False,
"v2.update_org_group_policy_override": False,
"v2.list_role_templates": False,
"v2.query_product_analytics_funnel_step_suggestions": False,
"v2.query_product_analytics_funnel_suggestions": False,
"v2.query_product_analytics_journey_drop_off": False,
"v2.query_product_analytics_journey_funnel": False,
"v2.query_product_analytics_journey_list": False,
"v2.query_product_analytics_journey_scalar": False,
Expand Down
132 changes: 132 additions & 0 deletions src/datadog_api_client/v2/api/product_analytics_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
from datadog_api_client.v2.model.product_analytics_scalar_response import ProductAnalyticsScalarResponse
from datadog_api_client.v2.model.product_analytics_analytics_request import ProductAnalyticsAnalyticsRequest
from datadog_api_client.v2.model.product_analytics_timeseries_response import ProductAnalyticsTimeseriesResponse
from datadog_api_client.v2.model.product_analytics_journey_drop_off_response import (
ProductAnalyticsJourneyDropOffResponse,
)
from datadog_api_client.v2.model.product_analytics_journey_drop_off_request import ProductAnalyticsJourneyDropOffRequest
from datadog_api_client.v2.model.product_analytics_journey_funnel_response import ProductAnalyticsJourneyFunnelResponse
from datadog_api_client.v2.model.product_analytics_journey_funnel_request import ProductAnalyticsJourneyFunnelRequest
from datadog_api_client.v2.model.product_analytics_journey_list_response import ProductAnalyticsJourneyListResponse
Expand All @@ -32,6 +36,18 @@
)
from datadog_api_client.v2.model.product_analytics_sankey_response import ProductAnalyticsSankeyResponse
from datadog_api_client.v2.model.product_analytics_sankey_request import ProductAnalyticsSankeyRequest
from datadog_api_client.v2.model.product_analytics_funnel_suggestions_response import (
ProductAnalyticsFunnelSuggestionsResponse,
)
from datadog_api_client.v2.model.product_analytics_funnel_suggestions_request import (
ProductAnalyticsFunnelSuggestionsRequest,
)
from datadog_api_client.v2.model.product_analytics_funnel_step_suggestions_response import (
ProductAnalyticsFunnelStepSuggestionsResponse,
)
from datadog_api_client.v2.model.product_analytics_funnel_step_suggestions_request import (
ProductAnalyticsFunnelStepSuggestionsRequest,
)


class ProductAnalyticsApi:
Expand All @@ -49,6 +65,66 @@ def __init__(self, api_client=None):
api_client = ApiClient(Configuration())
self.api_client = api_client

self._query_product_analytics_funnel_step_suggestions_endpoint = _Endpoint(
settings={
"response_type": (ProductAnalyticsFunnelStepSuggestionsResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/product-analytics/suggestions/features/steps",
"operation_id": "query_product_analytics_funnel_step_suggestions",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (ProductAnalyticsFunnelStepSuggestionsRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)

self._query_product_analytics_funnel_suggestions_endpoint = _Endpoint(
settings={
"response_type": (ProductAnalyticsFunnelSuggestionsResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/product-analytics/suggestions/features",
"operation_id": "query_product_analytics_funnel_suggestions",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (ProductAnalyticsFunnelSuggestionsRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)

self._query_product_analytics_journey_drop_off_endpoint = _Endpoint(
settings={
"response_type": (ProductAnalyticsJourneyDropOffResponse,),
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
"endpoint_path": "/api/v2/product-analytics/journey/drop_off_analysis",
"operation_id": "query_product_analytics_journey_drop_off",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (ProductAnalyticsJourneyDropOffRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)

self._query_product_analytics_journey_funnel_endpoint = _Endpoint(
settings={
"response_type": (ProductAnalyticsJourneyFunnelResponse,),
Expand Down Expand Up @@ -355,6 +431,62 @@ def __init__(self, api_client=None):
api_client=api_client,
)

def query_product_analytics_funnel_step_suggestions(
self,
body: ProductAnalyticsFunnelStepSuggestionsRequest,
) -> ProductAnalyticsFunnelStepSuggestionsResponse:
"""Get funnel step suggestions.

Get the steps that users most often take after the existing steps of a funnel.
Suggestions come from the same precomputed journeys as feature suggestions.
Returns an empty list when no journey starts with the given steps.

:type body: ProductAnalyticsFunnelStepSuggestionsRequest
:rtype: ProductAnalyticsFunnelStepSuggestionsResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

return self._query_product_analytics_funnel_step_suggestions_endpoint.call_with_http_info(**kwargs)

def query_product_analytics_funnel_suggestions(
self,
body: ProductAnalyticsFunnelSuggestionsRequest,
) -> ProductAnalyticsFunnelSuggestionsResponse:
"""Get feature suggestions.

Get the features that Product Analytics detected in your applications, grouped by
application and feature area. Each feature comes with a suggested journey that users
follow to use it, which you can use as funnel steps.

:type body: ProductAnalyticsFunnelSuggestionsRequest
:rtype: ProductAnalyticsFunnelSuggestionsResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

return self._query_product_analytics_funnel_suggestions_endpoint.call_with_http_info(**kwargs)

def query_product_analytics_journey_drop_off(
self,
body: ProductAnalyticsJourneyDropOffRequest,
) -> ProductAnalyticsJourneyDropOffResponse:
"""Analyze journey drop-off.

Analyze the drop-off at a given step of the journey. The journey must have at least two
steps, and only the ``@session.id`` join key is supported. Set ``target`` to the node to
analyze. It can't be the first step. When ``target`` is omitted, the last step is used.
Returns the number of sessions that reached the step before the target but not the target,
together with the issues and frustration signals most associated with the drop-off.

:type body: ProductAnalyticsJourneyDropOffRequest
:rtype: ProductAnalyticsJourneyDropOffResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body

return self._query_product_analytics_journey_drop_off_endpoint.call_with_http_info(**kwargs)

def query_product_analytics_journey_funnel(
self,
body: ProductAnalyticsJourneyFunnelRequest,
Expand Down
Loading
Loading