AppsFlyer

App · 21 actions

Pull AppsFlyer install, in-app event, uninstall, ad revenue, fraud and aggregate reports, run workflows on new installs and events, create and manage OneLink short links and QR codes, send server-side events and handle privacy requests.

Actions

ActionWhat it does
Add people to audienceAdd people, by customer user ID or device ID, to an imported audience that AppsFlyer shares with your ad partners.
Cancel privacy requestCancel a privacy request while it is still pending.
Create OneLinkCreate a OneLink short link on a template, with its media source, campaign and deep link, to send by SMS, email or QR code.
Create privacy requestAsk AppsFlyer to erase, export or correct one person's data in an app (an OpenDSR request, for GDPR and CCPA).
Delete OneLinkDelete a OneLink short link made with the OneLink API, so it no longer opens anything.
Get ad revenue reportGet the revenue your app earned from showing ads, per user and day, for attributed, organic or retargeted users.
Get aggregate reportGet totals (impressions, clicks, installs, cost, revenue and events) by media source and campaign, by day or by country.
Get fraud reportGet the installs, in-app events, clicks or postbacks that Protect360 blocked or found fraudulent after attribution, with the reason.
Get in-app events reportGet one row per in-app event (a purchase, a sign-up) in a time range, optionally only some event names, with revenue and attribution.
Get installs reportGet one row per install in a time range: non-organic or organic installs, retargeting conversions or reinstalls, with media source, campaign, country and AppsFlyer ID.
Get Master API last updateGet the last day whose Master API figures are complete, to know when to pull a report.
Get Master API reportGet the KPIs you choose (installs, cost, revenue, ROI, retention, event counts) grouped by media source, campaign, country and more, for up to 31 days.
Get OneLinkGet a OneLink short link's parameters, when it expires and how long it has left.
Get OneLink QR codeGet a QR code image for a short link made or updated with the OneLink API, in the template's colours and logo.
Get OneLink quotaGet how many OneLink links you can still create, change or delete this month (7.5 million a month per account).
Get privacy requestGet a privacy request's status: pending, in-progress, completed or canceled.
Get uninstalls reportGet one row per uninstall in a time range.
List appsList the apps in your AppsFlyer account with their platform, currency and time zone.
Remove people from audienceRemove people, by customer user ID or device ID, from an imported audience.
Send in-app eventRecord an in-app event that happened outside the app, such as a renewal billed on your server, for a user identified by their AppsFlyer ID.
Update OneLinkChange some of a OneLink short link's parameters or its lifetime; the rest stay as they are.

Add people to audience

Add people, by customer user ID or device ID, to an imported audience that AppsFlyer shares with your ad partners.

Inputs

Audience import keyimport_keytextRequired
The audience's import key, shown in the imported audience's settings in AppsFlyer's Audiences page.
PlatformplatformtextRequired
The audience's platform.One of: android, ios.
Identifier typeidentifier_typetextRequired
What the identifiers are. Android audiences take a customer user ID, GAID, OAID, IMEI, Braze ID or Amplitude ID; iOS ones a customer user ID, IDFV, Braze ID or Amplitude ID.One of: cuid (Customer user ID), gaid (Google advertising ID (Android)), oaid (Open advertising ID (Android)), imei (IMEI (Android)), idfv (iOS vendor ID (IDFV)), braze_id (Braze ID), amplitude_id (Amplitude ID).
IdentifiersidentifierslistRequired
One identifier per person, as a list or separated by commas.
Appapp_idtext
The app the people use. Required unless the audience is an as-is audience.

Outputs

acceptedtrue/false
True once AppsFlyer accepted the list
device_countnumber
How many people (devices) were sent
import_keytext
The audience's import key
messagetext
AppsFlyer's answer
Example output
{
  "accepted": true,
  "device_count": 1,
  "import_key": "EKFH2UMC5PPCU8J7M5QQ",
  "message": "The request was successful"
}

Cancel privacy request

Cancel a privacy request while it is still pending.

Inputs

Request IDsubject_request_idtextRequired
The privacy request's ID, from 'Create privacy request'.

Outputs

