Nuvelics documentation
APIAPI reference

Audit and usage

Read your organization's audit events, and the usage entries its spend is measured from.

GET
/api/tenant/v1/audit-events

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

limit?integer

Maximum items per page (1–100, default 25)

Range1 <= value <= 100
Default25
cursor?string

Opaque cursor from a prior nextCursor

Response Body

A page of the caller's own org's audit events, most-recent first

application/json
  1. response
items*array<>
pagination*
sort*
filters*
facets?

Value/count breakdown for each field requested via ?facets=. Present only when facets were requested.

included?array<>
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/audit-events'
Example Response
{  "items": [    {      "id": "string",      "occurredAt": "string",      "actor": {        "kind": "user",        "id": "string"      },      "onBehalfOf": {        "kind": "user",        "id": "string"      },      "orgId": "string",      "action": "string",      "targetType": "string",      "targetId": "string",      "impersonation": {        "staffId": "string",        "orgId": "string",        "role": "owner",        "reason": "string"      },      "episodeId": "string",      "reason": "string",      "channel": "string",      "requestId": "string",      "sourceIp": "string",      "userAgent": "string"    }  ],  "pagination": {    "nextCursor": "string"  },  "sort": {    "applied": "string",    "default": "string",    "available": [      "string"    ]  },  "filters": {    "applied": {      "property1": null,      "property2": null    },    "available": [      {        "field": "string",        "kind": "string",        "facetable": true      }    ]  },  "facets": {    "property1": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    },    "property2": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    }  },  "included": [    {      "type": "string",      "id": "string",      "name": "string"    }  ]}
GET
/api/tenant/v1/audit-events/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

Response Body

A single audit event with full detail (including changes)

application/json
  1. response
id*string
occurredAt*string
actor*
onBehalfOf?
orgId?string
action*string
targetType?string
targetId?string
impersonation?

Present when Nuvelics staff performed the action while acting in your organization: who they are, which organization and role they acted in, and the reason they recorded

episodeId?string
reason?string
channel?string
requestId?string
sourceIp?string
userAgent?string
changes?
included?array<>
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/audit-events/string'
Example Response
{  "id": "string",  "occurredAt": "string",  "actor": {    "kind": "user",    "id": "string"  },  "onBehalfOf": {    "kind": "user",    "id": "string"  },  "orgId": "string",  "action": "string",  "targetType": "string",  "targetId": "string",  "impersonation": {    "staffId": "string",    "orgId": "string",    "role": "owner",    "reason": "string"  },  "episodeId": "string",  "reason": "string",  "channel": "string",  "requestId": "string",  "sourceIp": "string",  "userAgent": "string",  "changes": {    "property1": {      "before": null,      "after": null    },    "property2": {      "before": null,      "after": null    }  },  "included": [    {      "type": "string",      "id": "string",      "name": "string"    }  ]}
GET
/api/tenant/v1/usage-events

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

limit?integer

Maximum items per page (1–100, default 25)

Range1 <= value <= 100
Default25
cursor?string

Opaque cursor from a prior nextCursor

Response Body

A page of the caller's own org's usage-ledger entries, most-recent first

application/json
  1. response
items*array<>
pagination*
sort*
filters*
facets?

Value/count breakdown for each field requested via ?facets=. Present only when facets were requested.

included?
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/usage-events'
Example Response
{  "items": [    {      "id": "string",      "orgId": "string",      "provider": "string",      "sku": "string",      "mode": "string",      "resource": "string",      "unit": "string",      "quantity": 0,      "estimatedMicroUsd": 0,      "actualCostMicroUsd": 0,      "billingOwner": "string",      "occurredAt": "string"    }  ],  "pagination": {    "nextCursor": "string"  },  "sort": {    "applied": "string",    "default": "string",    "available": [      "string"    ]  },  "filters": {    "applied": {      "property1": null,      "property2": null    },    "available": [      {        "field": "string",        "kind": "string",        "facetable": true      }    ]  },  "facets": {    "property1": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    },    "property2": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    }  },  "included": {    "datasources": {      "property1": {        "id": "string",        "name": "string",        "type": "string",        "vendor": "datafactory",        "iconId": "string"      },      "property2": {        "id": "string",        "name": "string",        "type": "string",        "vendor": "datafactory",        "iconId": "string"      }    },    "credentials": {      "property1": {        "id": "string",        "name": "string",        "schemeType": "string"      },      "property2": {        "id": "string",        "name": "string",        "schemeType": "string"      }    },    "users": {      "property1": {        "id": "string",        "name": "string",        "email": "string"      },      "property2": {        "id": "string",        "name": "string",        "email": "string"      }    },    "articlePitches": {      "property1": [        {          "id": "string",          "title": "string",          "status": "string",          "newsdeskId": "string"        }      ],      "property2": [        {          "id": "string",          "title": "string",          "status": "string",          "newsdeskId": "string"        }      ]    }  }}
GET
/api/tenant/v1/usage-events/summary

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

bucket*string
Value in"day""month"
groupBy?string
Value in"provider""sku""resource""unit""mode""billingOwner"

Response Body

The caller's own org's spend bucketed by day or month, optionally grouped by one dimension

application/json
  1. response
rows*array<>
capped*boolean
included?array<>
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/usage-events/summary?bucket=day'
Example Response
{  "rows": [    {      "bucket": "string",      "key": "string",      "microUsd": 0,      "quantity": 0    }  ],  "capped": true,  "included": [    {      "type": "string",      "id": "string",      "name": "string"    }  ]}

Report a problem with this page

On this page