Namirasoft Cost API V1

Namira Software Corporation Cost API Version 1 (1.4.60)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-cost-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-cost healthz get

Copied!

Metrics

Get

Returns the application metrics

ns-cost metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-cost value list {table} {column} {search} {field_id} {limit}

Copied!

BillWatchAWS

EstimateRecord

Returns the BillWatch cost hourly estimation for an AWS Watch

ns-cost billwatchaws estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for bill watch aws

ns-cost billwatchaws _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

BillWatchAzure

EstimateRecord

Returns the BillWatch cost hourly estimation for an Azure Watch

ns-cost billwatchazure estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for bill watch azure

ns-cost billwatchazure _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

BillWatchGCP

EstimateRecord

Returns the BillWatch cost hourly estimation for an GCP Watch

ns-cost billwatchgcp estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for bill watch gcp

ns-cost billwatchgcp _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

FieldCategory

EstimateRecord

Returns the Field cost hourly estimation for a category

ns-cost fieldcategory estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for field category

ns-cost fieldcategory _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

FieldField

EstimateRecord

Returns the Field cost hourly estimation for Field

ns-cost fieldfield estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for field field

ns-cost fieldfield _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

LogLogGroup

EstimateRecord

Returns the log cost hourly estimation for log group

ns-cost logloggroup estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for log log group

ns-cost logloggroup _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

EstimateRead

Returns the log cost read estimation for log group

ns-cost logloggroup estimateread

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRead

Creates a new read cost for a user_id for log log group

ns-cost logloggroup _createforread {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

SecretSecret

EstimateRecord

Returns the Secret cost hourly estimation for Secret

ns-cost secretsecret estimaterecord

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRecord

Creates a new record cost for a user_id for secret secret

ns-cost secretsecret _createforrecord {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

EstimateRead

Returns the Secret cost read estimation for Secret

ns-cost secretsecret estimateread

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--trial_started_at (DateTime)

--count (Integer)

_CreateForRead

Creates a new read cost for a user_id for secret secret

ns-cost secretsecret _createforread {user_id}

Copied!

--period (Object)

--total_count (Integer)

--number (Integer)

--total_value (Integer)

--value (Integer)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

Cost

List

Returns the cost list

ns-cost cost list {filters} {page} {size} {sorts}

Copied!

Grouped

Returns the cost grouped list

ns-cost cost grouped

Copied!

--start_date (DateTime)

--end_date (DateTime)

--granularity (Enum)

--dimension (Enum)

--filter_workspace_ids (Array)

--filter_product_ids (Array)

--filter_sales_item_ids (Array)

--filter_offer_ids (Array)

--filter_offer_item_ids (Array)

--filter_resource_entities (Array)

--filter_resource_ids (Array)

--filter_usage_names (Array)

ResourceEntityList

Returns the resource entity list for an user

ns-cost cost resourceentitylist {filters} {page} {size} {sorts}

Copied!

ResourceIDList

Returns the resource id list for an user and an entity

ns-cost cost resourceidlist {entity} {filters} {page} {size} {sorts}

Copied!

Schemas


EstimationOption

{
  "name": "EstimationOption",
  "type": "Object",
  "required": true
}

Estimation

{
  "name": "Estimation",
  "type": "Object",
  "required": true
}

CalculationOption

{
  "name": "CalculationOption",
  "type": "Object",
  "required": true
}

Cost

{
  "name": "Cost",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true
    },
    "workspace_id": {
      "type": "String",
      "required": true
    },
    "product_id": {
      "type": "String",
      "required": true
    },
    "sales_item_id": {
      "type": "String",
      "required": true
    },
    "offer_id": {
      "type": "String",
      "required": true
    },
    "offer_item_id": {
      "type": "String",
      "required": true
    },
    "resource_entity": {
      "type": "String",
      "required": true
    },
    "resource_id": {
      "type": "String",
      "required": true
    },
    "usage_name": {
      "type": "String",
      "required": true
    },
    "usage_value": {
      "type": "Double",
      "required": true
    },
    "usage_unit": {
      "type": "String",
      "required": true
    },
    "period_start": {
      "type": "DateTime",
      "required": true
    },
    "period_end": {
      "type": "DateTime",
      "required": true
    },
    "amount": {
      "type": "Double",
      "required": true
    },
    "currency": {
      "type": "String",
      "required": true
    },
    "description": {
      "type": "String",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

GroupedResponse

{
  "name": "GroupedResponse",
  "type": "Object",
  "required": true,
  "fields": {
    "period": {
      "type": "DateTime",
      "required": true
    },
    "dimension": {
      "type": "String",
      "required": true
    },
    "total_count": {
      "type": "Money",
      "required": true,
      "precision": 2
    },
    "total_amount": {
      "type": "Money",
      "required": true,
      "precision": 2
    }
  }
}

Enums

GranularityType

Hour

Day

Week

Month

DimensionType

NONE

WORKSPACE

PRODUCT

SALES_ITEM

OFFER

OFFER_ITEM

RESOURCE_ENTITY

RESOURCE_ID

USAGE_NAME

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.