Skip to content

Add OpenAPI spec for RUM user segments #3515

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 #3515

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.

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

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentCreateAttributes;
import com.datadog.api.client.v2.model.RumSegmentCreateData;
import com.datadog.api.client.v2.model.RumSegmentCreateRequest;
import com.datadog.api.client.v2.model.RumSegmentDataQuery;
import com.datadog.api.client.v2.model.RumSegmentEventPlatform;
import com.datadog.api.client.v2.model.RumSegmentJourney;
import com.datadog.api.client.v2.model.RumSegmentReferenceTable;
import com.datadog.api.client.v2.model.RumSegmentReferenceTableColumn;
import com.datadog.api.client.v2.model.RumSegmentReferenceTableJoinCondition;
import com.datadog.api.client.v2.model.RumSegmentResourceType;
import com.datadog.api.client.v2.model.RumSegmentResponse;
import com.datadog.api.client.v2.model.RumSegmentStaticEntry;
import com.datadog.api.client.v2.model.RumSegmentTemplateInstance;
import java.util.Collections;
import java.util.Map;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createRumSegment", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

RumSegmentCreateRequest body =
new RumSegmentCreateRequest()
.data(
new RumSegmentCreateData()
.attributes(
new RumSegmentCreateAttributes()
.dataQuery(
new RumSegmentDataQuery()
.combination("(logs && apm_home) && NOT(apm_trace)")
.eventPlatforms(
Collections.singletonList(
new RumSegmentEventPlatform()
.facet("@usr.id")
.from(1709888355000L)
.name("logs")
.query("@type:view @view.url_path:/logs")
.to(1710493155000L)))
.journeys(
Collections.singletonList(
new RumSegmentJourney()
.conversionType("any")
.groupBy("@usr.id")
.name("my_journey")
.search("@type:view")))
.referenceTables(
Collections.singletonList(
new RumSegmentReferenceTable()
.columns(
Collections.singletonList(
new RumSegmentReferenceTableColumn()
.name("user_id")))
.filterQuery("")
.joinCondition(
new RumSegmentReferenceTableJoinCondition()
.columnName("user_id")
.facet("@usr.id"))
.name("my_ref_table")
.tableName("my_table")))
._static(
Collections.singletonList(
new RumSegmentStaticEntry()
.id("static-list-1")
.name("My Static List")
.userCount(500L)))
.templates(
Collections.singletonList(
new RumSegmentTemplateInstance()
.from(1709888355000L)
.parameters(
Map.ofEntries(Map.entry("threshold", "5")))
.templateId("stickiness-v1")
.to(1710493155000L))))
.description("Users who visited the homepage.")
.name("My Segment")
.tags(Collections.singletonList("team:frontend")))
.type(RumSegmentResourceType.SEGMENT));

