Constructor

# new InsightsService(tokenSource, serviceUrl)

Parameters:

Name	Type	Description
`tokenSource`	`string` \| `function`
`serviceUrl`	`string`

View Source services/InsightsService.class.js, line 34

Example

const insights = sdk.asAdmin().Insights()

// Read source metadata by name
const { result } = await insights.Source('Orders').get()

// Create a document
await insights.Source('Orders').Doc.create({ temperature: 21.5, unit: 'C' })

Extends

ScenidCloudService

Methods

# Source(nameOrId) → {SourceHandle}

Returns a scoped handle for the given source, identified by name or sourceId.

The name is resolved to a sourceId via a local cache on first call. If the name is not found in the cache, the cache is refreshed once before falling back to using the value as-is.

Parameters:

Name	Type	Description
`nameOrId`	`string`	The source's human-readable name (e.g. `'Orders'`) or raw sourceId.

View Source services/InsightsService.class.js, line 56

Returns:

Type: SourceHandle

Example

const src = insights.Source('Orders')
const { result } = await src.get(true)  // include formulator schema

# Sources(namesOrIds) → {Object}

Returns a handle for fetching documents across multiple sources at once.

Source names (e.g. ['Orders', 'Inventory']) are resolved to sourceIds via the local cache. Results are grouped by source name in the response.

Parameters:

Name	Type	Description
`namesOrIds`	`Array.<string>`	List of source names or sourceIds.

View Source services/InsightsService.class.js, line 243

Returns:

Type: Object

Example

const { result } = await insights.Sources(['Orders', 'Inventory'])
  .Docs.find({ humanId: 'HT-4d44d' })
// result.total, result.Orders, result.Inventory

# delete(call, bodyopt) → {Promise.<ServiceResponse>}

Sends an authenticated DELETE request.

Parameters:

Name	Type	Attributes	Description
`call`	`string`		Path relative to `serviceUrl`.
`body`	`*`	<optional>	Optional request body, serialised to JSON.

Overrides:

ScenidCloudService#delete

View Source services/ScenidCloudService.class.js, line 152

Returns:

Type: Promise.<ServiceResponse>

# get(call) → {Promise.<ServiceResponse>}

Sends an authenticated GET request.

Parameters:

Name	Type	Description
`call`	`string`	Path relative to `serviceUrl`.

Overrides:

ScenidCloudService#get

View Source services/ScenidCloudService.class.js, line 122

Returns:

Type: Promise.<ServiceResponse>

# async makeRequest(method, call, bodyopt) → {Promise.<ServiceResponse>}

Makes an authenticated HTTP request to the service and returns the parsed response.

Acquires a token, constructs the full endpoint URL, serialises the body as JSON when provided, and parses the JSON response. Throws a typed error on network failure or non-JSON responses.

Parameters:

Name	Type	Attributes	Description
`method`	`string`		HTTP method (`GET`, `POST`, `PUT`, or `DELETE`).
`call`	`string`		Path to call relative to `serviceUrl` (leading `/` optional).
`body`	`*`	<optional>	Request body. Serialised to JSON unless already a string.