canceledtrue/false
Always true once canceled
subject_request_idtext
The request canceled
Example output
{
  "canceled": true,
  "subject_request_id": "f4e5a271-f25e-4107-b681-0a1b2c3d4e5f"
}

Create a OneLink short link on a template, with its media source, campaign and deep link, to send by SMS, email or QR code. Needs a OneLink API token.

Inputs

OneLink template IDonelink_idtextRequired
The template's ID: the part after the domain in its address (H5hv in https://myapp.onelink.me/H5hv), shown on AppsFlyer's OneLink Management page.
Media sourcemedia_sourcetextRequired
The media source (pid) installs are credited to, such as email or sms.
Campaigncampaigntext
The campaign name (c).
Channelchanneltext
The channel (af_channel), such as newsletter.
Deep link valuedeep_link_valuetext
What the app opens to (deep_link_value), such as a product ID.
More link parametersextra_paramsobject
Any other OneLink parameters, such as {"af_sub1": "vip", "deep_link_sub1": "spring"}.
Custom link IDshortlink_idtext
A readable last part for the link, up to 50 letters and digits. Leave empty for a random one.
Lifetime (days)ttl_daysnumber
How many days the link lives, 1 to 730; each click extends it. AppsFlyer's default is 31.From 1 to 730.
Branded domainbrand_domaintext
Only if your account has Branded Links set up: the branded domain to use, such as click.example.com.

Outputs

onelink_idtext
The OneLink template ID
paramsobject
The link's parameters (pid, c, deep_link_value and the rest)
shortlink_idtext
The short link's ID, its last part
shortlink_urltext
The short link, such as https://myapp.onelink.me/abc1/qwer9876
Example output
{
  "onelink_id": "H5hv",
  "params": {
    "c": "autumn_newsletter",
    "deep_link_value": "sale",
    "pid": "email"
  },
  "shortlink_id": "autumn42",
  "shortlink_url": "https://myapp.onelink.me/H5hv/autumn42"
}

Create privacy request

Ask AppsFlyer to erase, export or correct one person's data in an app (an OpenDSR request, for GDPR and CCPA). Erasure can't be undone once it starts.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Requestrequest_typetextRequired
What the person asked for.One of: erasure (Erase the person's data), access (Give the person a copy of their data), portability (Give the person their data to take elsewhere), rectification (Correct the person's data).
Identified byidentity_typetextRequired
Which ID identifies the person. PC, console and TV apps take only an AppsFlyer ID or customer user ID.One of: appsflyer_id (AppsFlyer ID), customer_user_id (Customer user ID), android_advertising_id (Android advertising ID (GAID)), ios_advertising_id (iOS advertising ID (IDFA)), idfv (iOS vendor ID (IDFV)), fire_advertising_id (Amazon Fire advertising ID), microsoft_advertising_id (Microsoft advertising ID).
IDidentity_valuetextRequired
The person's ID of that type.
PlatformplatformtextRequired
The app's platform.One of: android, ios, web, windowsphone (Windows Phone), nativepc (PC), steam, epic (Epic Games), battlenet (Battle.net), playstation, xbox, and 8 more.
Asked atsubmitted_timedate and time
When the person made the request. Defaults to now.
Request IDsubject_request_idtext
Your own ID for the request, a UUID. Leave empty for a new one.
Status addressescallback_urlslist
Up to 3 https:// addresses AppsFlyer tells when the request's status changes.
Requester emailrequester_emailtext
The email of whoever is making the request.

Outputs

app_idtext
The app
expected_completion_timetext
When AppsFlyer expects to finish it
received_timetext
When AppsFlyer received it
request_typetext
erasure, access, portability or rectification
subject_request_idtext
The request's ID, for 'Get privacy request'
Example output
{
  "app_id": "com.example.app",
  "expected_completion_time": "2026-10-31T10:00:00Z",
  "received_time": "2026-10-21T10:00:00Z",
  "request_type": "erasure",
  "subject_request_id": "f4e5a271-f25e-4107-b681-0a1b2c3d4e5f"
}

Delete a OneLink short link made with the OneLink API, so it no longer opens anything.

Inputs

