Skip to content
LyftData Docs

LyftData Analytics

LyftData Analytics (lyftdata-analytics)

Section titled “LyftData Analytics (lyftdata-analytics)”

Emit selected, bounded analytics observations into LyftData’s built-in analytics store.

Analytics json

Minimal example

Section titled “Minimal example”
output:
  lyftdata-analytics:
    stream: ~
JSON 
{
  "output": {
    "lyftdata-analytics": {
      "stream": null
    }
  }
}

Contents

Section titled “Contents”

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Analytics

Section titled “Analytics”
Analytics
Field Type Required Description
stream string ✅ Low-cardinality analytics stream namespace, such as orders or data_quality.

Batching

Section titled “Batching”
Batching
Field Type Required Description
sequence-field field (string) Optional JSON pointer or dotted path selecting a deterministic batch sequence.
Examples: data_field
batch Batch Logical batching hints for analytics observations.

Dimensions

Section titled “Dimensions”
Dimensions
Field Type Required Description
dimensions map (string) Low-cardinality dimensions to extract as analytics labels.

Labels

Section titled “Labels”
Labels
Field Type Required Description
static-labels map (string) Static labels attached to every observation emitted by this output.

Measures

Section titled “Measures”
Measures
Field Type Required Description
measures map (object) Numeric measures to extract from each event.

Privacy

Section titled “Privacy”
Privacy
Field Type Required Description
payload-policy Payload Policy Controls whether event payload samples may be included with analytics observations.

Time

Section titled “Time”
Time
Field Type Required Description
timestamp-field field (string) Optional JSON pointer or dotted path selecting the observation timestamp.
Examples: data_field

Schema

Section titled “Schema”

Batch Fields

Section titled “Batch Fields”
Field Type Required Description
fixed-size ✓ number (integer) maximum number of events in an output batch.
Examples: 42, 1.2e-10
max-bytes ✓ number (integer) Close the batch before adding an event that would make the serialized request payload exceed this many bytes.
Examples: 42, 1.2e-10
mode Mode ✅ If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
Allowed values: fixed, document
timeout time-interval (string) ✅ interval after which the batch is sent, to keep throughput going (default 100ms).
Default: 100ms
Examples: 500ms, 2h
header multiline-text (string) put a header line before the batch.
footer multiline-text (string) put a header line after the last line of the batch.
use-document-marker ✓ boolean (bool) Enrich the job metadata with a document marker (for document handling in batch mode).
Default: false
wrap-as-json ✓ boolean (bool) Format the output batch as a JSON array.
Default: false

Payload Policy Fields

Section titled “Payload Policy Fields”
Field Type Required Description
include-sample ✓ boolean (bool) Include a bounded redacted sample payload for diagnostics. Disabled by default.
Default: false

Dimensions Table

Section titled “Dimensions Table”
Dimension Field
status /status

Static Labels Table

Section titled “Static Labels Table”
Label Value
source facebook-pages

Measures Table

Section titled “Measures Table”
Measure Config
records

Batch - Mode Options

Section titled “Batch - Mode Options”
Value Aliases Name Description
fixed fixed
document document