iOS Attribution
POST https://api.amplitude.com/attribution
Required Event Argument Keys
You must include the following keys within the event argument:
| Required Key | Description | Example |
|---|---|---|
event_type | String. Prefix with brackets \[YOUR COMPANY\]. | \[YOUR COMPANY\] Install |
platform | String. Either iosor android. | ios |
idfa or idfv | Required for iOS. String. The Identifier for Advertiser or the Identifier for Vendor. | AEBE52E7-03EE-455A-B3C4-E57283966239 |
adid | Required for Android. String. The Google AdID, or Amazon Advertising ID for Amazon devices. | AEBE52E7-03EE-455A-B3C4-E57283966239 |
Note: For iOS devices, you can send either the IDFA or the IDFV but you must send at least one.
Optional Event Argument Keys
These optional keys are available.
| Additional Key | Type | Description | Example |
|---|---|---|---|
android_id | string | (Android) The Android ID | AEBE52E7-03EE-455A-B3C4-E57283966239 |
user_properties | dictionary | A dictionary of attribution properties prefixed with brackets \[YOUR COMPANY\]. | {\[YOUR COMPANY\] media source: |
time | long | Timestamp of the event in milliseconds since epoch. | 1396381378123, will be set to the upload time by default |
Request Body
[{"name"=>"api_key", "value"=>"{{api_key}}", "datatype"=>"string"}, {"name"=>"event", "value"=>"{\"event_type\":\"[YOUR COMPANY] Install\", \"idfa\": \"AEBE52E7-03EE-455A-B3C4-E57283966239\", \"user_properties\": {\"[YOUR COMPANY] media source\": \"facebook\", \"[YOUR COMPANY] campaign\": \"refer-a-friend\"}, \"platform\": \"ios\"}", "datatype"=>"string"}]
RESPONSES
status: OK
"success"