Cost

Anomaly History APIs

Anomaly detection history

post

View abnormal cost detection history list

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
analyzeBystringrequired

Abnormal Cost Analysis Type

Example: account
analyzeTypestringrequired

Abnormal Cost AI/Manual Type

Example: manual
Responses
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"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Anomaly detection history detailed total daily grid list

post

View ai/manual abnormal cost detection daily grid data

Authorizations
Path parameters
analyzeTypestringrequired

Analyze Type

Example: ai
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
histSeqinteger · int32required

History Seq

Example: 0
ruleSeqinteger · int32required

Anomaly Rule Seq

Example: 0
Responses
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
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Anomaly detection history detailed notification result

post

View abnormal cost detection notification sent history

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
histSeqinteger · int32required

History Seq

Example: 0
ruleSeqinteger · int32required

Anomaly Rule Seq

Example: 0
Responses
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
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Anomaly detection history detail result and period chart

post

View abnormal cost detection history details and pie chart data

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
histSeqinteger · int32required

History Seq

Example: 0
ruleSeqinteger · int32required

Anomaly Rule Seq

Example: 0
Responses
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
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Manual anomaly detection history detail result and period chart

post

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

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
histSeqinteger · int32required

History Seq

Example: 0
ruleSeqinteger · int32required

Anomaly Rule Seq

Example: 0
Responses
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
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Anomaly Overview APIs

Trend of anomaly detection by AI

post

View the trend of cost anomalies detected by AI.

Authorizations
Path parameters
vendorstringrequired

Vendor

Example: AWS
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringrequired

vendor

Example: AWS
sensitivitystringrequired

Sensitivity

Example: M
forecastDtstringoptional

Forecast Date

Example: 2024-06-02
Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "vendor": "AWS",
    "sensitivity": "M",
    "forecastDt": "2024-06-02"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Cost trend of cloud usage

post

View the cost trend of cloud usage.

Authorizations
Path parameters
vendorstringrequired

Vendor

Example: AWS
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
vendorsstring[]optional

List of vendors

selectedVendorsByWidgetstring[]required

Selected Vendors by Widget

Example: ["AWS"]
viewTypestringrequired

View Type

Example: account
widgetTypestringrequired

Component Type

Example: dashboard_compare_cost_trend_widget
dateTypestringoptional

Widget Date Type

Example: monthly
dataTypestringoptional

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

Example: monthly, weekly, daily
timeFramestringrequired

Time Frame

Example: last_3_months
viewBystringrequired

View By(account,product,region)

Example: account
filterstringoptional

Filter Type(top_10_by_cost / custom)

Example: top_10_by_cost
customFilterobject[]optional

Custom Filter

selectedAccountstringoptional

Selected Account Filter

Example: 000000000000
selectedAccountsstring[]optional

Selected Accounts Filter

itemstring[]optional

Selected Items Filter

selectedTagKeystringoptional

Selected Tag Key Filter

Example: Name
selectedServiceGroupSetstringoptional

Selected Service Group Set Filter

Example: 00000000-0000-0000-0000-000000000000
widgetCurrencynumber · doubleoptional

Widget Selected Currency

sensitivitystringoptional

Sensitivity value for a specific widget

Example: M
analyzedDtstringoptional

Analysis date

Example: 2024-06-02
Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "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"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Potential anomalous usage data detected by AI

post

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

Authorizations
Path parameters
vendorstringrequired

Vendor

Example: AWS
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
selectedVendorsByWidgetstring[]required

Selected Vendors by Widget

Example: ["AWS","GCP"]
sensitivitystringrequired

Sensitivity

Example: M
forecastDatestringrequired

Forecast Date

Example: 2024-09-23
Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "vendor": "AWS",
    "selectedVendorsByWidget": [
      "AWS",
      "GCP"
    ],
    "sensitivity": "M",
    "forecastDate": "2024-09-23"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Summary of detected anomalies

post

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

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
vendorsstring[]required

List of vendors

Example: ["AWS"]
Responses
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"
    ]
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Summary of detected anomalies

post

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

Authorizations
Path parameters
vendorstringrequired

Vendor

Example: AWS
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
vendorsstring[]required

List of vendors

Example: ["AWS"]
Responses
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"
    ]
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Anomaly Rules APIs

Create/Update an anomaly detection rule setting

put

Create or update the setting of anomaly detection rule.

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
seqinteger · int32optional

Anomaly Rule Seq

Example: 0
namestringoptional

Anomaly Rule Name

Example: Name
analyzeTypestringrequired

Abnormal Cost AI/Manual Type

Example: manual
analyzeBystringrequired

Abnormal Cost Analysis Type

Example: account
sensitivitystringrequired

Sensitivity

Example: M
thValnumber · doubleoptional

Threshold value

Example: 1
thOptstringoptional

Threshold detection options(percentage/amount)

Example: percentage
alertStatusstringoptional

Alarm Setting Status(active/inactive)

Example: inactive
alertFreqstringoptional

Alarm Frequency(daily, weekly)

Example: daily
alertOptstringoptional

Alarm Option(only, all)

Example: only
receiversstringoptional

Alarm recipients

useYnstringoptional

Alarm Enabled

Example: Y
forecastDtstringoptional

Forecast Date

Example: 2024-06-02
analyzedDtstringoptional

Analysis date

Example: 2024-06-02
viewBystringoptional

View By

Example: account
Responses
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": "abcd@bespingloba.com",
    "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",
    "receivers": "text",
    "useYn": "Y",
    "forecastDt": "2024-06-02",
    "analyzedDt": "2024-06-02",
    "viewBy": "account"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Anomaly detection rules

post