OneLink template IDonelink_idtextRequired
The template's ID: the part after the domain in its address (H5hv in https://myapp.onelink.me/H5hv), shown on AppsFlyer's OneLink Management page.
Short link IDshortlink_idtextRequired
The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.

Outputs

deletedtrue/false
Always true once deleted
onelink_idtext
The OneLink template ID
shortlink_idtext
The short link deleted
Example output
{
  "deleted": true,
  "onelink_id": "H5hv",
  "shortlink_id": "autumn42"
}

Get ad revenue report

Get the revenue your app earned from showing ads, per user and day, for attributed, organic or retargeted users. AppsFlyer updates it once a day.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Reportreport_typetext
Whose ad revenue. Defaults to attributed users.One of: attributed (Attributed (default)), organic, retargeting. Default: attributed.
Fromfrom_timedate and timeRequired
The start of the range. Raw-data reports go back at most 90 days.
Toto_timedate and timeRequired
The end of the range.
Media sourcemedia_sourcetext
Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
Time zonetimezonetext
Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
Countrygeotext
Only this country, as a two-letter code such as US.
Currencycurrencytext
Revenue and cost in the app's currency or in US dollars.One of: preferred (The app's currency), USD (US dollars). Default: preferred.
AppsFlyer's row capmaximum_rowstext
How many rows AppsFlyer puts in the report at most. A report that hits the cap is missing rows; pull a shorter range.One of: 200000 (Up to 200,000 rows (default)), 1000000 (Up to 1,000,000 rows). Default: 200000.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
reporttext
Which AppsFlyer report this is
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Attributed Touch Type",
    "Attributed Touch Time",
    "Install Time",
    "Event Time",
    "Event Name",
    "Media Source",
    "Channel",
    "Campaign",
    "Campaign ID",
    "Country Code",
    "Platform",
    "AppsFlyer ID",
    "Customer User ID",
    "App ID"
  ],
  "from": "2026-10-20 00:00:00",
  "may_be_incomplete": false,
  "report": "ad_revenue_raw",
  "row_count": 1,
  "rows": [
    {
      "app_id": "com.example.app",
      "appsflyer_id": "1729435351000-1234567",
      "attributed_touch_time": "2026-10-20 13:55:10",
      "attributed_touch_type": "click",
      "campaign": "Autumn launch",
      "campaign_id": "1234567",
      "channel": "UAC_Search",
      "country_code": "US",
      "customer_user_id": "user-42",
      "event_name": "af_ad_revenue",
      "event_revenue_usd": "0.42",
      "event_time": "2026-10-20 14:02:31",
      "install_time": "2026-10-20 14:02:31",
      "media_source": "googleadwords_int",
      "platform": "android"
    }
  ],
  "to": "2026-10-21 00:00:00",
  "total_rows": 1,
  "truncated": false
}

Get aggregate report

Get totals (impressions, clicks, installs, cost, revenue and events) by media source and campaign, by day or by country. Ranges of 3 days or more can be pulled 24 times a day per app.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Reportreport_typetext
How the totals are grouped. Defaults to media source and campaign.One of: partners (By media source and campaign (default)), partners_by_date (By media source and campaign, per day), daily (Per day), geo (By country), geo_by_date (By country, per day). Default: partners.
Fromfrom_datedateRequired
The first day of the range.
Toto_datedateRequired
The last day of the range.
Media sourcemedia_sourcetext
Only this media source, such as facebook, or organic for organic installs only. Leave empty for all.
Retargetingretargetingtrue/false
Totals of retargeting campaigns instead of user acquisition.
View-throughview_throughtrue/false
Count installs attributed to ad views (impressions) instead of clicks.
Time zonetimezonetext
Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
Currencycurrencytext
Revenue and cost in the app's currency or in US dollars.One of: preferred (The app's currency), USD (US dollars). Default: preferred.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
reporttext
Which AppsFlyer report this is
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Date",
    "Media Source (pid)",
    "Campaign (c)",
    "Impressions",
    "Clicks",
    "Installs",
    "Total Cost",
    "Total Revenue"
  ],
  "from": "2026-10-20",
  "may_be_incomplete": false,
  "report": "partners_by_date_report",
  "row_count": 1,
  "rows": [
    {
      "campaign_c": "Autumn launch",
      "clicks": "830",
      "date": "2026-10-20",
      "impressions": "12000",
      "installs": "95",
      "media_source_pid": "googleadwords_int",
      "total_cost": "190.00",
      "total_revenue": "412.50"
    }
  ],
  "to": "2026-10-20",
  "total_rows": 1,
  "truncated": false
}

