API Docs for: 4.0.6
Show:

ZipsceneDataClient Class

Defined in: lib/zipscene-data-client.js:8

Client for accessing Zipscene DMP profile group data.

Constructor

ZipsceneDataClient

(
  • rpcClient
  • profileType
  • [options]
  • fileServiceClient
)

Defined in lib/zipscene-data-client.js:8

Parameters:

  • rpcClient ZipsceneRPCClient
    • The DMP RPC client to use
  • profileType String
    • Profile type as it appears in method names (ie, "person")
  • [options] Object optional
  • fileServiceClient ZipsceneRPCClient
    • RPC client for the file service

Item Index

Methods

Methods

aggregate

(
  • query
  • agg
  • [options]
)
Mixed

Defined in lib/zipscene-data-client.js:192

Executes one or more aggregates.

Parameters:

  • query Object
  • agg Object | Object
    • Aggregate spec, or array of aggregate specs
  • [options] Object optional
    • sort String
    • limit Number
    • scanLimit Number
    • timeout Number

Returns:

Mixed:
  • Aggregate results, or array of aggregate results if 'agg' is an array

count

(
  • query
  • [options}
  • options.timeout
)
Number

Defined in lib/zipscene-data-client.js:176

Executes a count.

Parameters:

  • query Object
  • [options} Object
  • options.timeout Number

Returns:

Number:

export

(
  • query
  • [options]
)
Readable

Defined in lib/zipscene-data-client.js:64

Exports a DMP data stream.

Parameters:

  • query Object
  • [options] Object optional
    • fields String
    • sort String
    • limit Number
    • timeout Number
    • strategy String
      • Export strategy, either 'file' to download via file service or 'stream' to stream directly from DMP

Returns:

Readable:
  • A readable object stream

get

(
  • id
  • [options]
)
Object

Defined in lib/zipscene-data-client.js:26

Gets a single object by id.

Parameters:

  • id String
  • [options] Object optional
    • fields String
    • timeout Number

Returns:

Object:
  • The request object

query

(
  • query
  • [options]
)
Object

Defined in lib/zipscene-data-client.js:43

Executes a query.

Parameters:

  • query Object
  • [options] Object optional
    • fields String
    • sort String
    • skip Number
    • limit Number
    • timeout Number

Returns:

Object:
  • Array of results