Amplitude Resource

The Amplitude Resource integrates with the Amplitude API (opens in a new tab) to make it easy to surface your Amplitude data within Dynaboard.

Properties

Environment Profiles

Prop	`profiles`
Type	`array`
Default	`[ { 'environment': '' } ]`

The profiles configured for this resource in an environment

Environment Profile

Prop	`profiles[]`
Type	`object`
Default	`undefined`

A profile of this resource for an environment

API Key

Prop	`profiles[].apiKey`
Type	`({ ref: string } \| undefined)`
Default	`undefined`

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

Secret Key

Prop	`profiles[].secretKey`
Type	`({ ref: string } \| undefined)`
Default	`undefined`

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

Environment

Prop	`profiles[].environment`
Type	`string`
Default	`undefined`

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.

Parameter	Type	Default
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`typ`	`string`	`undefined`
`interval`	`string`	`undefined`
`segment`	`string`	`undefined`
`groupBy`	`string`	`undefined`

Get Sessions by Time Range

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

Parameter	Type	Default
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`timeHistogramConfigBinMin`	`string`	`undefined`
`timeHistogramConfigBinMax`	`string`	`undefined`
`timeHistogramConfigBinSize`	`string`	`undefined`
`timeHistogramConfigBinTimeUnit`	`string`	`undefined`

Get Data from Existing Chart

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

Parameter	Type	Default
`chartID`	`string`	`undefined`

Get Average Session Length

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

Parameter	Type	Default
`start`	`string`	`undefined`
`end`	`string`	`undefined`

Get Average Sessions per User

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

Parameter	Type	Default
`start`	`string`	`undefined`
`end`	`string`	`undefined`

Get User Composition

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

Parameter	Type	Default
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`property`	`string`	`undefined`

Get Event Segmentation

Gets metrics for an event with segmentation.

Parameter	Type	Default
`event`	`string`	`undefined`
`event2`	`string`	`undefined`
`metric`	`string`	`undefined`
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`interval`	`string`	`undefined`
`segment`	`string`	`undefined`
`group`	`string`	`undefined`
`limit`	`string`	`undefined`
`formula`	`string`	`undefined`
`rollingWindow`	`string`	`undefined`
`rollingAverage`	`string`	`undefined`

Get Funnel Analysis

Gets funnel drop-off and conversion rates.

Parameter	Type	Default
`event`	`string`	`undefined`
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`mode`	`string`	`undefined`
`userType`	`string`	`undefined`
`segment`	`string`	`undefined`
`groupBy`	`string`	`undefined`
`conversionWindow`	`string`	`undefined`
`limit`	`string`	`undefined`

Get Retention Analysis

Gets a user retention for specific starting and returning actions.

Parameter	Type	Default
`startActionEvent`	`string`	`undefined`
`returningActionEvent`	`string`	`undefined`
`retentionType`	`string`	`undefined`
`daysWithinBracket`	`string`	`undefined`
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`interval`	`string`	`undefined`
`segment`	`string`	`undefined`
`groupBy`	`string`	`undefined`

Get User Activity

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

Parameter	Type	Default
`user`	`string`	`undefined`
`limit`	`string`	`undefined`
`offset`	`string`	`undefined`

Search Users

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

Parameter	Type	Default
`id`	`string`	`undefined`

Get Real-time Active Users

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

Parameter	Type	Default
`interval`	`string`	`undefined`

Get Lifetime Value

Get the lifetime value of new users.

Parameter	Type	Default
`start`	`string`	`undefined`
`end`	`string`	`undefined`
`metric`	`string`	`undefined`
`interval`	`string`	`undefined`
`segment`	`string`	`undefined`
`groupBy`	`string`	`undefined`

Get Annotations

Gets the annotations configured in the app.

Parameter	Type	Default

Airtable BigQuery