Cost

Anomaly History APIs

Anomaly detection history

post

View abnormal cost detection history list

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

analyzeBystringRequired

Abnormal Cost Analysis Type

Example: account

analyzeTypestringRequired

Abnormal Cost AI/Manual Type

Example: manual

Responses

200

OK

*/*

post

/v3/billing/anomaly/history/list

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/history/list HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "companyId": "companyId",
  "userId": "userId",
  "analyzeBy": "account",
  "analyzeType": "manual"
}

200

OK

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

Anomaly detection history detailed total daily grid list

post

View ai/manual abnormal cost detection daily grid data

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

analyzeTypestringRequired

Analyze Type

Example: ai

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

histSeqinteger · int32Required

History Seq

Example: 0

ruleSeqinteger · int32Required

Anomaly Rule Seq

Example: 0

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/history/detail/{analyzeType}/grid HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "companyId": "companyId",
  "userId": "userId",
  "histSeq": 0,
  "ruleSeq": 0
}

200

OK

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

Anomaly detection history detailed notification result

post

View abnormal cost detection notification sent history

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

histSeqinteger · int32Required

History Seq

Example: 0

ruleSeqinteger · int32Required

Anomaly Rule Seq

Example: 0

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/history/detail/sent HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "companyId": "companyId",
  "userId": "userId",
  "histSeq": 0,
  "ruleSeq": 0
}

200

OK

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

Anomaly detection history detail result and period chart

post

View abnormal cost detection history details and pie chart data

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

histSeqinteger · int32Required

History Seq

Example: 0

ruleSeqinteger · int32Required

Anomaly Rule Seq

Example: 0

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/history/detail/result HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "companyId": "companyId",
  "userId": "userId",
  "histSeq": 0,
  "ruleSeq": 0
}

200

OK

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

Manual anomaly detection history detail result and period chart

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

histSeqinteger · int32Required

History Seq

Example: 0

ruleSeqinteger · int32Required

Anomaly Rule Seq

Example: 0

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/history/detail/manual/period-chart HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "companyId": "companyId",
  "userId": "userId",
  "histSeq": 0,
  "ruleSeq": 0
}

200

OK

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

Anomaly Overview APIs

Trend of anomaly detection by AI

post

View the trend of cost anomalies detected by AI.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

vendorstringRequired

vendor

Example: AWS

sensitivitystringRequired

Sensitivity

Example: M

forecastDtstringOptional

Forecast Date

Example: 2024-06-02

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "sensitivity": "M",
  "forecastDt": "2024-06-02"
}

200

OK

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

Cost trend of cloud usage

post

View the cost trend of cloud usage.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

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

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

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 765

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "vendors": [
    "text"
  ],
  "selectedVendorsByWidget": [
    "AWS"
  ],
  "viewType": "account",
  "widgetType": "dashboard_compare_cost_trend_widget",
  "dateType": "monthly",
  "dataType": "monthly, weekly, daily",
  "timeFrame": "last_3_months",
  "viewBy": "account",
  "filter": "top_10_by_cost",
  "customFilter": [
    {
      "vendor": "text",
      "item": "text"
    }
  ],
  "selectedAccount": "000000000000",
  "selectedAccounts": [
    "text"
  ],
  "item": [
    "text"
  ],
  "selectedTagKey": "Name",
  "selectedServiceGroupSet": "00000000-0000-0000-0000-000000000000",
  "widgetCurrency": 1,
  "sensitivity": "M",
  "analyzedDt": "2024-06-02"
}

200

OK

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

Potential anomalous usage data detected by AI

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

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

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 318

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "selectedVendorsByWidget": [
    "AWS",
    "GCP"
  ],
  "sensitivity": "M",
  "forecastDate": "2024-09-23"
}

200

OK

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

Summary of detected anomalies

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

vendorsstring[]Required

List of vendors

Example: ["AWS"]

Responses

200

OK

*/*

post

/v3/billing/anomaly/vendors/aggregate

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/aggregate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "companyId": "companyId",
  "userId": "userId",
  "vendors": [
    "AWS"
  ]
}

200

OK

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

Summary of detected anomalies

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

vendorsstring[]Required

List of vendors

Example: ["AWS"]

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/{vendor}/aggregate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "companyId": "companyId",
  "userId": "userId",
  "vendors": [
    "AWS"
  ]
}

200

OK

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

Anomaly Rules APIs

Create/Update an anomaly detection rule setting

put

Create or update the setting of anomaly detection rule.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

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

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 513

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "seq": 0,
  "name": "Name",
  "analyzeType": "manual",
  "analyzeBy": "account",
  "sensitivity": "M",
  "thVal": 1,
  "thOpt": "percentage",
  "alertStatus": "inactive",
  "alertFreq": "daily",
  "alertOpt": "only",
  "receivers": "text",
  "useYn": "Y",
  "forecastDt": "2024-06-02",
  "analyzedDt": "2024-06-02",
  "viewBy": "account"
}

200

OK

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

Anomaly detection rules

post

