Cost

Anomaly History APIs

Anomaly detection history

View abnormal cost detection history list

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/list

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

analyzeBy*analyze by

Abnormal Cost Analysis Type

Example: "account"

analyzeType*analyze type

Abnormal Cost AI/Manual Type

Example: "manual"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/history/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "analyzeBy": "account",
      "analyzeType": "manual",
      "companyId": "1",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Anomaly detection history detailed total daily grid list

View ai/manual abnormal cost detection daily grid data

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/{analyzeType}/grid

Authorization

BearerToken

Path parameters

analyzeType*string

Analyze Type

Example: "ai"

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/{analyzeType}/grid', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "histSeq": 0,
      "ruleSeq": 0,
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Anomaly detection history detailed notification result

View abnormal cost detection notification sent history

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/sent

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/sent', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "histSeq": 0,
      "ruleSeq": 0,
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Anomaly detection history detail result and period chart

View abnormal cost detection history details and pie chart data

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/result

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/result', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "histSeq": 0,
      "ruleSeq": 0,
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Manual anomaly detection history detail result and period chart

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

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/manual/period-chart

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/history/detail/manual/period-chart', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "histSeq": 0,
      "ruleSeq": 0,
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Anomaly Overview APIs

Trend of anomaly detection by AI

View the trend of cost anomalies detected by AI.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend

Authorization

BearerToken

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "[e-mail]"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendor*vendor

vendor

Example: "AWS"

sensitivity*Sensitivity

Sensitivity

Example: "M"

forecastDtForecast Date

Forecast Date

Example: "2024-06-02"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "sensitivity": "M",
      "siteCode": "BESPIN",
      "vendor": "AWS"
    }),
});
const data = await response.json();

Response

200

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

Cost trend of cloud usage

View the cost trend of cloud usage.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend

Authorization

BearerToken

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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"

vendorsList of vendors

List of vendors

selectedVendorsByWidget*Selected Vendors by Widget

Selected Vendors by Widget

viewType*View Type

View Type

Example: "account"

widgetType*Component Type

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"

timeFrame*Time Frame

Time Frame

Example: "last_3_months"

viewBy*View By

View By(account,product,region)

Example: "account"

filterFilter Type

Filter Type(top_10_by_cost / custom)

Example: "top_10_by_cost"

customFilterCustom Filter

Custom Filter

selectedAccountSelected Account Filter

Selected Account Filter

Example: "000000000000"

selectedAccountsSelected Accounts Filter

Selected Accounts Filter

itemSelected Items Filter

Selected Items Filter

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"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "selectedVendorsByWidget": [
        "AWS"
      ],
      "siteCode": "BESPIN",
      "timeFrame": "last_3_months",
      "viewBy": "account",
      "viewType": "account",
      "widgetType": "dashboard_compare_cost_trend_widget"
    }),
});
const data = await response.json();

Response

200

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

Potential anomalous usage data detected by AI

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

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause

Authorization

BearerToken

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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"

selectedVendorsByWidget*Selected Vendors by Widget

Selected Vendors by Widget

sensitivity*Sensitivity

Sensitivity

Example: "M"

forecastDate*Forecast Date

Forecast Date

Example: "2024-09-23"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "forecastDate": "2024-09-23",
      "selectedVendorsByWidget": [
        "AWS",
        "GCP"
      ],
      "sensitivity": "M",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Summary of detected anomalies

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

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/aggregate

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendors*List of vendors

List of vendors

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/aggregate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "siteCode": "BESPIN",
      "vendors": [
        "AWS"
      ]
    }),
});
const data = await response.json();

Response

200

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

Summary of detected anomalies

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

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/aggregate

Authorization

BearerToken

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendors*List of vendors

List of vendors

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/aggregate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "siteCode": "BESPIN",
      "vendors": [
        "AWS"
      ]
    }),
});
const data = await response.json();

Response

200

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

Anomaly Rules APIs

Create/Update an anomaly detection rule setting

Create or update the setting of anomaly detection rule.

PUThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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"

analyzeType*Analyze Type

Abnormal Cost AI/Manual Type

Example: "manual"

analyzeBy*Analyze By

Abnormal Cost Analysis Type

Example: "account"

sensitivity*Sensitivity

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"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "analyzeBy": "account",
      "analyzeType": "manual",
      "companyId": "1",
      "defaultVendor": "AWS",
      "sensitivity": "M",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Anomaly detection rules

View the rules for detecting anomalies and sending alerts.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Specific anomaly detection rule

View the specific rule for detecting anomalies and sending alerts.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq}

Authorization

BearerToken

Path parameters

seq*integer (int32)

Rule Seq

Example: 0

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Cost Analytics APIs

Detail of cost analytics

View detailed portion chart data of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/daily-portion

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

selectedVendor*selected vendor

Example: "AWS"

costDate*cost date

Example: "2019-08-12"

startDate*start date

Example: "2023-02-01"

endDate*end date

Example: "2024-02-12"

viewBy*view by

Example: "account"

viewByIdviewById

viewByItem*viewByItem

Example: "216093335544"

itemViewId*itemViewId

Example: "216093335544"

filters*Cost Analytics Filters

Cost Analytics Filters

detailFilters*Detail Filters

Detail Filters

visibleFields*VisibleFields of detail grid

VisibleFields of detail grid

tagsTags Filter