View the rules for detecting anomalies and sending alerts.

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "vendor": "AWS"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Specific anomaly detection rule

post

View the specific rule for detecting anomalies and sending alerts.

Authorizations
Path parameters
seqinteger · int32required

Rule Seq

Example: 0
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
seqinteger · int32optional

Anomaly Rule Seq

Example: 0
Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "vendor": "AWS",
    "seq": 0
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Cost Analytics APIs

Detail of cost analytics

post

View detailed grid of cost analytics

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
selectedVendorstringrequiredExample: AWS
costDatestringrequiredExample: 2019-08-12
startDatestringrequiredExample: 2023-02-01
endDatestringrequiredExample: 2024-02-12
viewBystringrequiredExample: account
viewByIdstringoptional
viewByItemstringrequiredExample: 216093335544
itemViewIdstringrequiredExample: 216093335544
filtersobjectrequired

Cost Analytics Filters

detailFiltersobjectrequired

Detail Filters

visibleFieldsstring[]required

VisibleFields of detail grid

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

Tags Filter

isMonthlybooleanrequiredExample: false
Responses
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",
    "viewById": "text",
    "viewByItem": "216093335544",
    "itemViewId": "216093335544",
    "filters": {
      "aws": {
        "linkedAccountId": [
          "text"
        ],
        "productCode": [
          "text"
        ],
        "region": [
          "text"
        ],
        "productFamily": [
          "text"
        ],
        "tags": [
          {
            "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"
          }
        ],
        "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"
          }
        ],
        "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
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Summary of cost analytics

post

View summary of cost analytics

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
startDatestringrequired

start date

Example: 2023-02-01
endDatestringrequired

end date

Example: 2024-02-12
itemsPerPageinteger · int64required

items per page

Example: 30
pageinteger · int64required

page number

Example: 1
userNamestringoptional

user name

Example: abcd
viewBystringrequired

view by

Example: account
selectedVendorsstring[]required

selected vendors

Example: ["AWS"]
filtersobjectrequired

Cost Analytics Filters

isMonthlybooleanrequired

monthly

Example: false
Responses
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",
    "selectedVendors": [
      "AWS"
    ],
    "filters": {
      "aws": {
        "linkedAccountId": [
          "text"
        ],
        "productCode": [
          "text"
        ],
        "region": [
          "text"
        ],
        "productFamily": [
          "text"
        ],
        "tags": [
          {
            "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"
          }
        ],
        "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"
          }
        ],
        "serviceGroup": [
          {
            "serviceGroupKey": "text",
            "serviceGroupValue": "text",
            "serviceGroupSetNm": "text",
            "serviceGroupSetId": "text",
            "serviceGroupNm": "text",
            "serviceGroupId": "text",
            "dfltYn": "text"
          }
        ]
      }
    },
    "isMonthly": false
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Cost Analytics Filters APIs

Filter of Cost Analytics

post

View Cost Analytics filter

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
conditionsobjectrequired

Cost Analytics Filters

startDatestringrequired

Cost Analytics inquiry start date

Example: 2024-09-01
endDatestringrequired

Cost Analytics inquiry end date

Example: 2024-09-30
viewBystringoptional

View By

Example: account
fieldstringoptional

Filter query category

Example: platform
selectedKeystringoptional

Selected Key

Example: test
searchTextstringoptional

Search Text

Example: test
selectedVendorsstring[]required

selected vendors

Example: ["AWS"]
Responses
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": [
          "text"
        ],
        "productCode": [
          "text"
        ],
        "region": [
          "text"
        ],
        "productFamily": [
          "text"
        ],
        "tags": [
          {
            "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"
          }
        ],
        "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"
          }
        ],
        "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"
    ]
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Category of cost analytics

post

View Category of cost analytics

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
userIdstringoptional

user id

Example: abcd
conditionsobjectrequired

Cost Analytics Filters

startDatestringrequired

Cost Analytics inquiry start date

Example: 2024-09-01
endDatestringrequired

Cost Analytics inquiry end date

Example: 2024-09-30
viewBystringoptional

View By

Example: account
fieldstringoptional

Filter query category

Example: platform
selectedKeystringoptional

Selected Key

Example: test
searchTextstringoptional

Search Text

Example: test
selectedVendorsstring[]required

selected vendors

Example: ["AWS"]
Responses
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": [
          "text"
        ],
        "productCode": [
          "text"
        ],
        "region": [
          "text"
        ],
        "productFamily": [
          "text"
        ],
        "tags": [
          {
            "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"
          }
        ],
        "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"
          }
        ],
        "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"
    ]
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Overview APIs

Cloud cost overview

post

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

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
selectedVendorstringrequired

selected Vendor

Example: AWS
endDatestringoptional

The last date to include in the data range (inclusive). If not provided, defaults to the UTC current date.

Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "vendor": "AWS",
    "selectedVendor": "AWS",
    "endDate": "text"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

Latest cost collection date

post

View the latest cloud costs collection date of each vendor.

Authorizations
Body
siteCodestringrequired

site code

Example: BESPIN
companyIdstringrequired

company id

Example: 1
companyNamestringoptional

company name

Example: 1
defaultVendorstringrequired

default vendor

Example: AWS
userEmailstringoptional

user email

Example: abcd@bespingloba.com
userIdstringoptional

user id

Example: abcd
userNamestringoptional

user name

Example: abcd
vendorstringoptional

vendor

Example: AWS
Responses
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": "abcd@bespingloba.com",
    "userId": "abcd",
    "userName": "abcd",
    "vendor": "AWS"
  }'
{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

OK

PreviousPlatformNextResources

Last updated

Was this helpful?