Adjust
App · 21 actions
Work with Adjust, the mobile measurement platform: pull reports, manage links and deep links, send events and ad revenue from your server, handle test devices and erasure requests, and start workflows from installs, events and other callbacks.
Actions
| Action | What it does |
|---|---|
| Blocklist link | Stop a link recording clicks, impressions and callbacks, such as one sending fraudulent traffic. |
| Create deep link | Create a deep link from one of your custom links that opens a place in your app, short (such as example.go.link/czWsH) unless you ask for the long form. |
| Create link | Create a link for an app, or a sublink under one of its links. |
| Erase user data | Act on a user's right to erasure (GDPR, CCPA): Adjust permanently deletes the device's data for this app and stops measuring it. |
| Export report as CSV | Get the same report as 'Get report' as CSV text, ready to save as a file or put in a spreadsheet. |
| Forget test device | Clear a test device's history from an app, so its next install counts as new. |
| Get report | Get a Datascape report: the chosen metrics, such as installs and ad spend, split by the chosen dimensions, such as day and network, with totals. |
| Get short link | Get a short link's long target, branded domain and expiry date. |
| Get short link quota | See how many short links your TrueLink contract allows, how many are left, and when the contract ends. |
| Inspect device | Look a device up in an app by its advertising ID: its Adjust ID (ADID), the link it came from, install and last session times, and its last events. |
| List apps | List the apps in your Adjust account, with each one's app token. |
| List events | List your apps' in-app events, with each one's slug (its name in reports) and event tokens. |
| List links | List an app's links (network level), with their click and impression URLs. |
| List partners | List Adjust's partners (ad networks) with their IDs, and whether each can send ad spend data. |
| List report filter values | List the values a report can be narrowed or split by, such as your networks, partners, countries or currencies. |
| List sublinks | List the sublinks (campaign, ad group or creative level) under one of an app's links. |
| Remove link from blocklist | Let a blocklisted link record clicks, impressions and callbacks again. |
| Send ad revenue | Record ad revenue a device earned you, from your own ad mediation data, within 28 days. |
| Send in-app event | Record an in-app event, such as a purchase, for a device from your server. |
| Update link | Attach a partner to a link, or turn its ad spend data on or off. |
| Update short link | Point an existing short link somewhere new. |
Blocklist link
Stop a link recording clicks, impressions and callbacks, such as one sending fraudulent traffic. Users it already brought in keep their attribution.
Inputs
- App
app_tokentext - The app whose link it is. Only used to pick the link.
- Link
link_tokentextRequired - The link. Pick one of the app's links, or give its token.
Outputs
blocklistedtrue/false- Whether the link is now blocklisted
linkobject- The link
Example output
{
"blocklisted": true,
"link": {
"adgroup_token": null,
"allow_partner_linking": true,
"archived": false,
"attribution_partner": false,
"campaign_token": null,
"click_url": "https://app.adjust.com/abc123",
"creative_token": null,
"has_subtrackers": true,
"impression_url": "https://view.adjust.com/impression/abc123",
"label": "Twitter installs",
"name": "Twitter installs",
"network_token": "abc123",
"path": "",
"settings": {
"additional_parameters": null,
"attribution_settings": null,
"blacklisted": true,
"campaign_structure": null,
"cost_data": false,
"cost_data_parameters": null,
"partner_cost_data_parameters": null,
"partner_display_name": null,
"partner_id": null,
"tracking_parameters": null
},
"token": "abc123",
"url": "https://app.adjust.com/abc123",
"urls": {
"show": "/api/trackers/abc123.json",
"update": "/api/trackers/abc123.json"
},
"visible": true
}
}Create deep link
Create a deep link from one of your custom links that opens a place in your app, short (such as example.go.link/czWsH) unless you ask for the long form. Needs Adjust's TrueLink package.
Inputs
- App
app_tokentext - The app whose custom link to use. Only used to pick the link.
- Custom link
link_tokentextRequired - The custom link the deep link is made from.
- In-app path
deep_link_pathtext - Where in the app it opens, such as /product/42. For an app on one platform.
- iOS in-app path
ios_deep_link_pathtext - Where it opens in the iOS app, for an app on both platforms.
- Android in-app path
android_deep_link_pathtext - Where it opens in the Android app, for an app on both platforms.
- Web page instead
web_deep_link_urltext - A web page to open instead of a place in the app.
- Redirect
redirecttext - Where people without the app go, instead of the app store.
- Fallback page
fallbacktext - Where people on a computer or other platform go.
- Campaign
campaigntext - A campaign name to report the link under, in place of the link's own.
- Ad group
adgrouptext - An ad group name to report the link under.
- Creative
creativetext - A creative name to report the link under.
- Label
labeltext - Your own data on the link, such as a referral ID.
- Extra link parameters
custom_parametersobject - Your own keys and values added to the link, such as a coupon code.
- Short link
shorten_urltrue/false - Make a short link, which counts against your quota. Turn off for the long form only. On by default.
- Short link ending
short_tokentext - Your own ending for the short link, such as campaign2026.
Outputs
long_urltext- The full long link
short_tokentext- The short link's ending, empty for a long link
urltext- The link to share: short, or long if shortening was off
Example output
{
"long_url": "https://example.go.link/custom-path?adj_t=1c52mluz&adj_redirect=https%3A%2F%2Fexample.com%2Fredirect",
"short_token": "czWsH",
"url": "https://example.go.link/czWsH"
}Create link
Create a link for an app, or a sublink under one of its links. Returns its token and click URL.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Name
nametextRequired - The new link's name, such as a network or campaign.
- Under link
parent_tokentext - Make it a sublink of this link. Leave empty for a new top-level link.
Outputs
linkobject- The link
Example output
{
"link": {
"archived": false,
"click_url": "https://app.adjust.com/xyz456?idfa={idfa}",
"cost_data_enabled": false,
"has_subtrackers": false,
"impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1",
"label": "SpringCampaign",
"level": 2,
"name": "Adroll::SpringCampaign",
"partner_id": 3,
"token": "xyz456",
"url": "https://app.adjust.com/xyz456"
}
}Erase user data
Act on a user's right to erasure (GDPR, CCPA): Adjust permanently deletes the device's data for this app and stops measuring it. This can't be undone.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Device ID type
device_id_typetextRequired - Which kind of ID 'Device ID' is.One of:
adid(Adjust device ID),gps_adid(Google advertising ID (Android)),idfa(IDFA (iOS)),idfv(IDFV (iOS)),fire_adid(Amazon Fire advertising ID),win_adid(Windows advertising ID). - Device ID
device_idtextRequired - The ID of the user's device.
Outputs
app_tokentext- The app
device_idtext- The device ID sent
device_id_typetext- Which kind of device ID was sent
requestedtrue/false- Always true once Adjust has taken the request
statustext- What Adjust answered
Example output
{
"app_token": "kwrqhymtnsr2",
"device_id": "9C5CBC1D-4F42-4764-A5E6-84DAF3D24707",
"device_id_type": "idfa",
"requested": true,
"status": "OK"
}Export report as CSV
Get the same report as 'Get report' as CSV text, ready to save as a file or put in a spreadsheet.
Inputs
- Metrics
metricslistRequired - What to count, such as Installs, Ad spend or an event's count. Choose at least one.
- Break down by
dimensionslistRequired - How to split the rows, such as Day, App and Network. Choose at least one.One or more of:
day,hour,week,month,quarter,year,app,app_token(App token),store_id(Store app ID),store_type(Store), and 25 more. - Apps
app_tokenslist - Only these apps. Leave empty for every app.
- Dates
date_rangetext - Which days the report covers. Ignored when a start or end date is given. Defaults to the last 7 days, to yesterday.One of:
-7d:-1d(Last 7 days, to yesterday (default)),-30d:-1d(Last 30 days, to yesterday),yesterday,today(Today so far),this_week(This week),last_week(Last week),this_month(This month),this_month_until_yesterday(This month, to yesterday),last_month(Last month). - From
start_datedate - The first day of the report.
- To
end_datedate - The last day of the report. Leave empty for just the first day.
- Operating systems
os_nameslist - Only these operating systems.One or more of:
android,ios,windows,windows-phone(Windows Phone),macos,linux,webos,server,bada,blackberry,symbian,unknown. - Countries
country_codeslist - Only users in these countries.
- Networks
networkslist - Only these networks, such as Organic or AppLovin.
- Ad spend source
ad_spend_modetext - Where ad spend figures come from: Adjust's attribution, the network, or both.One of:
adjust(Attribution (Adjust)),network,mixed. - Credit activity to
attribution_sourcetext - Whether in-app activity counts for the install source only, or is shared with later reattribution sources (the default).One of:
dynamic(Install and later sources (default)),first(Install source only). - Attribution types
attribution_typeslist - Only engagements of these kinds.One or more of:
click,impression,engaged_ad(Engaged ad). - Reattributed users
reattributedtext - Include, leave out, or keep only users who came back through a new source.One of:
all(All users (default)),false(Leave out reattributed users),true(Only reattributed users). - Currency
currencytext - The currency money figures are shown in, such as USD.
- Time zone offset
utc_offsettext - The time zone days are counted in, as an offset such as +01:00. Defaults to UTC.
- Sort by
sorttext - Metrics or dimensions to sort by, separated by commas. Put - in front for highest first, such as -installs.
- Sandbox data
sandboxtrue/false - Report on test (sandbox) data instead of live data.
Outputs
columnslist- The CSV's column names
csvtext- The report as CSV, a header row first
date_periodtext- The dates the report covers, as Adjust was asked
row_countnumber- How many rows, not counting the header
Example output
{
"columns": [
"day",
"app",
"installs"
],
"csv": "day,app,installs\n2026-11-16,Test app,10\n",
"date_period": "-7d:-1d",
"row_count": 1
}Forget test device
Clear a test device's history from an app, so its next install counts as new. Needs Admin or Editor permission. For a real user's erasure request, use 'Erase user data' instead.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Adjust device ID
adidtextRequired - The device's Adjust ID (ADID), from 'Inspect device'.
Outputs
adidtext- The device forgotten
app_tokentext- The app it was forgotten in
forgottentrue/false- Always true once Adjust has forgotten it
messagetext- What Adjust answered
Example output
{
"adid": "acf8534f2f052395e617a38730682ccc",
"app_token": "gwzpeepw8uf8",
"forgotten": true,
"message": "Forgot device"
}Get report
Get a Datascape report: the chosen metrics, such as installs and ad spend, split by the chosen dimensions, such as day and network, with totals.
Inputs
- Metrics
metricslistRequired - What to count, such as Installs, Ad spend or an event's count. Choose at least one.
- Break down by
dimensionslistRequired - How to split the rows, such as Day, App and Network. Choose at least one.One or more of:
day,hour,week,month,quarter,year,app,app_token(App token),store_id(Store app ID),store_type(Store), and 25 more. - Apps
app_tokenslist - Only these apps. Leave empty for every app.
- Dates
date_rangetext - Which days the report covers. Ignored when a start or end date is given. Defaults to the last 7 days, to yesterday.One of:
-7d:-1d(Last 7 days, to yesterday (default)),-30d:-1d(Last 30 days, to yesterday),yesterday,today(Today so far),this_week(This week),last_week(Last week),this_month(This month),this_month_until_yesterday(This month, to yesterday),last_month(Last month). - From
start_datedate - The first day of the report.
- To
end_datedate - The last day of the report. Leave empty for just the first day.
- Operating systems
os_nameslist - Only these operating systems.One or more of:
android,ios,windows,windows-phone(Windows Phone),macos,linux,webos,server,bada,blackberry,symbian,unknown. - Countries
country_codeslist - Only users in these countries.
- Networks
networkslist - Only these networks, such as Organic or AppLovin.
- Ad spend source
ad_spend_modetext - Where ad spend figures come from: Adjust's attribution, the network, or both.One of:
adjust(Attribution (Adjust)),network,mixed. - Credit activity to
attribution_sourcetext - Whether in-app activity counts for the install source only, or is shared with later reattribution sources (the default).One of:
dynamic(Install and later sources (default)),first(Install source only). - Attribution types
attribution_typeslist - Only engagements of these kinds.One or more of:
click,impression,engaged_ad(Engaged ad). - Reattributed users
reattributedtext - Include, leave out, or keep only users who came back through a new source.One of:
all(All users (default)),false(Leave out reattributed users),true(Only reattributed users). - Currency
currencytext - The currency money figures are shown in, such as USD.
- Time zone offset
utc_offsettext - The time zone days are counted in, as an offset such as +01:00. Defaults to UTC.
- Sort by
sorttext - Metrics or dimensions to sort by, separated by commas. Put - in front for highest first, such as -installs.
- Sandbox data
sandboxtrue/false - Report on test (sandbox) data instead of live data.
Outputs
date_periodtext- The dates the report covers, as Adjust was asked
row_countnumber- How many rows
rowslist- The report's rows
totalsobject- Each metric's total over every row
warningslist- Anything Adjust warned about
Example output
{
"date_period": "-7d:-1d",
"row_count": 1,
"rows": [
{
"app": "Test app",
"attr_dependency": {
"partner": "Organic",
"partner_id": "-300"
},
"cost": "0.0",
"day": "2026-11-16",
"installs": "10",
"partner_name": "Organic"
}
],
"totals": {
"cost": 0.0,
"installs": 10.0
},
"warnings": []
}Get short link
Get a short link's long target, branded domain and expiry date.
Inputs
- Short link
short_tokentextRequired - The short link, or the part after its domain (such as czWsH).
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
Outputs
short_linkobject- The short link
Example output
{
"short_link": {
"created_at": "2025-03-19T13:31:31Z",
"expires_at": "2025-10-08T17:04:24.201134367Z",
"token": "4IlkC",
"ulink": "example",
"updated_at": null,
"url": "https://example.go.link/?adj_t=1g41cvql_1gb5zq24&adj_redirect=https%3A%2F%2Fexample.com%2Fredirect"
}
}Get short link quota
See how many short links your TrueLink contract allows, how many are left, and when the contract ends.
Inputs
None.
Outputs
quotaobject- The short link quota
Example output
{
"quota": {
"contract_end_date": "2025-12-31",
"contract_start_date": "2024-12-31",
"contract_status": "active",
"limit": 100000,
"remaining": 86129
}
}Inspect device
Look a device up in an app by its advertising ID: its Adjust ID (ADID), the link it came from, install and last session times, and its last events.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Advertising ID
advertising_idtextRequired - The device's IDFA, Google advertising ID, Android ID, Fire advertising ID or Windows advertising ID.
Outputs
adidtext- The device's Adjust ID (ADID)
deviceobject- What Adjust knows about the device
Example output
{
"adid": "acf8534f2f052395e617a38730682ccc",
"device": {
"Adid": "acf8534f2f052395e617a38730682ccc",
"AdvertisingId": "1234-5678-9012-3456",
"ClickTime": "0001-01-01T00:00:00Z",
"Environment": "sandbox",
"FirstTracker": "zr5vueb",
"FirstTrackerName": "Organic",
"InstallTime": "2015-08-19T03:42:03Z",
"LastEventsInfo": {
"kgfcul": {
"name": "Copy IDFA",
"time": "2024-07-18T10:01:16Z"
}
},
"LastSdkVersion": "ios4.37.2",
"LastSessionTime": "2017-07-29T17:29:17Z",
"State": "installed",
"Tracker": "abc123",
"TrackerName": "Organic"
}
}List apps
List the apps in your Adjust account, with each one's app token.
Inputs
- Search
searchtext - Only those whose name or ID contains this text.
Outputs
appslist- The apps; each one's id is its app token
countnumber- How many
Example output
{
"apps": [
{
"description": "",
"formatting": null,
"id": "4zb92bmajmrd",
"name": "Test app",
"section": "",
"short_name": ""
}
],
"count": 1
}List events
List your apps' in-app events, with each one's slug (its name in reports) and event tokens.
Inputs
- Apps
app_tokenslist - Only these apps' events. Leave empty for every app.
- Search
searchtext - Only those whose name or ID contains this text.
Outputs
countnumber- How many
eventslist- The events
Example output
{
"count": 1,
"events": [
{
"app_token": [
"4zb92bmajmrd"
],
"app_token_x_event_tokens_mapping": {
"4zb92bmajmrd": [
"abc123"
]
},
"description": "",
"formatting": "money",
"id": "purchase",
"is_skad_event": false,
"name": "Purchase event",
"section": "Revenue",
"short_name": "PUR",
"tokens": [
"abc123"
]
}
]
}List links
List an app's links (network level), with their click and impression URLs. Gets one page; to see more, run it again with the next page it gives.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Page size
limitnumber - How many to return, 1 to 100. Adjust's default is 50.From 1 to 100.
- Next page
cursortext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
linkslist- The links
next_cursortext- Pass as 'cursor' for the next page; empty on the last one
Example output
{
"count": 1,
"links": [
{
"archived": false,
"click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}",
"cost_data_enabled": false,
"has_subtrackers": false,
"impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1",
"label": "Adroll",
"level": 1,
"name": "Adroll",
"partner_id": 3,
"token": "abc123",
"url": "https://app.adjust.com/abc123"
}
],
"next_cursor": ""
}List partners
List Adjust's partners (ad networks) with their IDs, and whether each can send ad spend data. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Adjust's default is 50.From 1 to 100.
- Next page
cursortext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
next_cursortext- Pass as 'cursor' for the next page; empty on the last one
partnerslist- The partners
Example output
{
"count": 1,
"next_cursor": "",
"partners": [
{
"display_name": "Adcolony",
"id": 174,
"supports_cost_data": true
}
]
}List report filter values
List the values a report can be narrowed or split by, such as your networks, partners, countries or currencies.
Inputs
- List
filter_nametextRequired - Which values to list.One of:
apps,apps_network(Apps with their store IDs),networks,partners,channels,countries,currencies,dimensions,os_names(Operating systems),store_type(Stores), and 12 more. - Search
searchtext - Only those whose name or ID contains this text.
Outputs
countnumber- How many
filter_nametext- Which values these are
valueslist- The values
Example output
{
"count": 1,
"filter_name": "networks",
"values": [
{
"description": "",
"formatting": null,
"id": "organic",
"name": "Organic",
"section": "",
"short_name": ""
}
]
}List sublinks
List the sublinks (campaign, ad group or creative level) under one of an app's links. Gets one page; to see more, run it again with the next page it gives.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Link
link_tokentextRequired - The link. Pick one of the app's links, or give its token.
- Page size
limitnumber - How many to return, 1 to 100. Adjust's default is 50.From 1 to 100.
- Next page
cursortext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
linkslist- The links
next_cursortext- Pass as 'cursor' for the next page; empty on the last one
Example output
{
"count": 1,
"links": [
{
"archived": false,
"click_url": "https://app.adjust.com/xyz456?idfa={idfa}",
"cost_data_enabled": false,
"has_subtrackers": false,
"impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1",
"label": "SpringCampaign",
"level": 2,
"name": "Adroll::SpringCampaign",
"partner_id": 3,
"token": "xyz456",
"url": "https://app.adjust.com/xyz456"
}
],
"next_cursor": ""
}Remove link from blocklist
Let a blocklisted link record clicks, impressions and callbacks again.
Inputs
- App
app_tokentext - The app whose link it is. Only used to pick the link.
- Link
link_tokentextRequired - The link. Pick one of the app's links, or give its token.
Outputs
blocklistedtrue/false- Whether the link is now blocklisted
linkobject- The link
Example output
{
"blocklisted": false,
"link": {
"adgroup_token": null,
"allow_partner_linking": true,
"archived": false,
"attribution_partner": false,
"campaign_token": null,
"click_url": "https://app.adjust.com/abc123",
"creative_token": null,
"has_subtrackers": true,
"impression_url": "https://view.adjust.com/impression/abc123",
"label": "Twitter installs",
"name": "Twitter installs",
"network_token": "abc123",
"path": "",
"settings": {
"additional_parameters": null,
"attribution_settings": null,
"blacklisted": false,
"campaign_structure": null,
"cost_data": false,
"cost_data_parameters": null,
"partner_cost_data_parameters": null,
"partner_display_name": null,
"partner_id": null,
"tracking_parameters": null
},
"token": "abc123",
"url": "https://app.adjust.com/abc123",
"urls": {
"show": "/api/trackers/abc123.json",
"update": "/api/trackers/abc123.json"
},
"visible": true
}
}Send ad revenue
Record ad revenue a device earned you, from your own ad mediation data, within 28 days. Needs Adjust's ad revenue package.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Device ID type
device_id_typetextRequired - Which kind of ID 'Device ID' is. Advertising IDs work best.One of:
gps_adid(Google advertising ID (Android)),idfa(IDFA (iOS)),fire_adid(Amazon Fire advertising ID),oaid(OAID (Huawei)),web_uuid(Web ID (Adjust Web SDK)),idfv(IDFV (iOS)),android_id(Android ID). - Device ID
device_idtextRequired - The device's ID, as your app or server recorded it.
- Revenue
revenuenumberRequired - The ad revenue, in whole units such as 0.01.At least 0.
- Currency
currencytextRequired - The revenue's currency, such as USD or EUR.
- Ad impressions
ad_impressions_countnumberRequired - How many ad impressions the revenue is for.At least 1.
- Adjust device ID
adidtext - The device's Adjust ID (ADID), which helps match iOS users without an IDFA.
- When the ad was shown
created_at_unixdate and time - Defaults to when Adjust receives it. No more than 28 days ago.
- Environment
environmenttext - Production for real users; sandbox while testing.One of:
production(Production (default)),sandbox(Sandbox (testing)). - Ad network
ad_revenue_networktext - The network that served the ad, such as Admob.
- Ad unit
ad_revenue_unittext - The ad unit, such as rewarded_video.
- Ad placement
ad_revenue_placementtext - Where in the app it was shown, such as home_screen.
- Callback parameters
callback_paramsobject - Your own keys and text values, passed on in Adjust's callbacks and raw data.
Outputs
app_tokentext- The app
currencytext- Its currency
device_idtext- The device ID sent
device_id_typetext- Which kind of device ID was sent
revenuenumber- The revenue sent
statustext- What Adjust answered, OK when recorded
Example output
{
"app_token": "abc123abc123",
"currency": "USD",
"device_id": "FAD135C7-C5F8-4DCC-9478-2203956B0870",
"device_id_type": "idfa",
"revenue": 0.01,
"status": "OK"
}Send in-app event
Record an in-app event, such as a purchase, for a device from your server. Events for a device must be sent in time order.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Event
event_tokentextRequired - The event to record. Pick one of the app's events.
- Device ID type
device_id_typetextRequired - Which kind of ID 'Device ID' is. Advertising IDs work best.One of:
gps_adid(Google advertising ID (Android)),idfa(IDFA (iOS)),fire_adid(Amazon Fire advertising ID),oaid(OAID (Huawei)),web_uuid(Web ID (Adjust Web SDK)),idfv(IDFV (iOS)),android_id(Android ID). - Device ID
device_idtextRequired - The device's ID, as your app or server recorded it.
- Adjust device ID
adidtext - The device's Adjust ID (ADID), which helps match iOS users without an IDFA.
- When it happened
created_at_unixdate and time - Defaults to when Adjust receives it. Must be within the last 58 days, and after the device's last one of these.
- Revenue
revenuenumber - For a revenue event: the amount, in whole units such as 149.99.At least 0.
- Currency
currencytext - The revenue's currency, such as USD. Needed with revenue.
- Environment
environmenttext - Production for real users; sandbox while testing.One of:
production(Production (default)),sandbox(Sandbox (testing)). - Device IP address
ip_addresstext - The device's IPv4 address, which adds its location to callbacks.
- Callback parameters
callback_paramsobject - Your own keys and text values, passed on in Adjust's callbacks and raw data.
- Partner parameters
partner_paramsobject - Your own keys and text values, shared with your ad network partners.
Outputs
app_tokentext- The app
device_idtext- The device ID sent
device_id_typetext- Which kind of device ID was sent
event_tokentext- The event
statustext- What Adjust answered, OK when recorded
Example output
{
"app_token": "4w565xzmb54d",
"device_id": "660e1d86-6796-463a-be86-897993136018",
"device_id_type": "gps_adid",
"event_token": "f0ob4r",
"status": "OK"
}Update link
Attach a partner to a link, or turn its ad spend data on or off. Only the fields given change.
Inputs
- App
app_tokentextRequired - The Adjust app. Pick one, or give its app token from an earlier step.
- Link
link_tokentextRequired - The link. Pick one of the app's links, or give its token.
- Partner
partner_idtext - The partner to attach to the link.
- Ad spend data
cost_data_enabledtrue/false - Turn the link's ad spend data on or off. Leave empty to keep it.
Outputs
linkobject- The link
Example output
{
"link": {
"archived": false,
"click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}",
"cost_data_enabled": true,
"has_subtrackers": false,
"impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1",
"label": "Adroll",
"level": 1,
"name": "Adroll",
"partner_id": 174,
"token": "abc123",
"url": "https://app.adjust.com/abc123"
}
}Update short link
Point an existing short link somewhere new. The short link people already have keeps working.
Inputs
- Short link
short_tokentextRequired - The short link, or the part after its domain (such as czWsH).
- App
app_tokentext - The app whose custom link to use. Only used to pick the link.
- Custom link
link_tokentextRequired - The custom link the new target is made from.
- In-app path
deep_link_pathtext - Where in the app it opens, such as /product/42. For an app on one platform.
- iOS in-app path
ios_deep_link_pathtext - Where it opens in the iOS app, for an app on both platforms.
- Android in-app path
android_deep_link_pathtext - Where it opens in the Android app, for an app on both platforms.
- Web page instead
web_deep_link_urltext - A web page to open instead of a place in the app.
- Redirect
redirecttext - Where people without the app go, instead of the app store.
- Fallback page
fallbacktext - Where people on a computer or other platform go.
- Campaign
campaigntext - A campaign name to report the link under, in place of the link's own.
- Ad group
adgrouptext - An ad group name to report the link under.
- Creative
creativetext - A creative name to report the link under.
- Label
labeltext - Your own data on the link, such as a referral ID.
- Extra link parameters
custom_parametersobject - Your own keys and values added to the link, such as a coupon code.
Outputs
link_tokentext- The custom link it now points through
short_tokentext- The short link updated
updatedtrue/false- Always true once updated
Example output
{
"link_token": "1doptv0c",
"short_token": "4IlkC",
"updated": true
}