Cost

Anomaly History APIs

Anomaly detection history

View abnormal cost detection history list

post

/v3/billing/anomaly/history/list

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

analyzeByanalyze byrequired

Abnormal Cost Analysis Type

Example: account

analyzeTypeanalyze typerequired

Abnormal Cost AI/Manual Type

Example: manual

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/history/list' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","analyzeBy":"account","analyzeType":"manual"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Anomaly detection history detailed total daily grid list

View ai/manual abnormal cost detection daily grid data

post

/v3/billing/anomaly/history/detail/{analyzeType}/grid

Authorizations

Path parameters

analyzeTypestringrequired

Analyze Type

Example: ai

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

histSeqHistory Seqrequired

History Seq

Example: 0

ruleSeqAnomaly Rule Seqrequired

Anomaly Rule Seq

Example: 0

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/{analyzeType}/grid' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","histSeq":0,"ruleSeq":0}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Anomaly detection history detailed notification result

View abnormal cost detection notification sent history

post

/v3/billing/anomaly/history/detail/sent

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

histSeqHistory Seqrequired

History Seq

Example: 0

ruleSeqAnomaly Rule Seqrequired

Anomaly Rule Seq

Example: 0

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/sent' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","histSeq":0,"ruleSeq":0}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Anomaly detection history detail result and period chart

View abnormal cost detection history details and pie chart data

post

/v3/billing/anomaly/history/detail/result

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

histSeqHistory Seqrequired

History Seq

Example: 0

ruleSeqAnomaly Rule Seqrequired

Anomaly Rule Seq

Example: 0

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/result' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","histSeq":0,"ruleSeq":0}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Manual anomaly detection history detail result and period chart

View manual abnormal cost detection history details and pie chart data inquiry

post

/v3/billing/anomaly/history/detail/manual/period-chart

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

histSeqHistory Seqrequired

History Seq

Example: 0

ruleSeqAnomaly Rule Seqrequired

Anomaly Rule Seq

Example: 0

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/manual/period-chart' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","histSeq":0,"ruleSeq":0}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Anomaly Overview APIs

Trend of anomaly detection by AI

View the trend of cost anomalies detected by AI.

post

/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend

Authorizations

Path parameters

vendorstringrequired

Vendor

Example: AWS

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendorrequired

vendor

Example: AWS

sensitivitySensitivityrequired

Sensitivity

Example: M

forecastDtForecast Date

Forecast Date

Example: 2024-06-02

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS","sensitivity":"M","forecastDt":"2024-06-02"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Cost trend of cloud usage

View the cost trend of cloud usage.

post

/v3/billing/anomaly/vendors/{vendor}/dashboard/trend

Authorizations

Path parameters

vendorstringrequired

Vendor

Example: AWS

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

viewTypeView Typerequired

View Type

Example: account

widgetTypeComponent Typerequired

Component Type

Example: dashboard_compare_cost_trend_widget

dateTypeWidget Date Type

Widget Date Type

Example: monthly

dataTypeWidget Date Type ( Opsnow Console > Cost widget > dataType key value)

Widget Date Type (etc. monthly, weekly, daily)

Example: monthly, weekly, daily

timeFrameTime Framerequired

Time Frame

Example: last_3_months

viewByView Byrequired

View By(account,product,region)

Example: account

filterFilter Type

Filter Type(top_10_by_cost / custom)

Example: top_10_by_cost

selectedAccountSelected Account Filter

Selected Account Filter

Example: 000000000000

selectedTagKeySelected Tag Key Filter

Selected Tag Key Filter

Example: Name

selectedServiceGroupSetSelected Service Group Set Filter

Selected Service Group Set Filter

Example: 00000000-0000-0000-0000-000000000000

widgetCurrencyWidget Selected Currency

Widget Selected Currency

sensitivitySensitivity value for a specific widget

Sensitivity value for a specific widget

Example: M

analyzedDtAnalysis date

Analysis date