Get fraud report

Get the installs, in-app events, clicks or postbacks that Protect360 blocked or found fraudulent after attribution, with the reason. Needs Protect360.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Reportreport_typetext
Which fraud report. Defaults to blocked installs.One of: blocked_installs (Blocked installs (default)), post_attribution_installs (Post-attribution installs), blocked_in_app_events (Blocked in-app events), post_attribution_in_app_events (Post-attribution in-app events), blocked_clicks (Blocked clicks), blocked_install_postbacks (Blocked install postbacks). Default: blocked_installs.
Fromfrom_timedate and timeRequired
The start of the range. Raw-data reports go back at most 90 days.
Toto_timedate and timeRequired
The end of the range.
Media sourcemedia_sourcetext
Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
Time zonetimezonetext
Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
Countrygeotext
Only this country, as a two-letter code such as US.
AppsFlyer's row capmaximum_rowstext
How many rows AppsFlyer puts in the report at most. A report that hits the cap is missing rows; pull a shorter range.One of: 200000 (Up to 200,000 rows (default)), 1000000 (Up to 1,000,000 rows). Default: 200000.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
reporttext
Which AppsFlyer report this is
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Attributed Touch Type",
    "Attributed Touch Time",
    "Install Time",
    "Event Time",
    "Event Name",
    "Media Source",
    "Channel",
    "Campaign",
    "Campaign ID",
    "Country Code",
    "Platform",
    "AppsFlyer ID",
    "Customer User ID",
    "App ID"
  ],
  "from": "2026-10-20 00:00:00",
  "may_be_incomplete": false,
  "report": "blocked_installs_report",
  "row_count": 1,
  "rows": [
    {
      "app_id": "com.example.app",
      "appsflyer_id": "1729435351000-1234567",
      "attributed_touch_time": "2026-10-20 13:55:10",
      "attributed_touch_type": "click",
      "blocked_reason": "install_hijacking",
      "blocked_sub_reason": "",
      "campaign": "Autumn launch",
      "campaign_id": "1234567",
      "channel": "UAC_Search",
      "country_code": "US",
      "customer_user_id": "user-42",
      "event_name": "install",
      "event_time": "2026-10-20 14:02:31",
      "install_time": "2026-10-20 14:02:31",
      "media_source": "googleadwords_int",
      "platform": "android"
    }
  ],
  "to": "2026-10-21 00:00:00",
  "total_rows": 1,
  "truncated": false
}

Get in-app events report

Get one row per in-app event (a purchase, a sign-up) in a time range, optionally only some event names, with revenue and attribution. Can be pulled 12 times a day per app.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Reportreport_typetext
Events of non-organic, organic or retargeted users. Defaults to non-organic.One of: non_organic (Non-organic (default)), organic, retargeting. Default: non_organic.
Fromfrom_timedate and timeRequired
The start of the range. Raw-data reports go back at most 90 days.
Toto_timedate and timeRequired
The end of the range.
Event namesevent_namestext
Only these events, separated by commas, such as af_purchase, af_complete_registration. Leave empty for all.
Media sourcemedia_sourcetext
Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
Time zonetimezonetext
Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
Countrygeotext
Only this country, as a two-letter code such as US.
Currencycurrencytext
Revenue and cost in the app's currency or in US dollars.One of: preferred (The app's currency), USD (US dollars). Default: preferred.
AppsFlyer's row capmaximum_rowstext
How many rows AppsFlyer puts in the report at most. A report that hits the cap is missing rows; pull a shorter range.One of: 200000 (Up to 200,000 rows (default)), 1000000 (Up to 1,000,000 rows). Default: 200000.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
reporttext
Which AppsFlyer report this is
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Attributed Touch Type",
    "Attributed Touch Time",
    "Install Time",
    "Event Time",
    "Event Name",
    "Media Source",
    "Channel",
    "Campaign",
    "Campaign ID",
    "Country Code",
    "Platform",
    "AppsFlyer ID",
    "Customer User ID",
    "App ID"
  ],
  "from": "2026-10-20 00:00:00",
  "may_be_incomplete": false,
  "report": "in_app_events_report",
  "row_count": 1,
  "rows": [
    {
      "app_id": "com.example.app",
      "appsflyer_id": "1729435351000-1234567",
      "attributed_touch_time": "2026-10-20 13:55:10",
      "attributed_touch_type": "click",
      "campaign": "Autumn launch",
      "campaign_id": "1234567",
      "channel": "UAC_Search",
      "country_code": "US",
      "customer_user_id": "user-42",
      "event_name": "af_purchase",
      "event_revenue": "9.99",
      "event_revenue_currency": "USD",
      "event_time": "2026-10-21 09:12:44",
      "event_value": "{\"af_revenue\":\"9.99\",\"af_currency\":\"USD\"}",
      "install_time": "2026-10-20 14:02:31",
      "media_source": "googleadwords_int",
      "platform": "android"
    }
  ],
  "to": "2026-10-21 00:00:00",
  "total_rows": 1,
  "truncated": false
}

