Create a RUM operation link

v2 (latest)

Note: This endpoint is in Preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/rum/operations/strong_linkshttps://api.ap2.datadoghq.com/api/v2/rum/operations/strong_linkshttps://api.datadoghq.eu/api/v2/rum/operations/strong_linkshttps://api.ddog-gov.com/api/v2/rum/operations/strong_linkshttps://api.us2.ddog-gov.com/api/v2/rum/operations/strong_linkshttps://api.uk1.datadoghq.com/api/v2/rum/operations/strong_linkshttps://api.datadoghq.com/api/v2/rum/operations/strong_linkshttps://api.us3.datadoghq.com/api/v2/rum/operations/strong_linkshttps://api.us5.datadoghq.com/api/v2/rum/operations/strong_links

Overview

Create a link between a RUM operation and a journey, confirming that the journey belongs to the operation. The operation can be identified by operation_id or operation_name; if operation_name does not match an existing operation, a stub operation is created.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

The data object for creating a RUM operation link.

{
  "data": {
    "attributes": {
      "application_id": "string",
      "description": "string",
      "feature_id": "journey-123",
      "operation_id": "abc12345-1234-5678-abcd-ef1234567890",
      "operation_name": "string",
      "status": "CONFIRMED",
      "tags": []
    },
    "type": "strong_links"
  }
}

Response

Created

The response for a single RUM operation link.

Expand All

Field

Type

Description

data [required]

object

The data object in a RUM operation link response.

{
  "data": {
    "attributes": {
      "created_at": "2019-09-19T10:00:00.000Z",
      "description": "string",
      "feature_id": "journey-123",
      "operation_id": "abc12345-1234-5678-abcd-ef1234567890",
      "status": "CONFIRMED",
      "tags": [],
      "updated_at": "2019-09-19T10:00:00.000Z"
    },
    "id": "abc12345-1234-5678-abcd-ef1234567890:journey-123",
    "type": "strong_links"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

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

Not Found. The referenced `operation_id` does not exist.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

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

Conflict. A link between this operation and journey already exists.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

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

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/operations/strong_links" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "feature_id": "journey-123"
    },
    "type": "strong_links"
  }
}
EOF

                

