View product

Available in Classic and VPC

View the created product using the API key-related parameters in the dashboard.

Request

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

Method	URI
GET	/dashboards/api-keys/{api-key-id}/product-ids

Request headers

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

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`api-key-id`	String	Required	API key ID associated with the product

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`regions`	String	Optional	Region to view products for Items in a collection can't be null
`offset`	Long	Optional	Starting point in the list of data to view 0 - 9,223,372,036,854,775,807
`limit`	Long	Optional	Number of data to view at once 1 - 9,223,372,036,854,775,807
`from`	String	Required	Query start date (yyyy-MM-dd)
`to`	String	Required	Query end date (yyyy-MM-dd)
`timeZone`	String	Required	Time 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/api-keys/{api-key-id}/product-ids
?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}'

Response

The following describes the response format.

Response syntax

The syntax is as follows.

{
    "products": [
        {
            "productId": "productId",
            "productName": "productName",
            "deleted": false
        }
    ]
}

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.

{
    "products": [
        {
            "productId": "*****xn0bk",
            "productName": "product-***",
            "deleted": false
        }
    ]
}