Get installs report

Get one row per install in a time range: non-organic or organic installs, retargeting conversions or reinstalls, with media source, campaign, country and AppsFlyer ID. Each report type can be pulled 24 times a day per app.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Reportreport_typetext
Which installs. Defaults to non-organic installs.One of: non_organic (Non-organic installs (default)), organic (Organic installs), retargeting (Retargeting conversions), reinstalls (Non-organic reinstalls), organic_reinstalls (Organic reinstalls). Default: non_organic.
Fromfrom_timedate and timeRequired
The start of the range. Raw-data reports go back at most 90 days.
Toto_timedate and timeRequired
The end of the range.
Media sourcemedia_sourcetext
Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
Time zonetimezonetext
Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
Countrygeotext
Only this country, as a two-letter code such as US.
Currencycurrencytext
Revenue and cost in the app's currency or in US dollars.One of: preferred (The app's currency), USD (US dollars). Default: preferred.
AppsFlyer's row capmaximum_rowstext
How many rows AppsFlyer puts in the report at most. A report that hits the cap is missing rows; pull a shorter range.One of: 200000 (Up to 200,000 rows (default)), 1000000 (Up to 1,000,000 rows). Default: 200000.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
reporttext
Which AppsFlyer report this is
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Attributed Touch Type",
    "Attributed Touch Time",
    "Install Time",
    "Event Time",
    "Event Name",
    "Media Source",
    "Channel",
    "Campaign",
    "Campaign ID",
    "Country Code",
    "Platform",
    "AppsFlyer ID",
    "Customer User ID",
    "App ID"
  ],
  "from": "2026-10-20 00:00:00",
  "may_be_incomplete": false,
  "report": "installs_report",
  "row_count": 1,
  "rows": [
    {
      "app_id": "com.example.app",
      "appsflyer_id": "1729435351000-1234567",
      "attributed_touch_time": "2026-10-20 13:55:10",
      "attributed_touch_type": "click",
      "campaign": "Autumn launch",
      "campaign_id": "1234567",
      "channel": "UAC_Search",
      "country_code": "US",
      "customer_user_id": "user-42",
      "event_name": "install",
      "event_time": "2026-10-20 14:02:31",
      "install_time": "2026-10-20 14:02:31",
      "media_source": "googleadwords_int",
      "platform": "android"
    }
  ],
  "to": "2026-10-21 00:00:00",
  "total_rows": 1,
  "truncated": false
}

Get Master API last update

Get the last day whose Master API figures are complete, to know when to pull a report.

Inputs

None.

Outputs

last_updatetext
The day, YYYY-MM-DD
Example output
{
  "last_update": "2026-10-20"
}

Get Master API report

