Cost
Anomaly History APIs
View abnormal cost detection history list
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
Abnormal Cost Analysis Type
account
Abnormal Cost AI/Manual Type
manual
POST /cost/v3/billing/anomaly/history/list HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"analyzeBy": "account",
"analyzeType": "manual"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View ai/manual abnormal cost detection daily grid data
Analyze Type
ai
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
History Seq
0
Anomaly Rule Seq
0
POST /cost/v3/billing/anomaly/history/detail/{analyzeType}/grid HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"histSeq": 0,
"ruleSeq": 0
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View abnormal cost detection notification sent history
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
History Seq
0
Anomaly Rule Seq
0
POST /cost/v3/billing/anomaly/history/detail/sent HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"histSeq": 0,
"ruleSeq": 0
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View abnormal cost detection history details and pie chart data
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
History Seq
0
Anomaly Rule Seq
0
POST /cost/v3/billing/anomaly/history/detail/result HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"histSeq": 0,
"ruleSeq": 0
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View manual abnormal cost detection history details and pie chart data inquiry
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
History Seq
0
Anomaly Rule Seq
0
POST /cost/v3/billing/anomaly/history/detail/manual/period-chart HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"histSeq": 0,
"ruleSeq": 0
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
Anomaly Overview APIs
View the trend of cost anomalies detected by AI.
Vendor
AWS
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
Sensitivity
M
Forecast Date
2024-06-02
POST /cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"sensitivity": "M",
"forecastDt": "2024-06-02"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the cost trend of cloud usage.
Vendor
AWS
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
List of vendors
Selected Vendors by Widget
["AWS"]
View Type
account
Component Type
dashboard_compare_cost_trend_widget
Widget Date Type
monthly
Widget Date Type (etc. monthly, weekly, daily)
monthly, weekly, daily
Time Frame
last_3_months
View By(account,product,region)
account
Filter Type(top_10_by_cost / custom)
top_10_by_cost
Selected Account Filter
000000000000
Selected Accounts Filter
Selected Items Filter
Selected Tag Key Filter
Name
Selected Service Group Set Filter
00000000-0000-0000-0000-000000000000
Widget Selected Currency
Sensitivity value for a specific widget
M
Analysis date
2024-06-02
POST /cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 765
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"vendors": [
"text"
],
"selectedVendorsByWidget": [
"AWS"
],
"viewType": "account",
"widgetType": "dashboard_compare_cost_trend_widget",
"dateType": "monthly",
"dataType": "monthly, weekly, daily",
"timeFrame": "last_3_months",
"viewBy": "account",
"filter": "top_10_by_cost",
"customFilter": [
{
"vendor": "text",
"item": "text"
}
],
"selectedAccount": "000000000000",
"selectedAccounts": [
"text"
],
"item": [
"text"
],
"selectedTagKey": "Name",
"selectedServiceGroupSet": "00000000-0000-0000-0000-000000000000",
"widgetCurrency": 1,
"sensitivity": "M",
"analyzedDt": "2024-06-02"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the usage data that may lead to ai-predicted anomalous costs
Vendor
AWS
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
Selected Vendors by Widget
["AWS","GCP"]
Sensitivity
M
Forecast Date
2024-09-23
POST /cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 318
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"selectedVendorsByWidget": [
"AWS",
"GCP"
],
"sensitivity": "M",
"forecastDate": "2024-09-23"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the number of triggered alerts and abnormal cost information by cloud vendor and type.
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
List of vendors
["AWS"]
POST /cost/v3/billing/anomaly/vendors/aggregate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"vendors": [
"AWS"
]
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the number of triggered alerts and abnormal cost information by cloud vendor and type.
Vendor
AWS
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
List of vendors
["AWS"]
POST /cost/v3/billing/anomaly/vendors/{vendor}/aggregate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"vendors": [
"AWS"
]
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
Anomaly Rules APIs
Create or update the setting of anomaly detection rule.
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
Anomaly Rule Seq
0
Anomaly Rule Name
Name
Abnormal Cost AI/Manual Type
manual
Abnormal Cost Analysis Type
account
Sensitivity
M
Threshold value
1
Threshold detection options(percentage/amount)
percentage
Alarm Setting Status(active/inactive)
inactive
Alarm Frequency(daily, weekly)
daily
Alarm Option(only, all)
only
Alarm recipients
Alarm Enabled
Y
Forecast Date
2024-06-02
Analysis date
2024-06-02
View By
account
PUT /cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 513
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"seq": 0,
"name": "Name",
"analyzeType": "manual",
"analyzeBy": "account",
"sensitivity": "M",
"thVal": 1,
"thOpt": "percentage",
"alertStatus": "inactive",
"alertFreq": "daily",
"alertOpt": "only",
"receivers": "text",
"useYn": "Y",
"forecastDt": "2024-06-02",
"analyzedDt": "2024-06-02",
"viewBy": "account"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the rules for detecting anomalies and sending alerts.
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
List of vendors
["AWS"]
POST /cost/v3/billing/anomaly/vendors/detections/alerts/rule HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"vendorList": [
"AWS"
]
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the specific rule for detecting anomalies and sending alerts.
Rule Seq
0
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
Anomaly Rule Seq
0
POST /cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"seq": 0
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
Cost Analytics APIs
View detailed portion chart data of cost analytics
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
AWS
2019-08-12
2023-02-01
2024-02-12
account
216093335544
216093335544
VisibleFields of detail grid
["vendor","linkedAccountId","productName","region","usage","cost","usageType"]
false
POST /cost/v3/billing/analytics/daily-portion HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2247
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"selectedVendor": "AWS",
"costDate": "2019-08-12",
"startDate": "2023-02-01",
"endDate": "2024-02-12",
"viewBy": "account",
"viewById": "text",
"viewByItem": "216093335544",
"itemViewId": "216093335544",
"filters": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"instanceType": [
"text"
],
"instanceTypeFamily": [
"text"
],
"chargeType": [
"text"
],
"os": [
"text"
],
"database": [
"text"
],
"transferType": [
"text"
],
"purchaseOption": [
"text"
],
"apiOperation": [
"text"
],
"resourceId": [
"text"
],
"usageType": [
"text"
],
"invoiceId": [
"text"
],
"itemDescription": [
"text"
],
"cacheEngine": [
"text"
],
"availabilityZone": [
"text"
],
"platform": [
"text"
]
},
"azure": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"subscriptionNm": [
"text"
],
"subscriptionId": [
"text"
],
"infraType": [
"text"
],
"mtCategory": [
"text"
],
"mtName": [
"text"
],
"usage": [
"text"
],
"unitPrice": [
"text"
],
"totalCost": [
"text"
]
},
"gcp": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"detailFilters": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"usageType": [
"text"
]
},
"visibleFields": [
"vendor",
"linkedAccountId",
"productName",
"region",
"usage",
"cost",
"usageType"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"isMonthly": false
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View detailed grid of cost analytics
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
AWS
2019-08-12
2023-02-01
2024-02-12
account
216093335544
216093335544
VisibleFields of detail grid
["vendor","linkedAccountId","productName","region","usage","cost","usageType"]
false
POST /cost/v3/billing/analytics/daily-cost HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2247
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"selectedVendor": "AWS",
"costDate": "2019-08-12",
"startDate": "2023-02-01",
"endDate": "2024-02-12",
"viewBy": "account",
"viewById": "text",
"viewByItem": "216093335544",
"itemViewId": "216093335544",
"filters": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"instanceType": [
"text"
],
"instanceTypeFamily": [
"text"
],
"chargeType": [
"text"
],
"os": [
"text"
],
"database": [
"text"
],
"transferType": [
"text"
],
"purchaseOption": [
"text"
],
"apiOperation": [
"text"
],
"resourceId": [
"text"
],
"usageType": [
"text"
],
"invoiceId": [
"text"
],
"itemDescription": [
"text"
],
"cacheEngine": [
"text"
],
"availabilityZone": [
"text"
],
"platform": [
"text"
]
},
"azure": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"subscriptionNm": [
"text"
],
"subscriptionId": [
"text"
],
"infraType": [
"text"
],
"mtCategory": [
"text"
],
"mtName": [
"text"
],
"usage": [
"text"
],
"unitPrice": [
"text"
],
"totalCost": [
"text"
]
},
"gcp": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"detailFilters": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"usageType": [
"text"
]
},
"visibleFields": [
"vendor",
"linkedAccountId",
"productName",
"region",
"usage",
"cost",
"usageType"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"isMonthly": false
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View summary of cost analytics
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
start date
2023-02-01
end date
2024-02-12
items per page
30
page number
1
user name
abcd
view by
account
selected vendors
["AWS"]
monthly
false
POST /cost/v3/billing/analytics/cost HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1950
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"startDate": "2023-02-01",
"endDate": "2024-02-12",
"itemsPerPage": 30,
"page": 1,
"userName": "abcd",
"viewBy": "account",
"selectedVendors": [
"AWS"
],
"filters": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"instanceType": [
"text"
],
"instanceTypeFamily": [
"text"
],
"chargeType": [
"text"
],
"os": [
"text"
],
"database": [
"text"
],
"transferType": [
"text"
],
"purchaseOption": [
"text"
],
"apiOperation": [
"text"
],
"resourceId": [
"text"
],
"usageType": [
"text"
],
"invoiceId": [
"text"
],
"itemDescription": [
"text"
],
"cacheEngine": [
"text"
],
"availabilityZone": [
"text"
],
"platform": [
"text"
]
},
"azure": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"subscriptionNm": [
"text"
],
"subscriptionId": [
"text"
],
"infraType": [
"text"
],
"mtCategory": [
"text"
],
"mtName": [
"text"
],
"usage": [
"text"
],
"unitPrice": [
"text"
],
"totalCost": [
"text"
]
},
"gcp": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"isMonthly": false
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
Cost Analytics Filters APIs
View Cost Analytics filter
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
Cost Analytics inquiry start date
2024-09-01
Cost Analytics inquiry end date
2024-09-30
View By
account
Filter query category
platform
Selected Key
test
Search Text
test
selected vendors
["AWS"]
POST /cost/v3/billing/analytics/related HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1950
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"conditions": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"instanceType": [
"text"
],
"instanceTypeFamily": [
"text"
],
"chargeType": [
"text"
],
"os": [
"text"
],
"database": [
"text"
],
"transferType": [
"text"
],
"purchaseOption": [
"text"
],
"apiOperation": [
"text"
],
"resourceId": [
"text"
],
"usageType": [
"text"
],
"invoiceId": [
"text"
],
"itemDescription": [
"text"
],
"cacheEngine": [
"text"
],
"availabilityZone": [
"text"
],
"platform": [
"text"
]
},
"azure": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"subscriptionNm": [
"text"
],
"subscriptionId": [
"text"
],
"infraType": [
"text"
],
"mtCategory": [
"text"
],
"mtName": [
"text"
],
"usage": [
"text"
],
"unitPrice": [
"text"
],
"totalCost": [
"text"
]
},
"gcp": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"startDate": "2024-09-01",
"endDate": "2024-09-30",
"viewBy": "account",
"field": "platform",
"selectedKey": "test",
"searchText": "test",
"selectedVendors": [
"AWS"
]
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View Cost Analytics filter
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
Cost Analytics inquiry start date
2024-09-01
Cost Analytics inquiry end date
2024-09-30
View By
account
Filter query category
platform
Selected Key
test
Search Text
test
selected vendors
["AWS"]
POST /cost/v3/billing/analytics/filter HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1950
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"conditions": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"instanceType": [
"text"
],
"instanceTypeFamily": [
"text"
],
"chargeType": [
"text"
],
"os": [
"text"
],
"database": [
"text"
],
"transferType": [
"text"
],
"purchaseOption": [
"text"
],
"apiOperation": [
"text"
],
"resourceId": [
"text"
],
"usageType": [
"text"
],
"invoiceId": [
"text"
],
"itemDescription": [
"text"
],
"cacheEngine": [
"text"
],
"availabilityZone": [
"text"
],
"platform": [
"text"
]
},
"azure": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"subscriptionNm": [
"text"
],
"subscriptionId": [
"text"
],
"infraType": [
"text"
],
"mtCategory": [
"text"
],
"mtName": [
"text"
],
"usage": [
"text"
],
"unitPrice": [
"text"
],
"totalCost": [
"text"
]
},
"gcp": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"startDate": "2024-09-01",
"endDate": "2024-09-30",
"viewBy": "account",
"field": "platform",
"selectedKey": "test",
"searchText": "test",
"selectedVendors": [
"AWS"
]
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View Category of cost analytics
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
Cost Analytics inquiry start date
2024-09-01
Cost Analytics inquiry end date
2024-09-30
View By
account
Filter query category
platform
Selected Key
test
Search Text
test
selected vendors
["AWS"]
POST /cost/v3/billing/analytics/filter/category HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1950
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"conditions": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"instanceType": [
"text"
],
"instanceTypeFamily": [
"text"
],
"chargeType": [
"text"
],
"os": [
"text"
],
"database": [
"text"
],
"transferType": [
"text"
],
"purchaseOption": [
"text"
],
"apiOperation": [
"text"
],
"resourceId": [
"text"
],
"usageType": [
"text"
],
"invoiceId": [
"text"
],
"itemDescription": [
"text"
],
"cacheEngine": [
"text"
],
"availabilityZone": [
"text"
],
"platform": [
"text"
]
},
"azure": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
],
"subscriptionNm": [
"text"
],
"subscriptionId": [
"text"
],
"infraType": [
"text"
],
"mtCategory": [
"text"
],
"mtName": [
"text"
],
"usage": [
"text"
],
"unitPrice": [
"text"
],
"totalCost": [
"text"
]
},
"gcp": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"startDate": "2024-09-01",
"endDate": "2024-09-30",
"viewBy": "account",
"field": "platform",
"selectedKey": "test",
"searchText": "test",
"selectedVendors": [
"AWS"
]
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
Overview APIs
View cloud costs from the previous period and the estimated costs for the current month.
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
selected Vendor
AWS
The last date to include in the data range (inclusive). If not provided, defaults to the UTC current date.
POST /cost/v3/billing/overview/spend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"selectedVendor": "AWS",
"endDate": "text"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View the latest cloud costs collection date of each vendor.
company id
123e4567-e89b-12d3-a456-426614174000
company name
ex-company-rname
default vendor
AWS
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
user name
ex-user-name
vendor
AWS
POST /cost/v3/billing/overview/companyMaxDate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
View cloud accounts and status from specific vendor
company id
123e4567-e89b-12d3-a456-426614174000
user id
390df5f7-8852-40af-bc12-57a318cb9dc3
vendor
AWS
POST /cost/v3/billing/overview/accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"vendor": "AWS"
}
OK
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}
Last updated
Was this helpful?