Amplitude Resource Node

The Amplitude Resource integrates with the Amplitude API to make it easy to surface your Amplitude data within Dynaboard.

Properties

API Key

PropamplitudeNode.apiKey
Type({ ref: string } | undefined)
Defaultundefined

The API key to use when connecting to the Amplitude API.

Secret Key

PropamplitudeNode.secretKey
Type({ ref: string } | undefined)
Defaultundefined

The secret key to use when connecting to the Amplitude API.

Actions

Get Active or New Users

Gets the number of active or new users.

ParameterTypeDefault
start(string | undefined)undefined
end(string | undefined)undefined
typ(string | undefined)undefined
interval(string | undefined)undefined
segment(string | undefined)undefined
groupBy(string | undefined)undefined

Get Sessions by Time Range

Gets the number of sessions for each predefined length ("bucket") period during a specified date range.

ParameterTypeDefault
start(string | undefined)undefined
end(string | undefined)undefined
timeHistogramConfigBinMin(string | undefined)undefined
timeHistogramConfigBinMax(string | undefined)undefined
timeHistogramConfigBinSize(string | undefined)undefined
timeHistogramConfigBinTimeUnit(string | undefined)undefined

Get Data from Existing Chart

Gets the JSON results from any existing (saved) chart via chart ID.

ParameterTypeDefault
chartIDstringundefined

Get Average Session Length

Gets the average session length (in seconds) for each day in the specified date range.

ParameterTypeDefault
start(string | undefined)undefined
end(string | undefined)undefined

Get Average Sessions per User

Gets the average number of sessions per user on each day in the specified date range.

ParameterTypeDefault
start(string | undefined)undefined
end(string | undefined)undefined

Get User Composition

Get the distribution of users across values of a user property in the specified date range.

ParameterTypeDefault
start(string | undefined)undefined
end(string | undefined)undefined
property(string | undefined)undefined

Get Event Segmentation

Gets metrics for an event with segmentation.

ParameterTypeDefault
event(string | undefined)undefined
event2(string | undefined)undefined
metric(string | undefined)undefined
start(string | undefined)undefined
end(string | undefined)undefined
interval(string | undefined)undefined
segment(string | undefined)undefined
group(string | undefined)undefined
limit(string | undefined)undefined
formula(string | undefined)undefined
rollingWindow(string | undefined)undefined
rollingAverage(string | undefined)undefined

Get Funnel Analysis

Gets funnel drop-off and conversion rates.

ParameterTypeDefault
event(string | undefined)undefined
start(string | undefined)undefined
end(string | undefined)undefined
mode(string | undefined)undefined
userType(string | undefined)undefined
segment(string | undefined)undefined
groupBy(string | undefined)undefined
conversionWindow(string | undefined)undefined
limit(string | undefined)undefined

Get Retention Analysis

Gets a user retention for specific starting and returning actions.

ParameterTypeDefault
startActionEvent(string | undefined)undefined
returningActionEvent(string | undefined)undefined
retentionType(string | undefined)undefined
daysWithinBracket(string | undefined)undefined
start(string | undefined)undefined
end(string | undefined)undefined
interval(string | undefined)undefined
segment(string | undefined)undefined
groupBy(string | undefined)undefined

Get User Activity

Gets a user summary and their most recent 1000 events plus all of the events from their most recent session.

ParameterTypeDefault
user(string | undefined)undefined
limit(string | undefined)undefined
offset(string | undefined)undefined

Search Users

Searches for a user with a specified Amplitude ID, Device ID, User ID, or User ID prefix.

ParameterTypeDefault
id(string | undefined)undefined

Get Real-time Active Users

Gets active user numbers with minute granularity for the last two days.

ParameterTypeDefault
interval(string | undefined)undefined

Get Lifetime Value

Get the lifetime value of new users.

ParameterTypeDefault
start(string | undefined)undefined
end(string | undefined)undefined
metric(string | undefined)undefined
interval(string | undefined)undefined
segment(string | undefined)undefined
groupBy(string | undefined)undefined

Get Annotations

Gets the annotations configured in the app.

ParameterTypeDefault