Get the KPIs you choose (installs, cost, revenue, ROI, retention, event counts) grouped by media source, campaign, country and more, for up to 31 days. Needs the Master API.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Fromfrom_datedateRequired
The first install day of the range.
Toto_datedateRequired
The last install day, at most 31 days after From.
Group bygroupingslistRequired
How rows are grouped.One or more of: app_id (App), pid (Media source), af_prt (Agency), c (Campaign), af_c_id (Campaign ID), af_adset (Ad set), af_adset_id (Ad set ID), af_ad (Ad), af_ad_id (Ad ID), af_channel (Channel), and 6 more.
KPIskpislist
The figures to report.One or more of: impressions, clicks, installs, cr (Conversion rate), sessions, loyal_users (Loyal users), loyal_users_rate (Loyal user rate), cost, revenue, roi, and 10 more.
More KPIsextra_kpistext
KPIs named after your events or a day, separated by commas, such as event_counter_af_purchase, unique_users_af_purchase or retention_day_7.
Media sourcesmedia_sourcestext
Only these media sources, separated by commas.
Campaignscampaignstext
Only these campaign names, separated by commas.
Countriescountriestext
Only these countries, as two-letter codes separated by commas, such as US, UK (AppsFlyer writes the UK as UK).
Currencycurrencytext
Revenue and cost in the app's currency or in US dollars.One of: preferred (The app's currency), USD (US dollars). Default: preferred.
Use the app's time zoneapp_time_zonetrue/false
Report in the app's time zone instead of UTC.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Media Source",
    "Campaign",
    "Installs",
    "Cost",
    "Revenue"
  ],
  "from": "2026-10-01",
  "may_be_incomplete": false,
  "row_count": 1,
  "rows": [
    {
      "campaign": "Autumn launch",
      "cost": "190.00",
      "installs": "95",
      "media_source": "googleadwords_int",
      "revenue": "412.50"
    }
  ],
  "to": "2026-10-20",
  "total_rows": 1,
  "truncated": false
}

Get a OneLink short link's parameters, when it expires and how long it has left. Works for any short link.

Inputs

OneLink template IDonelink_idtextRequired
The template's ID: the part after the domain in its address (H5hv in https://myapp.onelink.me/H5hv), shown on AppsFlyer's OneLink Management page.
Short link IDshortlink_idtextRequired
The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.

Outputs

expirytext
When the link expires (UTC)
onelink_idtext
The OneLink template ID
paramsobject
The link's parameters (pid, c, deep_link_value and the rest)
shortlink_idtext
The short link's ID
ttl_secondsnumber
How many seconds the link has left
Example output
{
  "expiry": "2026-11-20T12:00:00Z",
  "onelink_id": "H5hv",
  "params": {
    "c": "autumn_newsletter",
    "deep_link_value": "sale",
    "pid": "email"
  },
  "shortlink_id": "autumn42",
  "ttl_seconds": 2678400
}

Get a QR code image for a short link made or updated with the OneLink API, in the template's colours and logo.

Inputs

OneLink template IDonelink_idtextRequired
The template's ID: the part after the domain in its address (H5hv in https://myapp.onelink.me/H5hv), shown on AppsFlyer's OneLink Management page.
Short link IDshortlink_idtextRequired
The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.
Size (pixels)sizenumber
The image's width and height, up to 3,000. AppsFlyer's default is 300.From 1 to 3000.
Formatimage_formattext
The image format.One of: png (PNG (default)), jpg. Default: png.
White bordermargintrue/false
Whether the image has a white border round the code.
Branded domainbrand_domaintext
Only if your account has Branded Links set up: the branded domain to use, such as click.example.com.

Outputs

image_formattext
png or jpg
onelink_idtext
The OneLink template ID
qr_base64text
The image itself, base64-encoded
qr_data_uritext
The image as a data: address, for an <img> or an email
shortlink_idtext
The short link's ID
Example output
{
  "image_format": "png",
  "onelink_id": "H5hv",
  "qr_base64": "iVBORw0KGgo=",
  "qr_data_uri": "data:image/png;base64,iVBORw0KGgo=",
  "shortlink_id": "autumn42"
}

Get how many OneLink links you can still create, change or delete this month (7.5 million a month per account).

Inputs

Account IDaccount_idtextRequired
Your AppsFlyer account ID, from your account profile in AppsFlyer.

Outputs

account_idtext
The account
remaining_api_callsnumber
Creates, updates and deletes left this month
Example output
{
  "account_id": "a1b2c3",
  "remaining_api_calls": 7499880
}