View the rules for detecting anomalies and sending alerts.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

vendorstringOptional

vendor

Example: AWS

vendorListstring[]Optional

List of vendors

Example: ["AWS"]

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/detections/alerts/rule HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "vendorList": [
    "AWS"
  ]
}

200

OK

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

Specific anomaly detection rule

post

View the specific rule for detecting anomalies and sending alerts.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

seqinteger · int32Required

Rule Seq

Example: 0

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

vendorstringOptional

vendor

Example: AWS

seqinteger · int32Optional

Anomaly Rule Seq

Example: 0

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "seq": 0
}

200

OK

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

Billing APIs

Get monthly billing summary

post

Retrieve monthly billing summary including invoices and services. Required parameters: companyId, searchYear, searchMnth, vndr

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

searchYearstringRequired

Search Year

Example: 2025

searchMnthstringRequired

Search Month (01-12)

Example: 05

vndrstringRequired

Vendor (AWS)

Example: AWS

lnkdAccIdstringOptional

Linked Account ID (optional)

Example: linkedAccountId

Responses

200

success

application/json

500

Internal Server Error

application/json

post

/v3/billing/summary

HTTPcURLJavaScriptPython

POST /cost/v3/billing/summary HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "companyId": "companyId",
  "searchYear": "2025",
  "searchMnth": "05",
  "vndr": "AWS",
  "lnkdAccId": "linkedAccountId"
}

{
  "data": {
    "summary": {
      "invoices": [
        {
          "cmpnId": "companyId",
          "billYear": "2025",
          "billMnth": "05",
          "vndr": "AWS",
          "payrAccId": "382377105752",
          "lnkdAccId": "216093335544",
          "invcId": "2175433553",
          "excgRate": 1381.4,
          "useCost": 34103.7224496458,
          "discCost": 0,
          "suppCost": 0,
          "crdtCost": 0,
          "totCost": 34103.7224496458,
          "excgCost": 47110882
        }
      ],
      "services": [
        {
          "cmpnId": "companyId",
          "billYear": "2025",
          "billMnth": "05",
          "vndr": "AWS",
          "payrAccId": "382377105752",
          "lnkdAccId": "216093335544",
          "invcId": "2175433553",
          "addType": "SUPPORT",
          "addDesc": "AWS Premium Support",
          "excgCost": "1500000"
        }
      ]
    }
  },
  "status": "success"
}

Cost Analytics APIs

Detail of cost analytics

post

View detailed portion chart data of cost analytics

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

selectedVendorstringRequiredExample: AWS

costDatestringRequiredExample: 2019-08-12

startDatestringRequiredExample: 2023-02-01

endDatestringRequiredExample: 2024-02-12

viewBystringRequiredExample: account

viewByIdstringOptional

viewByItemstringRequiredExample: 216093335544

itemViewIdstringRequiredExample: 216093335544

visibleFieldsstring[]Required

VisibleFields of detail grid

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

isMonthlybooleanRequiredExample: false

Responses

200

OK

*/*

post

/v3/billing/analytics/daily-portion

HTTPcURLJavaScriptPython

POST /cost/v3/billing/analytics/daily-portion HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2189

{
  "companyId": "companyId",
  "userId": "userId",
  "selectedVendor": "AWS",
  "costDate": "2019-08-12",
  "startDate": "2023-02-01",
  "endDate": "2024-02-12",
  "viewBy": "account",
  "viewById": "text",
  "viewByItem": "216093335544",
  "itemViewId": "216093335544",
  "filters": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "detailFilters": {
    "linkedAccountId": [
      "text"
    ],
    "productCode": [
      "text"
    ],
    "region": [
      "text"
    ],
    "usageType": [
      "text"
    ]
  },
  "visibleFields": [
    "vendor",
    "linkedAccountId",
    "productName",
    "region",
    "usage",
    "cost",
    "usageType"
  ],
  "tags": [
    {
      "tagKey": "text",
      "tagValue": "text"
    }
  ],
  "isMonthly": false
}

200

OK

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

Detail of cost analytics

post

View detailed grid of cost analytics

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

selectedVendorstringRequiredExample: AWS

costDatestringRequiredExample: 2019-08-12

startDatestringRequiredExample: 2023-02-01

endDatestringRequiredExample: 2024-02-12

viewBystringRequiredExample: account

viewByIdstringOptional

viewByItemstringRequiredExample: 216093335544

itemViewIdstringRequiredExample: 216093335544

visibleFieldsstring[]Required

VisibleFields of detail grid

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

isMonthlybooleanRequiredExample: false

Responses

200

OK

*/*

post

/v3/billing/analytics/daily-cost

HTTPcURLJavaScriptPython

POST /cost/v3/billing/analytics/daily-cost HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2189