Example: 2024-06-02

vendorsList of vendors

List of vendors

selectedVendorsByWidgetSelected Vendors by Widgetrequired

Selected Vendors by Widget

Example: ["AWS"]

customFilterCustom Filter

Custom Filter

selectedAccountsSelected Accounts Filter

Selected Accounts Filter

itemSelected Items Filter

Selected Items Filter

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"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","selectedAccount":"000000000000","selectedTagKey":"Name","selectedServiceGroupSet":"00000000-0000-0000-0000-000000000000","sensitivity":"M","analyzedDt":"2024-06-02","vendors":[null],"selectedVendorsByWidget":["AWS"],"customFilter":[{}],"selectedAccounts":[null],"item":[null]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Potential anomalous usage data detected by AI

View the usage data that may lead to ai-predicted anomalous costs

post

/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause

Authorizations

Path parameters

vendorstringrequired

Vendor

Example: AWS

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

sensitivitySensitivityrequired

Sensitivity

Example: M

forecastDateForecast Daterequired

Forecast Date

Example: 2024-09-23

selectedVendorsByWidgetSelected Vendors by Widgetrequired

Selected Vendors by Widget

Example: ["AWS","GCP"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS","sensitivity":"M","forecastDate":"2024-09-23","selectedVendorsByWidget":["AWS","GCP"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Summary of detected anomalies

View the number of triggered alerts and abnormal cost information by cloud vendor and type.

post

/v3/billing/anomaly/vendors/aggregate

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

vendorsList of vendorsrequired

List of vendors

Example: ["AWS"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/aggregate' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","vendors":["AWS"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Summary of detected anomalies

View the number of triggered alerts and abnormal cost information by cloud vendor and type.

post

/v3/billing/anomaly/vendors/{vendor}/aggregate

Authorizations

Path parameters

vendorstringrequired

Vendor

Example: AWS

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

vendorsList of vendorsrequired

List of vendors

Example: ["AWS"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/aggregate' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","vendors":["AWS"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Anomaly Rules APIs

Create/Update an anomaly detection rule setting

Create or update the setting of anomaly detection rule.

put

/v3/billing/anomaly/vendors/detections/alerts/rule/setting

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

seqAnomaly Rule Seq

Anomaly Rule Seq

Example: 0

nameAnomaly Rule Name

Anomaly Rule Name

Example: Name

analyzeTypeAnalyze Typerequired

Abnormal Cost AI/Manual Type

Example: manual

analyzeByAnalyze Byrequired

Abnormal Cost Analysis Type

Example: account

sensitivitySensitivityrequired

Sensitivity

Example: M

thValThreshold value

Threshold value

Example: 1

thOptThreshold detection options

Threshold detection options(percentage/amount)

Example: percentage

alertStatusAlarm Setting Status

Alarm Setting Status(active/inactive)

Example: inactive

alertFreqAlarm Frequency

Alarm Frequency(daily, weekly)

Example: daily

alertOptAlarm Option

Alarm Option(only, all)

Example: only

receiversAlarm recipients

Alarm recipients

useYnAlarm Enabled

Alarm Enabled

Example: Y

forecastDtForecast Date

Forecast Date

Example: 2024-06-02

analyzedDtAnalysis date

Analysis date

Example: 2024-06-02

viewByView By

View By

Example: account

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS","seq":0,"name":"Name","analyzeType":"manual","analyzeBy":"account","sensitivity":"M","thVal":1,"thOpt":"percentage","alertStatus":"inactive","alertFreq":"daily","alertOpt":"only","useYn":"Y","forecastDt":"2024-06-02","analyzedDt":"2024-06-02","viewBy":"account"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Anomaly detection rules

View the rules for detecting anomalies and sending alerts.

post

/v3/billing/anomaly/vendors/detections/alerts/rule

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Specific anomaly detection rule

View the specific rule for detecting anomalies and sending alerts.

post

/v3/billing/anomaly/vendors/detections/alerts/rule/{seq}

Authorizations

Path parameters

seqinteger · int32required

Rule Seq

Example: 0

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

seqAnomaly Rule Seq

Anomaly Rule Seq

Example: 0

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS","seq":0}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Cost Analytics APIs

Detail of cost analytics

View detailed portion chart data of cost analytics

post

/v3/billing/analytics/daily-portion

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

selectedVendorselected vendorrequired

Example: AWS

costDatecost daterequired

Example: 2019-08-12

startDatestart daterequired

Example: 2023-02-01

endDateend daterequired

Example: 2024-02-12

viewByview byrequired

Example: account

viewByIdviewById

viewByItemviewByItemrequired

Example: 216093335544

itemViewIditemViewIdrequired

Example: 216093335544

filtersCost Analytics Filtersrequired

Cost Analytics Filters

detailFiltersDetail Filtersrequired

Detail Filters

isMonthlymonthlyrequired

Example: false

visibleFieldsVisibleFields of detail gridrequired

VisibleFields of detail grid

Example: ["vendor","linkedAccountId","productName","region","usage","cost","usageType"]

tagsTags Filter

Tags Filter

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/analytics/daily-portion' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","selectedVendor":"AWS","costDate":"2019-08-12","startDate":"2023-02-01","endDate":"2024-02-12","viewBy":"account","viewByItem":"216093335544","itemViewId":"216093335544","filters":{"aws":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"instanceType":[null],"instanceTypeFamily":[null],"chargeType":[null],"os":[null],"database":[null],"transferType":[null],"purchaseOption":[null],"apiOperation":[null],"resourceId":[null],"usageType":[null],"invoiceId":[null],"itemDescription":[null],"cacheEngine":[null],"availabilityZone":[null],"platform":[null]},"azure":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"subscriptionNm":[null],"subscriptionId":[null],"infraType":[null],"mtCategory":[null],"mtName":[null],"usage":[null],"unitPrice":[null],"totalCost":[null]},"gcp":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}]}},"detailFilters":{"linkedAccountId":[null],"productCode":[null],"region":[null],"usageType":[null]},"isMonthly":false,"visibleFields":["vendor","linkedAccountId","productName","region","usage","cost","usageType"],"tags":[{}]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Detail of cost analytics

View detailed grid of cost analytics

post

/v3/billing/analytics/daily-cost

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

selectedVendorselected vendorrequired

Example: AWS

costDatecost daterequired

Example: 2019-08-12

startDatestart daterequired

Example: 2023-02-01

endDateend daterequired

Example: 2024-02-12

viewByview byrequired

Example: account

viewByIdviewById

viewByItemviewByItemrequired

Example: 216093335544

itemViewIditemViewIdrequired

Example: 216093335544

filtersCost Analytics Filtersrequired

Cost Analytics Filters

detailFiltersDetail Filtersrequired

Detail Filters

isMonthlymonthlyrequired

Example: false

visibleFieldsVisibleFields of detail gridrequired

VisibleFields of detail grid

Example: ["vendor","linkedAccountId","productName","region","usage","cost","usageType"]

tagsTags Filter

Tags Filter

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/analytics/daily-cost' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","selectedVendor":"AWS","costDate":"2019-08-12","startDate":"2023-02-01","endDate":"2024-02-12","viewBy":"account","viewByItem":"216093335544","itemViewId":"216093335544","filters":{"aws":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"instanceType":[null],"instanceTypeFamily":[null],"chargeType":[null],"os":[null],"database":[null],"transferType":[null],"purchaseOption":[null],"apiOperation":[null],"resourceId":[null],"usageType":[null],"invoiceId":[null],"itemDescription":[null],"cacheEngine":[null],"availabilityZone":[null],"platform":[null]},"azure":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"subscriptionNm":[null],"subscriptionId":[null],"infraType":[null],"mtCategory":[null],"mtName":[null],"usage":[null],"unitPrice":[null],"totalCost":[null]},"gcp":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}]}},"detailFilters":{"linkedAccountId":[null],"productCode":[null],"region":[null],"usageType":[null]},"isMonthly":false,"visibleFields":["vendor","linkedAccountId","productName","region","usage","cost","usageType"],"tags":[{}]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Summary of cost analytics

View summary of cost analytics

post

/v3/billing/analytics/cost

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

startDatestart daterequired

start date

Example: 2023-02-01

endDateend daterequired

end date

Example: 2024-02-12

itemsPerPageitems per pagerequired

items per page

Example: 30

pagepage numberrequired

page number

Example: 1

userNameuser name

user name

Example: abcd

viewByview byrequired

view by

Example: account

filtersCost Analytics Filtersrequired

Cost Analytics Filters

isMonthlymonthlyrequired

monthly

Example: false

selectedVendorsselected vendorsrequired

selected vendors

Example: ["AWS"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/analytics/cost' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","startDate":"2023-02-01","endDate":"2024-02-12","itemsPerPage":30,"page":1,"userName":"abcd","viewBy":"account","filters":{"aws":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"instanceType":[null],"instanceTypeFamily":[null],"chargeType":[null],"os":[null],"database":[null],"transferType":[null],"purchaseOption":[null],"apiOperation":[null],"resourceId":[null],"usageType":[null],"invoiceId":[null],"itemDescription":[null],"cacheEngine":[null],"availabilityZone":[null],"platform":[null]},"azure":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"subscriptionNm":[null],"subscriptionId":[null],"infraType":[null],"mtCategory":[null],"mtName":[null],"usage":[null],"unitPrice":[null],"totalCost":[null]},"gcp":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}]}},"isMonthly":false,"selectedVendors":["AWS"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Cost Analytics Filters APIs

Filter of Cost Analytics

View Cost Analytics filter

post

/v3/billing/analytics/related

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

conditionsCost Analytics Filtersrequired

Cost Analytics Filters

startDateCost Analytics inquiry start daterequired

Cost Analytics inquiry start date

Example: 2024-09-01

endDateCost Analytics inquiry end daterequired

Cost Analytics inquiry end date

Example: 2024-09-30

viewByView By

View By

Example: account

fieldFilter query category

Filter query category

Example: platform

selectedKeySelected Key

Selected Key

Example: test

searchTextSearch Text

Search Text

Example: test

selectedVendorsselected vendorsrequired

selected vendors

Example: ["AWS"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/analytics/related' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","conditions":{"aws":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"instanceType":[null],"instanceTypeFamily":[null],"chargeType":[null],"os":[null],"database":[null],"transferType":[null],"purchaseOption":[null],"apiOperation":[null],"resourceId":[null],"usageType":[null],"invoiceId":[null],"itemDescription":[null],"cacheEngine":[null],"availabilityZone":[null],"platform":[null]},"azure":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"subscriptionNm":[null],"subscriptionId":[null],"infraType":[null],"mtCategory":[null],"mtName":[null],"usage":[null],"unitPrice":[null],"totalCost":[null]},"gcp":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}]}},"startDate":"2024-09-01","endDate":"2024-09-30","viewBy":"account","field":"platform","selectedKey":"test","searchText":"test","selectedVendors":["AWS"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Filter of Cost Analytics

View Cost Analytics filter

post

/v3/billing/analytics/filter

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

conditionsCost Analytics Filtersrequired

Cost Analytics Filters

startDateCost Analytics inquiry start daterequired

Cost Analytics inquiry start date

Example: 2024-09-01

endDateCost Analytics inquiry end daterequired

Cost Analytics inquiry end date

Example: 2024-09-30

viewByView By

View By

Example: account

fieldFilter query category

Filter query category

Example: platform

selectedKeySelected Key

Selected Key

Example: test

searchTextSearch Text

Search Text

Example: test

selectedVendorsselected vendorsrequired

selected vendors

Example: ["AWS"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/analytics/filter' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","conditions":{"aws":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"instanceType":[null],"instanceTypeFamily":[null],"chargeType":[null],"os":[null],"database":[null],"transferType":[null],"purchaseOption":[null],"apiOperation":[null],"resourceId":[null],"usageType":[null],"invoiceId":[null],"itemDescription":[null],"cacheEngine":[null],"availabilityZone":[null],"platform":[null]},"azure":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"subscriptionNm":[null],"subscriptionId":[null],"infraType":[null],"mtCategory":[null],"mtName":[null],"usage":[null],"unitPrice":[null],"totalCost":[null]},"gcp":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}]}},"startDate":"2024-09-01","endDate":"2024-09-30","viewBy":"account","field":"platform","selectedKey":"test","searchText":"test","selectedVendors":["AWS"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Category of cost analytics

View Category of cost analytics

post

/v3/billing/analytics/filter/category

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

conditionsCost Analytics Filtersrequired

Cost Analytics Filters

startDateCost Analytics inquiry start daterequired

Cost Analytics inquiry start date

Example: 2024-09-01

endDateCost Analytics inquiry end daterequired

Cost Analytics inquiry end date

Example: 2024-09-30

viewByView By

View By

Example: account

fieldFilter query category

Filter query category

Example: platform

selectedKeySelected Key

Selected Key

Example: test

searchTextSearch Text

Search Text

Example: test

selectedVendorsselected vendorsrequired

selected vendors

Example: ["AWS"]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/analytics/filter/category' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","conditions":{"aws":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"instanceType":[null],"instanceTypeFamily":[null],"chargeType":[null],"os":[null],"database":[null],"transferType":[null],"purchaseOption":[null],"apiOperation":[null],"resourceId":[null],"usageType":[null],"invoiceId":[null],"itemDescription":[null],"cacheEngine":[null],"availabilityZone":[null],"platform":[null]},"azure":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}],"subscriptionNm":[null],"subscriptionId":[null],"infraType":[null],"mtCategory":[null],"mtName":[null],"usage":[null],"unitPrice":[null],"totalCost":[null]},"gcp":{"linkedAccountId":[null],"productCode":[null],"region":[null],"productFamily":[null],"tags":[{}],"serviceGroup":[{}]}},"startDate":"2024-09-01","endDate":"2024-09-30","viewBy":"account","field":"platform","selectedKey":"test","searchText":"test","selectedVendors":["AWS"]}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Overview APIs

Cloud cost overview

View cloud costs from the previous period and the estimated costs for the current month.

post

/v3/billing/overview/spend

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

selectedVendorselected Vendorrequired

selected Vendor

Example: AWS

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/overview/spend' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS","selectedVendor":"AWS"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Latest cost collection date

View the latest cloud costs collection date of each vendor.

post

/v3/billing/overview/companyMaxDate

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

companyNamecompany name

company name

Example: 1

defaultVendordefault vendorrequired

default vendor

Example: AWS

userEmailuser email

user email

Example: [e-mail]

userIduser id

user id

Example: abcd

userNameuser name

user name

Example: abcd

vendorvendor

vendor

Example: AWS

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/overview/companyMaxDate' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","companyName":"1","defaultVendor":"AWS","userEmail":"[e-mail]","userId":"abcd","userName":"abcd","vendor":"AWS"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK

Cloud account status

View cloud accounts and status from specific vendor

post

/v3/billing/overview/accounts

Authorizations

Body

siteCodesite coderequired

site code

Example: BESPIN

companyIdcompany idrequired

company id

Example: 1

userIduser id

user id

Example: abcd

vendorvendorrequired

vendor

Example: AWS

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/cost/v3/billing/overview/accounts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"siteCode":"BESPIN","companyId":"1","userId":"abcd","vendor":"AWS"}'

200

200

{
  "status": "success",
  "error": {
    "message": "Error Message",
    "code": "OK"
  }
}

OK