Get privacy request

Get a privacy request's status: pending, in-progress, completed or canceled. Requests older than 60 days aren't found.

Inputs

Request IDsubject_request_idtextRequired
The privacy request's ID, from 'Create privacy request'.

Outputs

controller_idtext
Who made the request
expected_completion_timetext
When AppsFlyer expects to finish it
request_statustext
pending, in-progress, completed or canceled
subject_request_idtext
The request's ID
Example output
{
  "controller_id": "admin@example.com",
  "expected_completion_time": "2026-10-31T10:00:00Z",
  "request_status": "pending",
  "subject_request_id": "f4e5a271-f25e-4107-b681-0a1b2c3d4e5f"
}

Get uninstalls report

Get one row per uninstall in a time range. AppsFlyer adds uninstalls once a day.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
Reportreport_typetext
Uninstalls by non-organic or organic users. Defaults to non-organic.One of: non_organic (Non-organic (default)), organic. Default: non_organic.
Fromfrom_timedate and timeRequired
The start of the range. Raw-data reports go back at most 90 days.
Toto_timedate and timeRequired
The end of the range.
Media sourcemedia_sourcetext
Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
Time zonetimezonetext
Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
Countrygeotext
Only this country, as a two-letter code such as US.
AppsFlyer's row capmaximum_rowstext
How many rows AppsFlyer puts in the report at most. A report that hits the cap is missing rows; pull a shorter range.One of: 200000 (Up to 200,000 rows (default)), 1000000 (Up to 1,000,000 rows). Default: 200000.
Rows to returnrow_limitnumber
How many of the report's rows this step hands on, 1 to 10,000. Defaults to 1,000.From 1 to 10000.

Outputs

app_idtext
The app
columnslist
The report's column names as AppsFlyer writes them
fromtext
The start of the range, as sent to AppsFlyer
may_be_incompletetrue/false
True when the report hit AppsFlyer's 200,000 (or 1,000,000) row cap, so rows are missing; pull a shorter time range
reporttext
Which AppsFlyer report this is
row_countnumber
How many rows this step returned
rowslist
The report's rows
totext
The end of the range, as sent to AppsFlyer
total_rowsnumber
How many rows the report had
truncatedtrue/false
True when the report had more rows than the step's row limit
Example output
{
  "app_id": "com.example.app",
  "columns": [
    "Attributed Touch Type",
    "Attributed Touch Time",
    "Install Time",
    "Event Time",
    "Event Name",
    "Media Source",
    "Channel",
    "Campaign",
    "Campaign ID",
    "Country Code",
    "Platform",
    "AppsFlyer ID",
    "Customer User ID",
    "App ID"
  ],
  "from": "2026-10-20 00:00:00",
  "may_be_incomplete": false,
  "report": "uninstall_events_report",
  "row_count": 1,
  "rows": [
    {
      "app_id": "com.example.app",
      "appsflyer_id": "1729435351000-1234567",
      "attributed_touch_time": "2026-10-20 13:55:10",
      "attributed_touch_type": "click",
      "campaign": "Autumn launch",
      "campaign_id": "1234567",
      "channel": "UAC_Search",
      "country_code": "US",
      "customer_user_id": "user-42",
      "event_name": "uninstall",
      "event_time": "2026-10-20 14:02:31",
      "install_time": "2026-10-20 14:02:31",
      "media_source": "googleadwords_int",
      "platform": "android"
    }
  ],
  "to": "2026-10-21 00:00:00",
  "total_rows": 1,
  "truncated": false
}

List apps

List the apps in your AppsFlyer account with their platform, currency and time zone.

Inputs

None.

Outputs

appslist
The apps
countnumber
How many apps were returned
totalnumber
How many apps the account has
Example output
{
  "apps": [
    {
      "currency": "USD",
      "id": "com.example.app",
      "name": "Example",
      "platform": "android",
      "retargeting_enabled": true,
      "time_zone": "UTC"
    }
  ],
  "count": 1,
  "total": 1
}

Remove people from audience

Remove people, by customer user ID or device ID, from an imported audience.

Inputs

