Language

日本語 English Français 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

Trigger a Bits AI investigation

copy Image ページをコピーコピーしました

POST https://api.ap1.datadoghq.com/api/v2/bits-ai/investigationshttps://api.ap2.datadoghq.com/api/v2/bits-ai/investigationshttps://api.datadoghq.eu/api/v2/bits-ai/investigationshttps://api.ddog-gov.com/api/v2/bits-ai/investigationshttps://api.us2.ddog-gov.com/api/v2/bits-ai/investigationshttps://api.uk1.datadoghq.com/api/v2/bits-ai/investigationshttps://api.datadoghq.com/api/v2/bits-ai/investigationshttps://api.us3.datadoghq.com/api/v2/bits-ai/investigationshttps://api.us5.datadoghq.com/api/v2/bits-ai/investigations

概要

Trigger a Bits AI investigation from a monitor alert or a general investigation. This endpoint requires the bits_investigations_write permission. When the trigger type is monitor_alert_trigger, the monitors_read permission is also required. This endpoint requires the bits_investigations_write permission.

OAuth apps require the bits_investigations_write authorization scope to access this endpoint.

リクエスト

Body Data (required)

Trigger investigation request body.

Expand All

フィールド

タイプ

説明

data [required]

object

Data for the trigger investigation request.

attributes [required]

object

Attributes for the trigger investigation request.

trigger [required]

 <oneOf>

The trigger definition for starting an investigation.

<type=monitor_alert_trigger>

object

A trigger created from a monitor alert.

monitor_alert_trigger [required]

object

Attributes for a monitor alert trigger.

event_id [required]

string

The event ID associated with the monitor alert.

event_ts [required]

int64

The timestamp of the event in Unix milliseconds.

monitor_id [required]

int64

The monitor ID that triggered the alert.

type [required]

enum

The type of monitor alert trigger. Allowed enum values: monitor_alert_trigger

<type=general_investigation>

object

A trigger created from a general investigation request.

general_investigation [required]

 <oneOf>

Attributes for a general investigation, not tied to a specific monitor alert.

Object 1

object

Attributes for a general investigation without an explicit time window.

description [required]

string

A free-form description of what to investigate, up to 4,096 characters.

tags

[string]

Tags that scope the investigation.

Object 2

object

Attributes for a general investigation with an explicit time window.

description [required]

string

A free-form description of what to investigate, up to 4,096 characters.

end_time [required]

int64

The end of the investigation window, in Unix milliseconds.

start_time [required]

int64

The start of the investigation window, in Unix milliseconds.

tags

[string]

Tags that scope the investigation.

type [required]

enum

The type of general investigation trigger. Allowed enum values: general_investigation

type [required]

enum

The resource type for trigger investigation requests. Allowed enum values: trigger_investigation_request

{
  "data": {
    "attributes": {
      "trigger": {
        "monitor_alert_trigger": {
          "event_id": "1234567890123456789",
          "event_ts": 1700000000000,
          "monitor_id": 12345678
        },
        "type": "monitor_alert_trigger"
      }
    },
    "type": "trigger_investigation_request"
  }
}

応答

OK

Response after triggering an investigation.

Expand All

フィールド

タイプ

説明

data [required]

object

Data for the trigger investigation response.

attributes [required]

object

Attributes for the trigger investigation response.

investigation_id [required]

string

The ID of the investigation that was created.

id [required]

string

Unique identifier for the trigger response.

type [required]

enum

The resource type for trigger investigation responses. Allowed enum values: trigger_investigation_response

{
  "data": {
    "attributes": {
      "investigation_id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
    },
    "id": "f5e6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
    "type": "trigger_investigation_response"
  }
}

Bad Request

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[object]

A list of errors.

detail

string

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

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

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

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

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

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "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

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

コード例

                  ## default
# 

# 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/bits-ai/investigations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "trigger": {
        "monitor_alert_trigger": {
          "event_id": "1234567890123456789",
          "event_ts": 1700000000000,
          "monitor_id": 12345678
        },
        "type": "monitor_alert_trigger"
      }
    },
    "type": "trigger_investigation_request"
  }
}
EOF

## general_investigation
# 

