Updates to Metrics, Asset, and Perspectives API

* Fixed incorrectly specified endpoint for Metrics API * Added clarification on `per_page` parameter * Added example for posting a Dynamic Group to an existing Perspective * Fixed broken link to topic for getting your External ID
CloudHealth · Jul 8, 2019 · 31fda60 · 31fda60
1 parent f494358
commit 31fda60
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 5 deletions.
diff --git a/_account/aws-account-add.md b/_account/aws-account-add.md
@@ -26,7 +26,7 @@ parameters:
         content: Role ARN for IAM Role
       - name: assume_role_external_id
         required: yes, for IAM-Role-based authentication
-        content: External ID generated by CloudHealth. See [How to get External ID](#accountexternal-id-get).
+        content: External ID generated by CloudHealth. See [How to get External ID](#account_get-external-id).
   - name: billing
     required: no
     content: JSON field that specifies the location of the AWS Detailed Billing Record (DBR).

diff --git a/_account/aws-account-read-multiple.md b/_account/aws-account-read-multiple.md
@@ -10,7 +10,7 @@ parameters:
   - name: page
     content: Specify the page number for results
   - name: per_page
-    content: Specify how many results should be displayed per page. Default value is 30.
+    content: Specify how many results should be displayed per page. Default value is 30. Maximum value is 100.
 right_code_blocks:
   - code_block: |-
       curl --request GET -H 'Authorization: Bearer <your_api_key>' -H 'Content-Type: application/json' "https://chapi.cloudhealthtech.com/v1/aws_accounts"

diff --git a/_metrics/get-metrics-for-an-asset.md b/_metrics/get-metrics-for-an-asset.md
@@ -3,7 +3,7 @@ title: Metrics for Single Asset
 type: get
 description: Retrieve CPU, memory, and performance metrics for a specific asset
 position: 4
-endpoint: https://chapi.cloudhealthtech.com/v1/metrics
+endpoint: https://chapi.cloudhealthtech.com/metrics/v1
 parameters:
   - name: asset
     required: yes

diff --git a/_metrics/post-metrics-for-an-asset.md b/_metrics/post-metrics-for-an-asset.md
@@ -3,7 +3,7 @@ title: Upload Metrics for Single Asset
 type: post
 description: Post metrics for an individual asset, including historical metrics data.
 position: 5
-endpoint: https://chapi.cloudhealthtech.com/v1/metrics
+endpoint: https://chapi.cloudhealthtech.com/metrics/v1
 parameters:
   - name: JSON document
     required: yes

diff --git a/_perspectives/add-dynamic-group.md b/_perspectives/add-dynamic-group.md
@@ -0,0 +1,12 @@
+---
+title: Add Dynamic Group to Perspective
+type: example
+description: Add a dynamic group to an existing Perspective. You can exclude the `ref_id` field from the request. Alternately, if you include the `ref_id` field, specify an arbitrary numerical value for it.
+position: 9
+right_code_blocks:
+  - code_block: |-
+      curl -s -H 'Authorization: Bearer <your_api_key>' -H 'Accept: application/json'
+        "https://chapi.cloudhealthtech.com/v1/perspective_schemas/<perspective_id> -d '{"type": "categorize","asset": "AwsAsset","tag_field": ["Environment"],"ref_id": "123456789","name": "Environment"}'
+    title: Request
+    language: bash
+---
diff --git a/_perspectives/create-perspective-schema.md b/_perspectives/create-perspective-schema.md
@@ -1,7 +1,7 @@
 ---
 title: Create Perspective Schema
 position: 6
-description: Create a schema and associate it with a specific Perspective. Identify the specific Perspective by its ID. See [How to Get Perspective ID](#perspectives_how-to-get-perspective-id).
+description: Create a Perspective and associate it with a new schema. The ID of the new Perspective is returned in the message field in the POST response.
 type: post
 endpoint: https://chapi.cloudhealthtech.com/v1/perspective_schemas/
 parameters: