ByteChefComponents
Amplitude
Build better products by turning your user data into meaningful insights, using Amplitude's digital analytics platform and experimentation tools.
Categories: Analytics
Type: amplitude/v1
Connections
Version: 1
custom
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| api_key | API Key | STRING | The API key for the Amplitude project | true |
| region | Region | STRING Optionsapi2, api.eu | Environment region you wish to access the API in. | true |
Actions
Create Attribution Event
Name: createAttributionEvent
Creates attribution event using Attribution API.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| event_type | Event Type | STRING | The event info. Prefix with brackets [YOUR COMPANY]. | true |
| platform | Platform | STRING Optionsios, android | Platform which the event will occur on. | true |
| identifier | Identifier | OBJECT Properties{STRING(key), STRING(value)} | Identifier of the platform. | true |
| user_properties | User Properties | ARRAY Items[{STRING(key), STRING(value)}($property)] | A dictionary of attribution properties prefixed with brackets [YOUR COMPANY]. | false |
Example JSON Structure
{
"label" : "Create Attribution Event",
"name" : "createAttributionEvent",
"parameters" : {
"event_type" : "",
"platform" : "",
"identifier" : {
"key" : "",
"value" : ""
},
"user_properties" : [ {
"key" : "",
"value" : ""
} ]
},
"type" : "amplitude/v1/createAttributionEvent"
}Output
Type: STRING
Create or Update User
Name: createOrUpdateUser
Creates or updates user without sending an event.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| id | ID | STRING Optionsuser_id, device_id | Choose to create or update a user or a device. | true |
| device_id | Device ID | STRING | A device specific identifier, such as the Identifier for Vendor (IDFV) on iOS. | true |
| user_id | User ID | STRING | Unique user ID specified by you. If you send a request with a user ID that's not in the Amplitude system, new user will be created (e.g. email address). | true |
| user_properties | User Properties | ARRAY Items[{STRING(key), STRING(value)}($property)] | A dictionary of attribution properties prefixed with brackets [YOUR COMPANY]. | false |
| platform | Platform | STRING | The platform that's sending the data. | false |
| os_name | Operating System Name | STRING | The mobile operating system or browser the user is on. | false |
| device_brand | Device Brand | STRING | The device brand the user is on. | false |
| carrier | Carrier | STRING | The carrier of the device the user is on. | false |
| country | Country | STRING | The country the user is in. | false |
| city | City | STRING | The city the user is in. | false |
| dma | Designated Market Area | STRING | The Designated Market Area of the user. | false |
| language | Language | STRING | The language the user has set. | false |
Example JSON Structure
{
"label" : "Create or Update User",
"name" : "createOrUpdateUser",
"parameters" : {
"id" : "",
"device_id" : "",
"user_id" : "",
"user_properties" : [ {
"key" : "",
"value" : ""
} ],
"platform" : "",
"os_name" : "",
"device_brand" : "",
"carrier" : "",
"country" : "",
"city" : "",
"dma" : "",
"language" : ""
},
"type" : "amplitude/v1/createOrUpdateUser"
}Output
Type: STRING