try {
RumSegmentResponse result = apiInstance.createRumSegment(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#createRumSegment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
54 changes: 54 additions & 0 deletions examples/v2/rum-user-segments/CreateRumStaticSegment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Create a static RUM segment returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentResponse;
import com.datadog.api.client.v2.model.RumStaticSegmentCreateAttributes;
import com.datadog.api.client.v2.model.RumStaticSegmentCreateData;
import com.datadog.api.client.v2.model.RumStaticSegmentCreateRequest;
import com.datadog.api.client.v2.model.RumStaticSegmentJourneyFilter;
import com.datadog.api.client.v2.model.RumStaticSegmentJourneyNode;
import com.datadog.api.client.v2.model.RumStaticSegmentJourneyQueryObject;
import com.datadog.api.client.v2.model.RumStaticSegmentRequestType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createRumStaticSegment", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

RumStaticSegmentCreateRequest body =
new RumStaticSegmentCreateRequest()
.data(
new RumStaticSegmentCreateData()
.attributes(
new RumStaticSegmentCreateAttributes()
.description("Users from a specific journey.")
.journeyQueryObject(
new RumStaticSegmentJourneyQueryObject()
.nodes(
Collections.singletonList(
new RumStaticSegmentJourneyNode()
.filters(
Collections.singletonList(
new RumStaticSegmentJourneyFilter()
.attribute("@type")
.value("view"))))))
.name("My Static Segment")
.tags(Collections.singletonList("team:frontend")))
.type(RumStaticSegmentRequestType.CREATE_STATIC_SEGMENT_REQUEST));

try {
RumSegmentResponse result = apiInstance.createRumStaticSegment(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#createRumStaticSegment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
26 changes: 26 additions & 0 deletions examples/v2/rum-user-segments/DeleteRumSegment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Delete a RUM segment returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentDeleteResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteRumSegment", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

try {
RumSegmentDeleteResponse result =
apiInstance.deleteRumSegment("a1b2c3d4-1234-5678-9abc-123456789abc");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#deleteRumSegment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/rum-user-segments/GetRumSegment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Get a RUM segment returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.getRumSegment", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

try {
RumSegmentResponse result = apiInstance.getRumSegment("a1b2c3d4-1234-5678-9abc-123456789abc");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#getRumSegment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
23 changes: 23 additions & 0 deletions examples/v2/rum-user-segments/InitializeRumSegments.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Initialize RUM segments returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.initializeRumSegments", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

try {
apiInstance.initializeRumSegments();
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#initializeRumSegments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/rum-user-segments/ListRumSegmentTemplates.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// List RUM segment templates returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentTemplateListResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.listRumSegmentTemplates", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

try {
RumSegmentTemplateListResponse result = apiInstance.listRumSegmentTemplates();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#listRumSegmentTemplates");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/rum-user-segments/ListRumSegments.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// List all RUM segments returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentListResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.listRumSegments", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

try {
RumSegmentListResponse result = apiInstance.listRumSegments();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#listRumSegments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
95 changes: 95 additions & 0 deletions examples/v2/rum-user-segments/UpdateRumSegment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
// Update a RUM segment returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumUserSegmentsApi;
import com.datadog.api.client.v2.model.RumSegmentDataQuery;
import com.datadog.api.client.v2.model.RumSegmentEventPlatform;
import com.datadog.api.client.v2.model.RumSegmentJourney;
import com.datadog.api.client.v2.model.RumSegmentReferenceTable;
import com.datadog.api.client.v2.model.RumSegmentReferenceTableColumn;
import com.datadog.api.client.v2.model.RumSegmentReferenceTableJoinCondition;
import com.datadog.api.client.v2.model.RumSegmentResourceType;
import com.datadog.api.client.v2.model.RumSegmentStaticEntry;
import com.datadog.api.client.v2.model.RumSegmentTemplateInstance;
import com.datadog.api.client.v2.model.RumSegmentUpdateAttributes;
import com.datadog.api.client.v2.model.RumSegmentUpdateData;
import com.datadog.api.client.v2.model.RumSegmentUpdateRequest;
import java.util.Collections;
import java.util.Map;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateRumSegment", true);
RumUserSegmentsApi apiInstance = new RumUserSegmentsApi(defaultClient);

RumSegmentUpdateRequest body =
new RumSegmentUpdateRequest()
.data(
new RumSegmentUpdateData()
.attributes(
new RumSegmentUpdateAttributes()
.dataQuery(
new RumSegmentDataQuery()
.combination("(logs && apm_home) && NOT(apm_trace)")
.eventPlatforms(
Collections.singletonList(
new RumSegmentEventPlatform()
.facet("@usr.id")
.from(1709888355000L)
.name("logs")
.query("@type:view @view.url_path:/logs")
.to(1710493155000L)))
.journeys(
Collections.singletonList(
new RumSegmentJourney()
.conversionType("any")
.groupBy("@usr.id")
.name("my_journey")
.search("@type:view")))
.referenceTables(
Collections.singletonList(
new RumSegmentReferenceTable()
.columns(
Collections.singletonList(
new RumSegmentReferenceTableColumn()
.name("user_id")))
.filterQuery("")
.joinCondition(
new RumSegmentReferenceTableJoinCondition()
.columnName("user_id")
.facet("@usr.id"))
.name("my_ref_table")
.tableName("my_table")))
._static(
Collections.singletonList(
new RumSegmentStaticEntry()
.id("static-list-1")
.name("My Static List")
.userCount(500L)))
.templates(
Collections.singletonList(
new RumSegmentTemplateInstance()
.from(1709888355000L)
.parameters(
Map.ofEntries(Map.entry("threshold", "5")))
.templateId("stickiness-v1")
.to(1710493155000L))))
.description("Updated description.")
.name("Updated Segment Name")
.tags(Collections.singletonList("team:backend")))
.id("a1b2c3d4-1234-5678-9abc-123456789abc")
.type(RumSegmentResourceType.SEGMENT));

try {
apiInstance.updateRumSegment("a1b2c3d4-1234-5678-9abc-123456789abc", body);
} catch (ApiException e) {
System.err.println("Exception when calling RumUserSegmentsApi#updateRumSegment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
8 changes: 8 additions & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -920,6 +920,14 @@ public class ApiClient {
put("v2.queryEventFilteredUsers", false);
put("v2.queryUsers", false);
put("v2.updateConnection", false);
put("v2.createRumSegment", false);
put("v2.createRumStaticSegment", false);
put("v2.deleteRumSegment", false);
put("v2.getRumSegment", false);
put("v2.initializeRumSegments", false);
put("v2.listRumSegments", false);
put("v2.listRumSegmentTemplates", false);
put("v2.updateRumSegment", false);
put("v2.createScorecardOutcomesBatch", false);
put("v2.createScorecardRule", false);
put("v2.deleteScorecardRule", false);
Expand Down
Loading
Loading