"""
Create a RUM operation strong link returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_operations_api import RUMOperationsApi
from datadog_api_client.v2.model.rum_operation_strong_link_create_request import RUMOperationStrongLinkCreateRequest
from datadog_api_client.v2.model.rum_operation_strong_link_create_request_attributes import (
    RUMOperationStrongLinkCreateRequestAttributes,
)
from datadog_api_client.v2.model.rum_operation_strong_link_create_request_data import (
    RUMOperationStrongLinkCreateRequestData,
)
from datadog_api_client.v2.model.rum_operation_strong_link_status import RUMOperationStrongLinkStatus
from datadog_api_client.v2.model.rum_operation_strong_link_type import RUMOperationStrongLinkType

body = RUMOperationStrongLinkCreateRequest(
    data=RUMOperationStrongLinkCreateRequestData(
        attributes=RUMOperationStrongLinkCreateRequestAttributes(
            description=None,
            feature_id="feature-123",
            operation_id="abc12345-1234-5678-abcd-ef1234567890",
            status=RUMOperationStrongLinkStatus.CONFIRMED,
            tags=[],
        ),
        type=RUMOperationStrongLinkType.STRONG_LINKS,
    ),
)

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

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"

# Create a RUM operation strong link returns "Created" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
  config.unstable_operations["v2.create_rum_operation_strong_link".to_sym] = true
end
api_instance = DatadogAPIClient::V2::RUMOperationsAPI.new

body = DatadogAPIClient::V2::RUMOperationStrongLinkCreateRequest.new({
  data: DatadogAPIClient::V2::RUMOperationStrongLinkCreateRequestData.new({
    attributes: DatadogAPIClient::V2::RUMOperationStrongLinkCreateRequestAttributes.new({
      description: nil,
      feature_id: "feature-123",
      operation_id: "abc12345-1234-5678-abcd-ef1234567890",
      status: DatadogAPIClient::V2::RUMOperationStrongLinkStatus::CONFIRMED,
      tags: [],
    }),
    type: DatadogAPIClient::V2::RUMOperationStrongLinkType::STRONG_LINKS,
  }),
})
p api_instance.create_rum_operation_strong_link(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"

// Create a RUM operation strong link returns "Created" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.RUMOperationStrongLinkCreateRequest{
		Data: datadogV2.RUMOperationStrongLinkCreateRequestData{
			Attributes: datadogV2.RUMOperationStrongLinkCreateRequestAttributes{
				Description: *datadog.NewNullableString(nil),
				FeatureId:   "feature-123",
				OperationId: datadog.PtrString("abc12345-1234-5678-abcd-ef1234567890"),
				Status:      datadogV2.RUMOPERATIONSTRONGLINKSTATUS_CONFIRMED.Ptr(),
				Tags:        []string{},
			},
			Type: datadogV2.RUMOPERATIONSTRONGLINKTYPE_STRONG_LINKS,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.CreateRUMOperationStrongLink", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewRUMOperationsApi(apiClient)
	resp, r, err := api.CreateRUMOperationStrongLink(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RUMOperationsApi.CreateRUMOperationStrongLink`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `RUMOperationsApi.CreateRUMOperationStrongLink`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"

// Create a RUM operation strong link returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumOperationsApi;
import com.datadog.api.client.v2.model.RUMOperationStrongLinkCreateRequest;
import com.datadog.api.client.v2.model.RUMOperationStrongLinkCreateRequestAttributes;
import com.datadog.api.client.v2.model.RUMOperationStrongLinkCreateRequestData;
import com.datadog.api.client.v2.model.RUMOperationStrongLinkResponse;
import com.datadog.api.client.v2.model.RUMOperationStrongLinkStatus;
import com.datadog.api.client.v2.model.RUMOperationStrongLinkType;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    defaultClient.setUnstableOperationEnabled("v2.createRUMOperationStrongLink", true);
    RumOperationsApi apiInstance = new RumOperationsApi(defaultClient);

    RUMOperationStrongLinkCreateRequest body =
        new RUMOperationStrongLinkCreateRequest()
            .data(
                new RUMOperationStrongLinkCreateRequestData()
                    .attributes(
                        new RUMOperationStrongLinkCreateRequestAttributes()
                            .description(null)
                            .featureId("feature-123")
                            .operationId("abc12345-1234-5678-abcd-ef1234567890")
                            .status(RUMOperationStrongLinkStatus.CONFIRMED))
                    .type(RUMOperationStrongLinkType.STRONG_LINKS));

    try {
      RUMOperationStrongLinkResponse result = apiInstance.createRUMOperationStrongLink(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RumOperationsApi#createRUMOperationStrongLink");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"

// Create a RUM operation strong link returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum_operations::RUMOperationsAPI;
use datadog_api_client::datadogV2::model::RUMOperationStrongLinkCreateRequest;
use datadog_api_client::datadogV2::model::RUMOperationStrongLinkCreateRequestAttributes;
use datadog_api_client::datadogV2::model::RUMOperationStrongLinkCreateRequestData;
use datadog_api_client::datadogV2::model::RUMOperationStrongLinkStatus;
use datadog_api_client::datadogV2::model::RUMOperationStrongLinkType;

#[tokio::main]
async fn main() {
    let body =
        RUMOperationStrongLinkCreateRequest::new(RUMOperationStrongLinkCreateRequestData::new(
            RUMOperationStrongLinkCreateRequestAttributes::new("feature-123".to_string())
                .description(None)
                .operation_id("abc12345-1234-5678-abcd-ef1234567890".to_string())
                .status(RUMOperationStrongLinkStatus::CONFIRMED)
                .tags(vec![]),
            RUMOperationStrongLinkType::STRONG_LINKS,
        ));
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.CreateRUMOperationStrongLink", true);
    let api = RUMOperationsAPI::with_config(configuration);
    let resp = api.create_rum_operation_strong_link(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run

/**
 * Create a RUM operation strong link returns "Created" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
configuration.unstableOperations["v2.createRUMOperationStrongLink"] = true;
const apiInstance = new v2.RUMOperationsApi(configuration);

const params: v2.RUMOperationsApiCreateRUMOperationStrongLinkRequest = {
  body: {
    data: {
      attributes: {
        description: undefined,
        featureId: "feature-123",
        operationId: "abc12345-1234-5678-abcd-ef1234567890",
        status: "CONFIRMED",
        tags: [],
      },
      type: "strong_links",
    },
  },
};

apiInstance
  .createRUMOperationStrongLink(params)
  .then((data: v2.RUMOperationStrongLinkResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"

Create a RUM operation link

Overview

Request

Body Data (required)

Response

Code Example

Create a RUM operation link

Create a RUM operation link

Instructions

Create a RUM operation link

Instructions

Create a RUM operation link

Instructions

Create a RUM operation link

Instructions

Create a RUM operation link

Instructions

Create a RUM operation link

Instructions

How can I help you today?