MENU
      View dashboard data

        View dashboard data


        Article summary

        Available in Classic and VPC

        View dashboard chart data using the product-related parameters in the dashboard.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET/dashboards/products/{product-id}/charts

        Request headers

        For headers common to API Gateway, see API Gateway common request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID associated with the API

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionsList<String>OptionalRegion to view dashboard chart data from
        • Items in a collection can't be null
        offsetLongOptionalStarting point in the list of data to view
        • 0 - 9,223,372,036,854,775,807
        limitLongOptionalNumber of data to view at once
        • 1 - 9,223,372,036,854,775,807
        fromStringRequiredQuery start date (yyyy-MM-dd)
        toStringRequiredQuery end date (yyyy-MM-dd)
        timeZoneStringRequiredTime zone (+09:00)
      • URL encoding is required when using the GET method
      • apiIdStringOptionalAPI ID created on the product

        Request example

        The following is a sample request.

        curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/charts
        ?from=2024-05-09
        &to=2024-05-09
        &timeZone=%2B09%3A00' \
        --header 'Content-Type: application/json' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The syntax is as follows.

        {
            "apis": {
                "content": [
                    {
                        "apiId": "apiId",
                        "apiName": "apiName",
                        "deleted": false,
                        "stages": [
                            {
                                "stageId": "stageId",
                                "stageName": "stageName",
                                "deleted": false,
                                "series": [
                                    {
                                        "name": "callCount",
                                        "region": "region",
                                        "data": [
                                            {
                                                "time": "2024-05-09",
                                                "value": 0.0
                                            }
                                        ]
                                    },
                                    {
                                        "name": "avgResponseTime",
                                        "region": "region",
                                        "data": [
                                            {
                                                "time": "2024-05-09",
                                                "value": 0.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "total": 0
            }
        }
        JSON

        Response status codes

        For response status codes common to API Gateway, see API Gateway response status codes.

        Response example

        The following is a sample response.

        {
            "apis": {
                "content": [
                    {
                        "apiId": "*****luwtk",
                        "apiName": "api",
                        "deleted": false,
                        "stages": [
                            {
                                "stageId": "*****7mhdv",
                                "stageName": "v1",
                                "deleted": false,
                                "series": [
                                    {
                                        "name": "callCount",
                                        "region": "KR",
                                        "data": [
                                            {
                                                "time": "2024-05-09",
                                                "value": 0.0
                                            }
                                        ]
                                    },
                                    {
                                        "name": "avgResponseTime",
                                        "region": "KR",
                                        "data": [
                                            {
                                                "time": "2024-05-09",
                                                "value": 0.0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "total": 1
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.