MENU
      Export dashboard data in Excel

        Export dashboard data in Excel


        Article summary

        Available in Classic and VPC

        View dashboard chart data using the product-related parameters of the dashboard, and download the results as an Excel file.

        Request

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

        MethodURI
        GET/dashboards/products/{product-id}/apis/{api-id}/stages/{stage-id}/export

        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
        api-idStringRequiredAPI ID created on the product
        stage-idStringRequiredStage ID created in the API

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionsList<String>OptionalRegion to download 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
      • Request example

        The following is a sample request.

        curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/apis/{api-id}/stages/{stage-id}/export
        ?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.

        "Download File"
        JSON

        Response status codes

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


        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.