# AppsFlyer

> 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.

App · 21 actions. Web page: https://docs.lodol.com/docs/integrations/appsflyer

## Actions

### 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 key (`import_key`, text, required): The audience's import key, shown in the imported audience's settings in AppsFlyer's Audiences page.
- Platform (`platform`, text, required): The audience's platform. One of: `android`, `ios`.
- Identifier type (`identifier_type`, text, required): 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).
- Identifiers (`identifiers`, list, required): One identifier per person, as a list or separated by commas.
- App (`app_id`, text): The app the people use. Required unless the audience is an as-is audience.

**Outputs**

- `accepted` (true/false): True once AppsFlyer accepted the list
- `device_count` (number): How many people (devices) were sent
- `import_key` (text): The audience's import key
- `message` (text): AppsFlyer's answer

**Example output**

```json
{
  "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 ID (`subject_request_id`, text, required): The privacy request's ID, from 'Create privacy request'.

**Outputs**

- `canceled` (true/false): Always true once canceled
- `subject_request_id` (text): The request canceled

**Example output**

```json
{
  "canceled": true,
  "subject_request_id": "f4e5a271-f25e-4107-b681-0a1b2c3d4e5f"
}
```

### Create OneLink

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 ID (`onelink_id`, text, required): 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 source (`media_source`, text, required): The media source (pid) installs are credited to, such as email or sms.
- Campaign (`campaign`, text): The campaign name (c).
- Channel (`channel`, text): The channel (af_channel), such as newsletter.
- Deep link value (`deep_link_value`, text): What the app opens to (deep_link_value), such as a product ID.
- More link parameters (`extra_params`, object): Any other OneLink parameters, such as {"af_sub1": "vip", "deep_link_sub1": "spring"}.
- Custom link ID (`shortlink_id`, text): A readable last part for the link, up to 50 letters and digits. Leave empty for a random one.
- Lifetime (days) (`ttl_days`, number): How many days the link lives, 1 to 730; each click extends it. AppsFlyer's default is 31. From 1 to 730.
- Branded domain (`brand_domain`, text): Only if your account has Branded Links set up: the branded domain to use, such as click.example.com.

**Outputs**

- `onelink_id` (text): The OneLink template ID
- `params` (object): The link's parameters (pid, c, deep_link_value and the rest)
- `shortlink_id` (text): The short link's ID, its last part
- `shortlink_url` (text): The short link, such as https://myapp.onelink.me/abc1/qwer9876

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Request (`request_type`, text, required): 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 by (`identity_type`, text, required): 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).
- ID (`identity_value`, text, required): The person's ID of that type.
- Platform (`platform`, text, required): 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 at (`submitted_time`, date and time): When the person made the request. Defaults to now.
- Request ID (`subject_request_id`, text): Your own ID for the request, a UUID. Leave empty for a new one.
- Status addresses (`callback_urls`, list): Up to 3 https:// addresses AppsFlyer tells when the request's status changes.
- Requester email (`requester_email`, text): The email of whoever is making the request.

**Outputs**

- `app_id` (text): The app
- `expected_completion_time` (text): When AppsFlyer expects to finish it
- `received_time` (text): When AppsFlyer received it
- `request_type` (text): erasure, access, portability or rectification
- `subject_request_id` (text): The request's ID, for 'Get privacy request'

**Example output**

```json
{
  "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 OneLink

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

**Inputs**

- OneLink template ID (`onelink_id`, text, required): 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 ID (`shortlink_id`, text, required): The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `onelink_id` (text): The OneLink template ID
- `shortlink_id` (text): The short link deleted

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Report (`report_type`, text): Whose ad revenue. Defaults to attributed users. One of: `attributed` (Attributed (default)), `organic`, `retargeting`. Default: `attributed`.
- From (`from_time`, date and time, required): The start of the range. Raw-data reports go back at most 90 days.
- To (`to_time`, date and time, required): The end of the range.
- Media source (`media_source`, text): Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
- Time zone (`timezone`, text): Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
- Country (`geo`, text): Only this country, as a two-letter code such as US.
- Currency (`currency`, text): 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 cap (`maximum_rows`, text): 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 return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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
- `report` (text): Which AppsFlyer report this is
- `row_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Report (`report_type`, text): 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`.
- From (`from_date`, date, required): The first day of the range.
- To (`to_date`, date, required): The last day of the range.
- Media source (`media_source`, text): Only this media source, such as facebook, or organic for organic installs only. Leave empty for all.
- Retargeting (`retargeting`, true/false): Totals of retargeting campaigns instead of user acquisition.
- View-through (`view_through`, true/false): Count installs attributed to ad views (impressions) instead of clicks.
- Time zone (`timezone`, text): Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
- Currency (`currency`, text): 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 return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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
- `report` (text): Which AppsFlyer report this is
- `row_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Report (`report_type`, text): 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`.
- From (`from_time`, date and time, required): The start of the range. Raw-data reports go back at most 90 days.
- To (`to_time`, date and time, required): The end of the range.
- Media source (`media_source`, text): Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
- Time zone (`timezone`, text): Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
- Country (`geo`, text): Only this country, as a two-letter code such as US.
- AppsFlyer's row cap (`maximum_rows`, text): 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 return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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
- `report` (text): Which AppsFlyer report this is
- `row_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Report (`report_type`, text): Events of non-organic, organic or retargeted users. Defaults to non-organic. One of: `non_organic` (Non-organic (default)), `organic`, `retargeting`. Default: `non_organic`.
- From (`from_time`, date and time, required): The start of the range. Raw-data reports go back at most 90 days.
- To (`to_time`, date and time, required): The end of the range.
- Event names (`event_names`, text): Only these events, separated by commas, such as af_purchase, af_complete_registration. Leave empty for all.
- Media source (`media_source`, text): Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
- Time zone (`timezone`, text): Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
- Country (`geo`, text): Only this country, as a two-letter code such as US.
- Currency (`currency`, text): 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 cap (`maximum_rows`, text): 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 return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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
- `report` (text): Which AppsFlyer report this is
- `row_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Report (`report_type`, text): 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`.
- From (`from_time`, date and time, required): The start of the range. Raw-data reports go back at most 90 days.
- To (`to_time`, date and time, required): The end of the range.
- Media source (`media_source`, text): Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
- Time zone (`timezone`, text): Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
- Country (`geo`, text): Only this country, as a two-letter code such as US.
- Currency (`currency`, text): 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 cap (`maximum_rows`, text): 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 return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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
- `report` (text): Which AppsFlyer report this is
- `row_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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_update` (text): The day, YYYY-MM-DD

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- From (`from_date`, date, required): The first install day of the range.
- To (`to_date`, date, required): The last install day, at most 31 days after From.
- Group by (`groupings`, list, required): 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.
- KPIs (`kpis`, list): 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 KPIs (`extra_kpis`, text): 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 sources (`media_sources`, text): Only these media sources, separated by commas.
- Campaigns (`campaigns`, text): Only these campaign names, separated by commas.
- Countries (`countries`, text): Only these countries, as two-letter codes separated by commas, such as US, UK (AppsFlyer writes the UK as UK).
- Currency (`currency`, text): 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 zone (`app_time_zone`, true/false): Report in the app's time zone instead of UTC.
- Rows to return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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 OneLink

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

**Inputs**

- OneLink template ID (`onelink_id`, text, required): 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 ID (`shortlink_id`, text, required): The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.

**Outputs**

- `expiry` (text): When the link expires (UTC)
- `onelink_id` (text): The OneLink template ID
- `params` (object): The link's parameters (pid, c, deep_link_value and the rest)
- `shortlink_id` (text): The short link's ID
- `ttl_seconds` (number): How many seconds the link has left

**Example output**

```json
{
  "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 OneLink QR code

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 ID (`onelink_id`, text, required): 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 ID (`shortlink_id`, text, required): The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.
- Size (pixels) (`size`, number): The image's width and height, up to 3,000. AppsFlyer's default is 300. From 1 to 3000.
- Format (`image_format`, text): The image format. One of: `png` (PNG (default)), `jpg`. Default: `png`.
- White border (`margin`, true/false): Whether the image has a white border round the code.
- Branded domain (`brand_domain`, text): Only if your account has Branded Links set up: the branded domain to use, such as click.example.com.

**Outputs**

- `image_format` (text): png or jpg
- `onelink_id` (text): The OneLink template ID
- `qr_base64` (text): The image itself, base64-encoded
- `qr_data_uri` (text): The image as a data: address, for an <img> or an email
- `shortlink_id` (text): The short link's ID

**Example output**

```json
{
  "image_format": "png",
  "onelink_id": "H5hv",
  "qr_base64": "iVBORw0KGgo=",
  "qr_data_uri": "data:image/png;base64,iVBORw0KGgo=",
  "shortlink_id": "autumn42"
}
```

### Get OneLink quota

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

**Inputs**

- Account ID (`account_id`, text, required): Your AppsFlyer account ID, from your account profile in AppsFlyer.

**Outputs**

- `account_id` (text): The account
- `remaining_api_calls` (number): Creates, updates and deletes left this month

**Example output**

```json
{
  "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 ID (`subject_request_id`, text, required): The privacy request's ID, from 'Create privacy request'.

**Outputs**

- `controller_id` (text): Who made the request
- `expected_completion_time` (text): When AppsFlyer expects to finish it
- `request_status` (text): pending, in-progress, completed or canceled
- `subject_request_id` (text): The request's ID

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- Report (`report_type`, text): Uninstalls by non-organic or organic users. Defaults to non-organic. One of: `non_organic` (Non-organic (default)), `organic`. Default: `non_organic`.
- From (`from_time`, date and time, required): The start of the range. Raw-data reports go back at most 90 days.
- To (`to_time`, date and time, required): The end of the range.
- Media source (`media_source`, text): Only this media source, such as facebook, googleadwords_int or tiktokglobal_int. Leave empty for all.
- Time zone (`timezone`, text): Report in the app's time zone instead of UTC. It must match the app's time zone setting in AppsFlyer exactly.
- Country (`geo`, text): Only this country, as a two-letter code such as US.
- AppsFlyer's row cap (`maximum_rows`, text): 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 return (`row_limit`, number): 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_id` (text): The app
- `columns` (list): The report's column names as AppsFlyer writes them
- `from` (text): The start of the range, as sent to AppsFlyer
- `may_be_incomplete` (true/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
- `report` (text): Which AppsFlyer report this is
- `row_count` (number): How many rows this step returned
- `rows` (list): The report's rows
- `to` (text): The end of the range, as sent to AppsFlyer
- `total_rows` (number): How many rows the report had
- `truncated` (true/false): True when the report had more rows than the step's row limit

**Example output**

```json
{
  "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**

- `apps` (list): The apps
- `count` (number): How many apps were returned
- `total` (number): How many apps the account has

**Example output**

```json
{
  "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 key (`import_key`, text, required): The audience's import key, shown in the imported audience's settings in AppsFlyer's Audiences page.
- Platform (`platform`, text, required): The audience's platform. One of: `android`, `ios`.
- Identifier type (`identifier_type`, text, required): 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).
- Identifiers (`identifiers`, list, required): One identifier per person, as a list or separated by commas.
- App (`app_id`, text): The app the people use. Required unless the audience is an as-is audience.

**Outputs**

- `accepted` (true/false): True once AppsFlyer accepted the list
- `device_count` (number): How many people (devices) were sent
- `import_key` (text): The audience's import key
- `message` (text): AppsFlyer's answer

**Example output**

```json
{
  "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**

- App (`app_id`, text, required): The app. Pick one, or give its app ID (id123456789 for iOS, the package name such as com.example.app for Android).
- AppsFlyer ID (`appsflyer_id`, text, required): The user's AppsFlyer ID, which AppsFlyer's SDK gives the app (such as 1729435351000-1234567).
- Event name (`event_name`, text, required): The event's name, such as af_purchase or renewal.
- Event values (`event_value`, object): The event's details, such as {"af_revenue": "9.99", "af_content_id": "sku-1"}.
- When it happened (`event_time`, date and time): Defaults to when AppsFlyer receives it.
- Currency (`event_currency`, text): The currency of af_revenue, such as USD.
- Customer user ID (`customer_user_id`, text): Your own ID for the user.
- Bundle ID (`bundle_id`, text): The app's bundle ID, such as com.example.app. Ad networks use it.
- OS version (`os_version`, text): The device's operating system version, such as 17.4. AppsFlyer asks for it.
- IP address (`ip`, text): The device's IP address when the event happened, for its location.

**Outputs**

- `app_id` (text): The app
- `appsflyer_id` (text): The user's AppsFlyer ID
- `event_name` (text): The event's name
- `event_time` (text): The time sent, empty when AppsFlyer used its own
- `sent` (true/false): True once AppsFlyer accepted the event

**Example output**

```json
{
  "app_id": "com.example.app",
  "appsflyer_id": "1729435351000-1234567",
  "event_name": "af_purchase",
  "event_time": "2026-10-21 09:12:44.000",
  "sent": true
}
```

### Update OneLink

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 ID (`onelink_id`, text, required): 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 ID (`shortlink_id`, text, required): The short link's ID, its last part (qwer9876 in https://myapp.onelink.me/abc1/qwer9876), or the whole link.
- Parameters to set (`params`, object): The parameters to add or change, such as {"c": "winter_sale", "deep_link_value": "coat"}.
- Parameters to remove (`remove_params`, list): Names of parameters to take off the link, such as af_sub1.
- New lifetime (days) (`ttl_days`, number): A new lifetime, 1 to 730 days. Leave empty to keep what the link has left. From 1 to 730.
- Branded domain (`brand_domain`, text): Only if your account has Branded Links set up: the branded domain to use, such as click.example.com.

**Outputs**

- `onelink_id` (text): The OneLink template ID
- `params` (object): The link's parameters (pid, c, deep_link_value and the rest)
- `shortlink_id` (text): The short link's ID, its last part
- `shortlink_url` (text): The short link, such as https://myapp.onelink.me/abc1/qwer9876

**Example output**

```json
{
  "onelink_id": "H5hv",
  "params": {
    "c": "winter_sale",
    "deep_link_value": "sale",
    "pid": "email"
  },
  "shortlink_id": "autumn42",
  "shortlink_url": "https://myapp.onelink.me/H5hv/autumn42"
}
```
