GetDashboardWidgetImage

Prev Next

Available in Classic and VPC

Download the widget data on the dashboard as an 800 x 600 PNG file.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /cw_fea/real/cw/api/chart/dashboard/{dashboardId}/widgets/{widgetId}

Request headers

For information about the headers common to all Cloud Insight APIs, see Cloud Insight request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
dashboardId String Required Dashboard ID
widgetId String Required Widget ID

Request query parameters

The following describes the parameters.

Field Type Required Description
startTime Integer Required Measurement start date and time (millisecond)
  • Unix timestamp format
endTime Integer Required Measurement end date and time (millisecond)
  • Unix timestamp format
widgetResolutionMode String Optional Query cycle
  • AUTO (default) | HIGH
    • AUTO: Query at the same cycle as the dashboard
    • HIGH: Query details at a shorter cycle than the dashboard

Request example

The request example is as follows:

curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/chart/dashboard/**********/widgets/bucket_size__**********?startTime=1733097600000&endTime=1733148000000&widgetResolutionMode=AUTO' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response status codes

For response status codes common to NAVER Cloud Platform, see Cloud Insight API response status codes.

Response example

If the response is successful, the dashboard widget image file is downloaded with 200 OK.

image.png