{
  "companyId": "companyId",
  "userId": "userId",
  "selectedVendor": "AWS",
  "costDate": "2019-08-12",
  "startDate": "2023-02-01",
  "endDate": "2024-02-12",
  "viewBy": "account",
  "viewById": "text",
  "viewByItem": "216093335544",
  "itemViewId": "216093335544",
  "filters": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "detailFilters": {
    "linkedAccountId": [
      "text"
    ],
    "productCode": [
      "text"
    ],
    "region": [
      "text"
    ],
    "usageType": [
      "text"
    ]
  },
  "visibleFields": [
    "vendor",
    "linkedAccountId",
    "productName",
    "region",
    "usage",
    "cost",
    "usageType"
  ],
  "tags": [
    {
      "tagKey": "text",
      "tagValue": "text"
    }
  ],
  "isMonthly": false
}

200

OK

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

Summary of cost analytics

post

View summary of cost analytics

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

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"]

isMonthlybooleanRequired

monthly

Example: false

Responses

200

OK

*/*

post

/v3/billing/analytics/cost

HTTPcURLJavaScriptPython

POST /cost/v3/billing/analytics/cost HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1892

{
  "companyId": "companyId",
  "userId": "userId",
  "startDate": "2023-02-01",
  "endDate": "2024-02-12",
  "itemsPerPage": 30,
  "page": 1,
  "userName": "abcd",
  "viewBy": "account",
  "selectedVendors": [
    "AWS"
  ],
  "filters": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "isMonthly": false
}

200

OK

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

Cost Analytics Filters APIs

Filter of Cost Analytics

post

View Cost Analytics filter

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

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

200

OK

*/*

post

/v3/billing/analytics/related

HTTPcURLJavaScriptPython

POST /cost/v3/billing/analytics/related HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1892

{
  "companyId": "companyId",
  "userId": "userId",
  "conditions": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "viewBy": "account",
  "field": "platform",
  "selectedKey": "test",
  "searchText": "test",
  "selectedVendors": [
    "AWS"
  ]
}

200

OK

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

Filter of Cost Analytics

post

View Cost Analytics filter

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

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

200

OK

*/*

post

/v3/billing/analytics/filter

HTTPcURLJavaScriptPython

POST /cost/v3/billing/analytics/filter HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1892

{
  "companyId": "companyId",
  "userId": "userId",
  "conditions": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "viewBy": "account",
  "field": "platform",
  "selectedKey": "test",
  "searchText": "test",
  "selectedVendors": [
    "AWS"
  ]
}

200

OK

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

Category of cost analytics

post

View Category of cost analytics

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

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

200

OK

*/*

post

/v3/billing/analytics/filter/category

HTTPcURLJavaScriptPython

POST /cost/v3/billing/analytics/filter/category HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1892

{
  "companyId": "companyId",
  "userId": "userId",
  "conditions": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "billingTags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "viewBy": "account",
  "field": "platform",
  "selectedKey": "test",
  "searchText": "test",
  "selectedVendors": [
    "AWS"
  ]
}

200

OK

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

Currency & ExchangeRate Controller APIs

Get company exchange rate by vendor

get

Retrieve exchange rate information for a specific company and vendor

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

companyIdstringRequired

company id

Example: companyId

vendorstring · enumRequired

Target cloud vendor

Possible values:

Query parameters

currencystringOptional

Target currency for exchange rate

yearMonthstringOptional

Target year month

userIdstringOptional

user id

Example: userId

Responses

200

OK

*/*

get

/v3/billing/currency/company/{companyId}/vendor/{vendor}/exchange

HTTPcURLJavaScriptPython

GET /cost/v3/billing/currency/company/{companyId}/vendor/{vendor}/exchange HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Overview APIs

Cloud cost overview

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

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

200

OK

*/*

post

/v3/billing/overview/spend

HTTPcURLJavaScriptPython

POST /cost/v3/billing/overview/spend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS",
  "selectedVendor": "AWS",
  "endDate": "text"
}

200

OK

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

Latest cost collection date

post

View the latest cloud costs collection date of each vendor.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: 123e4567-e89b-12d3-a456-426614174000

companyNamestringOptional

company name

Example: ex-company-rname

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: [email protected]

userIdstringOptional

user id

Example: 390df5f7-8852-40af-bc12-57a318cb9dc3

userNamestringOptional

user name

Example: ex-user-name

vendorstringOptional

vendor

Example: AWS

Responses

200

OK

*/*

post

/v3/billing/overview/companyMaxDate

HTTPcURLJavaScriptPython

POST /cost/v3/billing/overview/companyMaxDate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyName": "ex-company-rname",
  "defaultVendor": "AWS",
  "userEmail": "[email protected]",
  "userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
  "userName": "ex-user-name",
  "vendor": "AWS"
}

200

OK

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

Cloud account status

post

View cloud accounts and status from specific vendor

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

companyIdstringRequired

company id

Example: companyId

userIdstringOptional

user id

Example: userId

vendorstringRequired

vendor

Example: AWS

Responses

200

OK

*/*

post

/v3/billing/overview/accounts

HTTPcURLJavaScriptPython

POST /cost/v3/billing/overview/accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "companyId": "companyId",
  "userId": "userId",
  "vendor": "AWS"
}

200

OK

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