# 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/bits-ai/investigations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "trigger": {
        "general_investigation": {
          "description": "Checkout latency has been elevated for the past hour.",
          "tags": [
            "service:checkout"
          ]
        },
        "type": "general_investigation"
      }
    },
    "type": "trigger_investigation_request"
  }
}
EOF


                
"""
Trigger a Bits AI investigation returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.bits_ai_api import BitsAIApi
from datadog_api_client.v2.model.monitor_alert_trigger_attributes import MonitorAlertTriggerAttributes
from datadog_api_client.v2.model.trigger_attributes import TriggerAttributes
from datadog_api_client.v2.model.trigger_investigation_request import TriggerInvestigationRequest
from datadog_api_client.v2.model.trigger_investigation_request_data import TriggerInvestigationRequestData
from datadog_api_client.v2.model.trigger_investigation_request_data_attributes import (
    TriggerInvestigationRequestDataAttributes,
)
from datadog_api_client.v2.model.trigger_investigation_request_type import TriggerInvestigationRequestType
from datadog_api_client.v2.model.trigger_type import TriggerType

body = TriggerInvestigationRequest(
    data=TriggerInvestigationRequestData(
        attributes=TriggerInvestigationRequestDataAttributes(
            trigger=TriggerAttributes(
                monitor_alert_trigger=MonitorAlertTriggerAttributes(
                    event_id="1234567890123456789",
                    event_ts=1700000000000,
                    monitor_id=12345678,
                ),
                type=TriggerType.MONITOR_ALERT_TRIGGER,
            ),
        ),
        type=TriggerInvestigationRequestType.TRIGGER_INVESTIGATION_REQUEST,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = BitsAIApi(api_client)
    response = api_instance.trigger_investigation(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"
# Trigger a Bits AI investigation returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::BitsAIAPI.new

body = DatadogAPIClient::V2::TriggerInvestigationRequest.new({
  data: DatadogAPIClient::V2::TriggerInvestigationRequestData.new({
    attributes: DatadogAPIClient::V2::TriggerInvestigationRequestDataAttributes.new({
      trigger: DatadogAPIClient::V2::TriggerAttributes.new({
        monitor_alert_trigger: DatadogAPIClient::V2::MonitorAlertTriggerAttributes.new({
          event_id: "1234567890123456789",
          event_ts: 1700000000000,
          monitor_id: 12345678,
        }),
        type: DatadogAPIClient::V2::TriggerType::MONITOR_ALERT_TRIGGER,
      }),
    }),
    type: DatadogAPIClient::V2::TriggerInvestigationRequestType::TRIGGER_INVESTIGATION_REQUEST,
  }),
})
p api_instance.trigger_investigation(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"
// Trigger a Bits AI investigation returns "OK" 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.TriggerInvestigationRequest{
		Data: datadogV2.TriggerInvestigationRequestData{
			Attributes: datadogV2.TriggerInvestigationRequestDataAttributes{
				Trigger: datadogV2.TriggerAttributes{
					MonitorAlertTrigger: &datadogV2.MonitorAlertTriggerAttributes{
						EventId:   "1234567890123456789",
						EventTs:   1700000000000,
						MonitorId: 12345678,
					},
					Type: datadogV2.TRIGGERTYPE_MONITOR_ALERT_TRIGGER.Ptr(),
				},
			},
			Type: datadogV2.TRIGGERINVESTIGATIONREQUESTTYPE_TRIGGER_INVESTIGATION_REQUEST,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewBitsAIApi(apiClient)
	resp, r, err := api.TriggerInvestigation(ctx, body)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `BitsAIApi.TriggerInvestigation`:\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"
// Trigger a Bits AI investigation returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.BitsAiApi;
import com.datadog.api.client.v2.model.MonitorAlertTriggerAttributes;
import com.datadog.api.client.v2.model.TriggerAttributes;
import com.datadog.api.client.v2.model.TriggerInvestigationRequest;
import com.datadog.api.client.v2.model.TriggerInvestigationRequestData;
import com.datadog.api.client.v2.model.TriggerInvestigationRequestDataAttributes;
import com.datadog.api.client.v2.model.TriggerInvestigationRequestType;
import com.datadog.api.client.v2.model.TriggerInvestigationResponse;
import com.datadog.api.client.v2.model.TriggerType;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    BitsAiApi apiInstance = new BitsAiApi(defaultClient);

    TriggerInvestigationRequest body =
        new TriggerInvestigationRequest()
            .data(
                new TriggerInvestigationRequestData()
                    .attributes(
                        new TriggerInvestigationRequestDataAttributes()
                            .trigger(
                                new TriggerAttributes()
                                    .monitorAlertTrigger(
                                        new MonitorAlertTriggerAttributes()
                                            .eventId("1234567890123456789")
                                            .eventTs(1700000000000L)
                                            .monitorId(12345678L))
                                    .type(TriggerType.MONITOR_ALERT_TRIGGER)))
                    .type(TriggerInvestigationRequestType.TRIGGER_INVESTIGATION_REQUEST));

    try {
      TriggerInvestigationResponse result = apiInstance.triggerInvestigation(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BitsAiApi#triggerInvestigation");
      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"
// Trigger a Bits AI investigation returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_bits_ai::BitsAIAPI;
use datadog_api_client::datadogV2::model::MonitorAlertTriggerAttributes;
use datadog_api_client::datadogV2::model::TriggerAttributes;
use datadog_api_client::datadogV2::model::TriggerInvestigationRequest;
use datadog_api_client::datadogV2::model::TriggerInvestigationRequestData;
use datadog_api_client::datadogV2::model::TriggerInvestigationRequestDataAttributes;
use datadog_api_client::datadogV2::model::TriggerInvestigationRequestType;
use datadog_api_client::datadogV2::model::TriggerType;

#[tokio::main]
async fn main() {
    let body = TriggerInvestigationRequest::new(TriggerInvestigationRequestData::new(
        TriggerInvestigationRequestDataAttributes::new(
            TriggerAttributes::new()
                .monitor_alert_trigger(MonitorAlertTriggerAttributes::new(
                    "1234567890123456789".to_string(),
                    1700000000000,
                    12345678,
                ))
                .type_(TriggerType::MONITOR_ALERT_TRIGGER),
        ),
        TriggerInvestigationRequestType::TRIGGER_INVESTIGATION_REQUEST,
    ));
    let configuration = datadog::Configuration::new();
    let api = BitsAIAPI::with_config(configuration);
    let resp = api.trigger_investigation(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="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Trigger a Bits AI investigation returns "OK" 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.triggerInvestigation"] = true;
const apiInstance = new v2.BitsAIApi(configuration);

const params: v2.BitsAIApiTriggerInvestigationRequest = {
  body: {
    data: {
      attributes: {
        trigger: {
          monitorAlertTrigger: {
            eventId: "1234567890123456789",
            eventTs: 1700000000000,
            monitorId: 12345678,
          },
          type: "monitor_alert_trigger",
        },
      },
      type: "trigger_investigation_request",
    },
  },
};

apiInstance
  .triggerInvestigation(params)
  .then((data: v2.TriggerInvestigationResponse) => {
    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"