Audience import keyimport_keytextRequired
The audience's import key, shown in the imported audience's settings in AppsFlyer's Audiences page.
PlatformplatformtextRequired
The audience's platform.One of: android, ios.
Identifier typeidentifier_typetextRequired
What the identifiers are. Android audiences take a customer user ID, GAID, OAID, IMEI, Braze ID or Amplitude ID; iOS ones a customer user ID, IDFV, Braze ID or Amplitude ID.One of: cuid (Customer user ID), gaid (Google advertising ID (Android)), oaid (Open advertising ID (Android)), imei (IMEI (Android)), idfv (iOS vendor ID (IDFV)), braze_id (Braze ID), amplitude_id (Amplitude ID).
IdentifiersidentifierslistRequired
One identifier per person, as a list or separated by commas.
Appapp_idtext
The app the people use. Required unless the audience is an as-is audience.

Outputs

acceptedtrue/false
True once AppsFlyer accepted the list
device_countnumber
How many people (devices) were sent
import_keytext
The audience's import key
messagetext
AppsFlyer's answer
Example output
{
  "accepted": true,
  "device_count": 1,
  "import_key": "EKFH2UMC5PPCU8J7M5QQ",
  "message": "The request was successful"
}

Send in-app event

Record an in-app event that happened outside the app, such as a renewal billed on your server, for a user identified by their AppsFlyer ID. Needs an S2S token.

Inputs

Appapp_idtextRequired
The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
AppsFlyer IDappsflyer_idtextRequired
The user's AppsFlyer ID, which AppsFlyer's SDK gives the app (such as 1729435351000-1234567).
Event nameevent_nametextRequired
The event's name, such as af_purchase or renewal.
Event valuesevent_valueobject
The event's details, such as {"af_revenue": "9.99", "af_content_id": "sku-1"}.
When it happenedevent_timedate and time
Defaults to when AppsFlyer receives it.
Currencyevent_currencytext
The currency of af_revenue, such as USD.
Customer user IDcustomer_user_idtext
Your own ID for the user.
Bundle IDbundle_idtext
The app's bundle ID, such as com.example.app. Ad networks use it.
OS versionos_versiontext
The device's operating system version, such as 17.4. AppsFlyer asks for it.
IP addressiptext
The device's IP address when the event happened, for its location.

Outputs

app_idtext
The app
appsflyer_idtext
The user's AppsFlyer ID
event_nametext
The event's name
event_timetext
The time sent, empty when AppsFlyer used its own
senttrue/false
True once AppsFlyer accepted the event
Example output
{
  "app_id": "com.example.app",
  "appsflyer_id": "1729435351000-1234567",
  "event_name": "af_purchase",
  "event_time": "2026-10-21 09:12:44.000",
  "sent": true
}

Change some of a OneLink short link's parameters or its lifetime; the rest stay as they are. Only links made with the OneLink API can be changed.

Inputs

OneLink template IDonelink_idtextRequired
The template's ID: the part after the domain in its address (H5hv in https://myapp.onelink.me/H5hv), shown on AppsFlyer's OneLink Management page.
Short link IDshortlink_idtextRequired
The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.
Parameters to setparamsobject
The parameters to add or change, such as {"c": "winter_sale", "deep_link_value": "coat"}.
Parameters to removeremove_paramslist
Names of parameters to take off the link, such as af_sub1.
New lifetime (days)ttl_daysnumber
A new lifetime, 1 to 730 days. Leave empty to keep what the link has left.From 1 to 730.
Branded domainbrand_domaintext
Only if your account has Branded Links set up: the branded domain to use, such as click.example.com.

Outputs

onelink_idtext
The OneLink template ID
paramsobject
The link's parameters (pid, c, deep_link_value and the rest)
shortlink_idtext
The short link's ID, its last part
shortlink_urltext
The short link, such as https://myapp.onelink.me/abc1/qwer9876
Example output
{
  "onelink_id": "H5hv",
  "params": {
    "c": "winter_sale",
    "deep_link_value": "sale",
    "pid": "email"
  },
  "shortlink_id": "autumn42",
  "shortlink_url": "https://myapp.onelink.me/H5hv/autumn42"
}

On this page