지정된 경험 유형에 대한 새 위젯을 생성합니다.
This endpoint requires
any
of the following permissions:
cloud_cost_management_write
generate_log_reports
manage_log_reports
product_analytics_saved_widgets_write
인수
경로 파라미터
이름
유형
설명
experience_type [required]
string
The experience type for the widget.
요청
Body Data (required)
위젯 요청 본문입니다. definition 객체의 필수 필드는
widget.definition.type에 따라 다릅니다. 모든 유형에는 requests가 필요하며
일부 유형에는 추가 필드가 필요합니다(예: cloud_cost_summary에는
graph_options가, geomap에는 style 및 view가 필요함).
아래 예시는 ccm_reports 경험 유형에 대한 전체 cloud_cost_summary
페이로드를 보여줍니다.
The definition of a widget, including its type and configuration.
title [required]
string
The display title of the widget.
type [required]
enum
Widget types that are allowed to be stored as individual records.
This is not a complete list of dashboard and notebook widget types.
Allowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curveShow 5 more,sankey,sunburst,timeseries,toplist,treemap
ISO 8601 timestamp of when the widget was created.
definition [required]
object
The definition of a widget, including its type and configuration.
title [required]
string
The display title of the widget.
type [required]
enum
Widget types that are allowed to be stored as individual records.
This is not a complete list of dashboard and notebook widget types.
Allowed enum values: bar_chart,change,cloud_cost_summary,cohort,funnel,geomap,list_stream,query_table,query_value,retention_curveShow 5 more,sankey,sunburst,timeseries,toplist,treemap
is_favorited [required]
boolean
Whether the current user has favorited this widget. Populated on get,
batch_get, update, and search responses; create responses always return
false because a widget can only be favorited after it exists.
Favoriting itself is performed through the shared favorites API, not
this service.
modified_at [required]
string
ISO 8601 timestamp of when the widget was last modified.
## CCM cost summary widget
#
# Path parameters exportexperience_type="ccm_reports" # Use a Personal Access Token or Service Access Token exportDD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
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 widget returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]endapi_instance=DatadogAPIClient::V2::WidgetsAPI.newbody=DatadogAPIClient::V2::CreateOrUpdateWidgetRequest.new({data:DatadogAPIClient::V2::CreateOrUpdateWidgetRequestData.new({attributes:DatadogAPIClient::V2::CreateOrUpdateWidgetRequestAttributes.new({definition:DatadogAPIClient::V2::WidgetDefinition.new({title:"My Widget",type:DatadogAPIClient::V2::WidgetType::BAR_CHART,}),tags:[],}),type:"widgets",}),})papi_instance.create_widget(WidgetExperienceType::CCM_REPORTS,body)
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 widget returns "OK" responsepackagemainimport("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")funcmain(){body:=datadogV2.CreateOrUpdateWidgetRequest{Data:datadogV2.CreateOrUpdateWidgetRequestData{Attributes:datadogV2.CreateOrUpdateWidgetRequestAttributes{Definition:datadogV2.WidgetDefinition{Title:"My Widget",Type:datadogV2.WIDGETTYPE_BAR_CHART,},Tags:*datadog.NewNullableList(&[]string{}),},Type:"widgets",},}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.NewWidgetsApi(apiClient)resp,r,err:=api.CreateWidget(ctx,datadogV2.WIDGETEXPERIENCETYPE_CCM_REPORTS,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `WidgetsApi.CreateWidget`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `WidgetsApi.CreateWidget`:\n%s\n",responseContent)}
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 widget returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.WidgetsApi;importcom.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest;importcom.datadog.api.client.v2.model.CreateOrUpdateWidgetRequestAttributes;importcom.datadog.api.client.v2.model.CreateOrUpdateWidgetRequestData;importcom.datadog.api.client.v2.model.WidgetDefinition;importcom.datadog.api.client.v2.model.WidgetExperienceType;importcom.datadog.api.client.v2.model.WidgetResponse;importcom.datadog.api.client.v2.model.WidgetType;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));WidgetsApiapiInstance=newWidgetsApi(defaultClient);CreateOrUpdateWidgetRequestbody=newCreateOrUpdateWidgetRequest().data(newCreateOrUpdateWidgetRequestData().attributes(newCreateOrUpdateWidgetRequestAttributes().definition(newWidgetDefinition().title("My Widget").type(WidgetType.BAR_CHART))).type("widgets"));try{WidgetResponseresult=apiInstance.createWidget(WidgetExperienceType.CCM_REPORTS,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling WidgetsApi#createWidget");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
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 widget returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_widgets::WidgetsAPI;usedatadog_api_client::datadogV2::model::CreateOrUpdateWidgetRequest;usedatadog_api_client::datadogV2::model::CreateOrUpdateWidgetRequestAttributes;usedatadog_api_client::datadogV2::model::CreateOrUpdateWidgetRequestData;usedatadog_api_client::datadogV2::model::WidgetDefinition;usedatadog_api_client::datadogV2::model::WidgetExperienceType;usedatadog_api_client::datadogV2::model::WidgetType;#[tokio::main]asyncfnmain(){letbody=CreateOrUpdateWidgetRequest::new(CreateOrUpdateWidgetRequestData::new(CreateOrUpdateWidgetRequestAttributes::new(WidgetDefinition::new("My Widget".to_string(),WidgetType::BAR_CHART,)).tags(Some(vec![])),"widgets".to_string(),));letconfiguration=datadog::Configuration::new();letapi=WidgetsAPI::with_config(configuration);letresp=api.create_widget(WidgetExperienceType::CCM_REPORTS,body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
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
/**
* Create a widget returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});constapiInstance=newv2.WidgetsApi(configuration);constparams: v2.WidgetsApiCreateWidgetRequest={body:{data:{attributes:{definition:{title:"My Widget",type:"bar_chart",},tags:[],},type:"widgets",},},experienceType:"ccm_reports",};apiInstance.createWidget(params).then((data: v2.WidgetResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
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"
맞춤형 데모 요청
Datadog 시작하기
Ask AI
AI-generated responses may be inaccurate. Verify important info.