API Data Provider - Online Help

Identify

Used to set the User ID for a particular Device ID or update user properties of a particular user without sending an event.

Input

Name Type Description
UserId String A UUID (unique user ID) specified by you.Note: If you send a request with a user_id that is not in the Amplitude system yet, then the user tied to the UserId will not be marked new until their first event.
DeviceId String A device specific identifier, such as the Identifier for Vendor (IDFV) on iOS.
UserProperties String A JSON object that contains a dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. See Amplitude API documentation for an example: https://developers.amplitude.com/?http#request-format---idenify.
Groups String This feature is only available to Enterprise customers who have purchased the Accounts add-on. A JSON object that contains A dictionary of key-value pairs that represent groups of users. You can only track up to 5 groups. See Amplitude API documentation for an example: https://developers.amplitude.com/?http#request-format---idenify.
AppVersion String What version of the app the user is on..
Platform String What platform is sending the data.
OsName String What mobile operating system or browser the user is on.
OsVersion String What version of the mobile operating system or browser the user is on.
DeviceBrand String What device brand the user is on.
DeviceManufacturer String What device manufacturer the user is on.
DeviceModel String What device model the user is on.
Carrier String What carrier the user has.
Country String What country the user is in.
Region String What geographical region the user is in.
City String What city the user is in.
Dma String The Designated Market Area of the user.
Language String What language the user has set.
Paying String Whether the user is paying or not.
StartVersion String What version of the app the user was first on.

Result Set Columns

Name Type Description
Code String

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0