Tags Filter

isMonthly*monthly

Example: false

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/analytics/daily-portion', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "costDate": "2019-08-12",
      "detailFilters": {},
      "endDate": "2024-02-12",
      "filters": {},
      "isMonthly": false,
      "itemViewId": "216093335544",
      "selectedVendor": "AWS",
      "siteCode": "BESPIN",
      "startDate": "2023-02-01",
      "viewBy": "account",
      "viewByItem": "216093335544",
      "visibleFields": [
        "vendor",
        "linkedAccountId",
        "productName",
        "region",
        "usage",
        "cost",
        "usageType"
      ]
    }),
});
const data = await response.json();

Response

200

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

Detail of cost analytics

View detailed grid of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/daily-cost

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

selectedVendor*selected vendor

Example: "AWS"

costDate*cost date

Example: "2019-08-12"

startDate*start date

Example: "2023-02-01"

endDate*end date

Example: "2024-02-12"

viewBy*view by

Example: "account"

viewByIdviewById

viewByItem*viewByItem

Example: "216093335544"

itemViewId*itemViewId

Example: "216093335544"

filters*Cost Analytics Filters

Cost Analytics Filters

detailFilters*Detail Filters

Detail Filters

visibleFields*VisibleFields of detail grid

VisibleFields of detail grid

tagsTags Filter

Tags Filter

isMonthly*monthly

Example: false

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/analytics/daily-cost', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "costDate": "2019-08-12",
      "detailFilters": {},
      "endDate": "2024-02-12",
      "filters": {},
      "isMonthly": false,
      "itemViewId": "216093335544",
      "selectedVendor": "AWS",
      "siteCode": "BESPIN",
      "startDate": "2023-02-01",
      "viewBy": "account",
      "viewByItem": "216093335544",
      "visibleFields": [
        "vendor",
        "linkedAccountId",
        "productName",
        "region",
        "usage",
        "cost",
        "usageType"
      ]
    }),
});
const data = await response.json();

Response

200

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

Summary of cost analytics

View summary of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/cost

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

startDate*start date

start date

Example: "2023-02-01"

endDate*end date

end date

Example: "2024-02-12"

itemsPerPage*items per page

items per page

Example: 30

page*page number

page number

Example: 1

userNameuser name

user name

Example: "abcd"

viewBy*view by

view by

Example: "account"

selectedVendors*selected vendors

selected vendors

filters*Cost Analytics Filters

Cost Analytics Filters

isMonthly*monthly

monthly

Example: false

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/analytics/cost', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "endDate": "2024-02-12",
      "filters": {},
      "isMonthly": false,
      "itemsPerPage": 30,
      "page": 1,
      "selectedVendors": [
        "AWS"
      ],
      "siteCode": "BESPIN",
      "startDate": "2023-02-01",
      "viewBy": "account"
    }),
});
const data = await response.json();

Response

200

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

Cost Analytics Filters APIs

Filter of Cost Analytics

View Cost Analytics filter

POSThttps://api.opsnow.io/cost/v3/billing/analytics/related

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

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"

selectedVendors*selected vendors

selected vendors

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/analytics/related', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "conditions": {},
      "endDate": "2024-09-30",
      "selectedVendors": [
        "AWS"
      ],
      "siteCode": "BESPIN",
      "startDate": "2024-09-01"
    }),
});
const data = await response.json();

Response

200

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

Filter of Cost Analytics

View Cost Analytics filter

POSThttps://api.opsnow.io/cost/v3/billing/analytics/filter

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

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"

selectedVendors*selected vendors

selected vendors

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/analytics/filter', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "conditions": {},
      "endDate": "2024-09-30",
      "selectedVendors": [
        "AWS"
      ],
      "siteCode": "BESPIN",
      "startDate": "2024-09-01"
    }),
});
const data = await response.json();

Response

200

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

Category of cost analytics

View Category of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/filter/category

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

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"

selectedVendors*selected vendors

selected vendors

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/analytics/filter/category', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "conditions": {},
      "endDate": "2024-09-30",
      "selectedVendors": [
        "AWS"
      ],
      "siteCode": "BESPIN",
      "startDate": "2024-09-01"
    }),
});
const data = await response.json();

Response

200

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

Overview APIs

Cloud cost overview

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

POSThttps://api.opsnow.io/cost/v3/billing/overview/spend

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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"

selectedVendor*selected Vendor

selected Vendor

Example: "AWS"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/overview/spend', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "selectedVendor": "AWS",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Latest cost collection date

View the latest cloud costs collection date of each vendor.

POSThttps://api.opsnow.io/cost/v3/billing/overview/companyMaxDate

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

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"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/overview/companyMaxDate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "defaultVendor": "AWS",
      "siteCode": "BESPIN"
    }),
});
const data = await response.json();

Response

200

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

Cloud account status

View cloud accounts and status from specific vendor

POSThttps://api.opsnow.io/cost/v3/billing/overview/accounts

Authorization

BearerToken

Body

application/json

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendor*vendor

vendor

Example: "AWS"

Response

200

OK

Body

*/*

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

Request

JavaScriptCurlPython

const response = await fetch('https://api.opsnow.io/cost/v3/billing/overview/accounts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": "1",
      "siteCode": "BESPIN",
      "vendor": "AWS"
    }),
});
const data = await response.json();

Response

200

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