For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ko/api/latest/widgets/search-widgets.md. A documentation index is available at /llms.txt.
homeHomedocs문서apiAPI
Language
Datadog site

위젯 검색

GEThttps://api.datadoghq.com/api/v2/widgets/{experience_type}https://api.us3.datadoghq.com/api/v2/widgets/{experience_type}https://api.us5.datadoghq.com/api/v2/widgets/{experience_type}https://api.datadoghq.eu/api/v2/widgets/{experience_type}https://api.ap1.datadoghq.com/api/v2/widgets/{experience_type}https://api.ap2.datadoghq.com/api/v2/widgets/{experience_type}https://api.uk1.datadoghq.com/api/v2/widgets/{experience_type}https://api.ddog-gov.com/api/v2/widgets/{experience_type}https://api.us2.ddog-gov.com/api/v2/widgets/{experience_type}

개요

필터링, 정렬 및 페이지 매김을 포함하여 특정 경험 유형에 대한 위젯을 검색하고 나열합니다.

응답 메타는 현재 필터로 범위가 지정된 합계를 포함합니다.

  • filtered_total — 필터와 일치하는 위젯.
  • created_by_you_total — 일치하는 항목 중 현재 사용자가 생성한 위젯 수
  • favorited_by_you_total — 일치하는 항목 중 현재 사용자가 즐겨찾기에 추가한 위젯 수.
  • created_by_anyone_total — 필터를 무시하고 해당 경험 유형의 전체 위젯 수.

반환된 각 위젯에는 현재 사용자의 즐겨찾기 상태를 반영하는 is_favorited가 포함됩니다. 즐겨찾기 설정 자체는 이 엔드포인트가 아닌 공유 즐겨찾기 API를 통해 수행됩니다.

This endpoint requires any of the following permissions:

  • cloud_cost_management_read
  • generate_log_reports
  • manage_log_reports
  • product_analytics_saved_widgets_read

인수

경로 파라미터

이름
유형
설명
experience_type [required]
enum

The experience type for the widget.

Allowed enum values: ccm_reports, logs_reports, csv_reports, product_analytics

쿼리 문자열

이름
유형
설명
filter[widgetType]
enum

Filter widgets by widget type.

Allowed enum values: bar_chart, change, cloud_cost_summary, cohort, funnel, geomap, list_stream, query_table, query_value, retention_curve
Show 5 moresankey, sunburst, timeseries, toplist, treemap
filter[creatorHandle]
string

Filter widgets by the email handle of the creator.

filter[isFavorited]
boolean

Filter to only widgets favorited by the current user.

filter[title]
string

Filter widgets by title (substring match).

filter[tags]
string

Filter widgets by tags. Format as bracket-delimited CSV, e.g. [tag1,tag2].

sort
string

Sort field for the results.

title, created_at, modified_at — both ascending and descending are supported. Use the bare field name for ascending (e.g. sort=title) or prefix with - for descending (e.g. sort=-modified_at).

is_favorited — returns favorites-first ordering (favorited widgets first, then the rest). Direction is fixed; the - prefix is ignored for this field.

Default: -modified_at
page[number]
integer

Page number for pagination (0-indexed).

Default: 0
page[size]
integer

Number of widgets per page.

Default: 50

응답

OK

Response containing a list of widgets.

항목
유형
설명
data [required]
[object]

List of widget resources.

included
[object]

Array of user resources related to the widgets.

meta
object

Metadata about the search results.

코드 예시

위젯 검색
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export experience_type="ccm_reports"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/widgets/${experience_type}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"