Dashboard Product

Article Summary

Share feedback

Thanks for sharing your feedback!

Download DashBoard chart data

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/apis/{api-id}/stages/{stage-id}/export

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10
apiId	path	Y	String	Api Id Length(Min/Max): 0/10
stageId	path	Y	String	Stage Id Length(Min/Max): 0/10
regions	query string	N	List<String>	Regions collection item cannot be null
offset	query string	N	Long	Offset Min: 0 Max: 9,223,372,036,854,775,807
limit	query string	N	Long	Limit Min: 1 Max: 9,223,372,036,854,775,807
from	query string	Y	String	From Pattern: yyyy-MM-dd
to	query string	Y	String	To Pattern: yyyy-MM-dd
timeZone	query string	Y	String	Time Zone Pattern: +09:00

Request Body

None

Response Code

Response Body

"Download File"

Query api-ids by productId

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/api-ids

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10
regions	query string	N	List<String>	Regions collection item cannot be null
offset	query string	N	Long	Offset Min: 0 Max: 9,223,372,036,854,775,807
limit	query string	N	Long	Limit Min: 1 Max: 9,223,372,036,854,775,807
from	query string	Y	String	From Pattern: yyyy-MM-dd
to	query string	Y	String	To Pattern: yyyy-MM-dd
timeZone	query string	Y	String	Time Zone Pattern: +09:00
apiId	query string	N	String	Api Id

Request Body

None

Response Code

Response Body

{
  "apis" : {
    "total" : 0,
    "content" : [ {
      "apiName" : "apiName",
      "isDeleted" : true,
      "apiId" : "apiId"
    } ]
  }
}

Query chart data by productId or apiId

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/charts

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10
regions	query string	N	List<String>	Regions collection item cannot be null
offset	query string	N	Long	Offset Min: 0 Max: 9,223,372,036,854,775,807
limit	query string	N	Long	Limit Min: 1 Max: 9,223,372,036,854,775,807
from	query string	Y	String	From Pattern: yyyy-MM-dd
to	query string	Y	String	To Pattern: yyyy-MM-dd
timeZone	query string	Y	String	Time Zone Pattern: +09:00
apiId	query string	N	String	Api Id

Request Body

None

Response Code

Response Body

{
  "apis" : {
    "total" : 6,
    "content" : [ {
      "apiName" : "apiName",
      "isDeleted" : true,
      "stages" : [ {
        "stageName" : "stageName",
        "isDeleted" : true,
        "series" : [ {
          "data" : [ {
            "time" : "time",
            "value" : 0.8008282
          } ],
          "name" : "name",
          "region" : "region"
        } ],
        "stageId" : "stageId"
      } ],
      "apiId" : "apiId"
    } ]
  }
}

Query dashboard-products

URL

GET https://apigateway.apigw.ntruss.com/api/v1/dashboards/products

Request Parameter

Name	Position	Required	Type	Description
regions	query string	N	List<String>	Regions collection item cannot be null
offset	query string	N	Long	Offset Min: 0 Max: 9,223,372,036,854,775,807
limit	query string	N	Long	Limit Min: 1 Max: 9,223,372,036,854,775,807
from	query string	Y	String	From Pattern: yyyy-MM-dd
to	query string	Y	String	To Pattern: yyyy-MM-dd
timeZone	query string	Y	String	Time Zone Pattern: +09:00

Request Body

None

Response Code

Response Body

{
  "products" : [ {
    "isDeleted" : true,
    "productId" : "productId",
    "disabled" : true,
    "permission" : "permission",
    "productName" : "productName",
    "actionName" : "actionName"
  } ]
}

Was this article helpful?

What's Next

Document

Table of contents

Download DashBoard chart data
Query api-ids by productId
Query chart data by productId or apiId
Query dashboard-products