• Reference
  • Nodes
  • Resources
  • Amplitude

Amplitude Resource

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

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

API Key

Propprofiles[].apiKey
Type({ ref: string } | undefined)

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

Secret Key

Propprofiles[].secretKey
Type({ ref: string } | undefined)

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

Environment

Propprofiles[].environment
Typestring

The name of the environment with which this profile is associated

Actions

Get Active or New Users

Gets the number of active or new users.

ParameterTypeDefault
startstringundefined
endstringundefined
typstringundefined
intervalstringundefined
segmentstringundefined
groupBystringundefined

Get Sessions by Time Range

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

ParameterTypeDefault
startstringundefined
endstringundefined
timeHistogramConfigBinMinstringundefined
timeHistogramConfigBinMaxstringundefined
timeHistogramConfigBinSizestringundefined
timeHistogramConfigBinTimeUnitstringundefined

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
startstringundefined
endstringundefined

Get Average Sessions per User

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

ParameterTypeDefault
startstringundefined
endstringundefined

Get User Composition

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

ParameterTypeDefault
startstringundefined
endstringundefined
propertystringundefined

Get Event Segmentation

Gets metrics for an event with segmentation.

ParameterTypeDefault
eventstringundefined
event2stringundefined
metricstringundefined
startstringundefined
endstringundefined
intervalstringundefined
segmentstringundefined
groupstringundefined
limitstringundefined
formulastringundefined
rollingWindowstringundefined
rollingAveragestringundefined

Get Funnel Analysis

Gets funnel drop-off and conversion rates.

ParameterTypeDefault
eventstringundefined
startstringundefined
endstringundefined
modestringundefined
userTypestringundefined
segmentstringundefined
groupBystringundefined
conversionWindowstringundefined
limitstringundefined

Get Retention Analysis

Gets a user retention for specific starting and returning actions.

ParameterTypeDefault
startActionEventstringundefined
returningActionEventstringundefined
retentionTypestringundefined
daysWithinBracketstringundefined
startstringundefined
endstringundefined
intervalstringundefined
segmentstringundefined
groupBystringundefined

Get User Activity

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

ParameterTypeDefault
userstringundefined
limitstringundefined
offsetstringundefined

Search Users

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

ParameterTypeDefault
idstringundefined

Get Real-time Active Users

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

ParameterTypeDefault
intervalstringundefined

Get Lifetime Value

Get the lifetime value of new users.

ParameterTypeDefault
startstringundefined
endstringundefined
metricstringundefined
intervalstringundefined
segmentstringundefined
groupBystringundefined

Get Annotations

Gets the annotations configured in the app.

ParameterTypeDefault
Last updated on November 1, 2022