Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Appsflyer Capi Export

Appsflyer Capi Export

markdownView as Markdown

Create and manage data import and export jobs.

AppsflyerCapiExport: Create job

POSThttps://api.lytics.io/v2/job/appsflyer-capi-export

Create a AppsflyerCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "att_field": "string",
    "audience_events": "enters_only",
    "bundle_id": "string",
    "counter": "string",
    "currency_code": "AED",
    "device_type_field": "string",
    "event_name": "string",
    "event_timestamp": "string",
    "event_value_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "inst_date_field": "string",
    "ip_field": "string",
    "lang_field": "string",
    "os_field": "string",
    "segment_ids": [
      "string"
    ],
    "ua_field": "string",
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "att_field": "string",
      "audience_events": "enters_only",
      "bundle_id": "string",
      "counter": "string",
      "currency_code": "AED",
      "device_type_field": "string",
      "event_name": "string",
      "event_timestamp": "string",
      "event_value_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "inst_date_field": "string",
      "ip_field": "string",
      "lang_field": "string",
      "os_field": "string",
      "segment_ids": [
        "string"
      ],
      "ua_field": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

AppsflyerCapiExport: Get job

GEThttps://api.lytics.io/v2/job/appsflyer-capi-export/{id}

Get the summary of a AppsflyerCapiExport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "att_field": "string",
      "audience_events": "enters_only",
      "bundle_id": "string",
      "counter": "string",
      "currency_code": "AED",
      "device_type_field": "string",
      "event_name": "string",
      "event_timestamp": "string",
      "event_value_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "inst_date_field": "string",
      "ip_field": "string",
      "lang_field": "string",
      "os_field": "string",
      "segment_ids": [
        "string"
      ],
      "ua_field": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

AppsflyerCapiExport: Update job

PUThttps://api.lytics.io/v2/job/appsflyer-capi-export/{id}

Update a AppsflyerCapiExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "att_field": "string",
    "audience_events": "enters_only",
    "bundle_id": "string",
    "counter": "string",
    "currency_code": "AED",
    "device_type_field": "string",
    "event_name": "string",
    "event_timestamp": "string",
    "event_value_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "inst_date_field": "string",
    "ip_field": "string",
    "lang_field": "string",
    "os_field": "string",
    "segment_ids": [
      "string"
    ],
    "ua_field": "string",
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "att_field": "string",
      "audience_events": "enters_only",
      "bundle_id": "string",
      "counter": "string",
      "currency_code": "AED",
      "device_type_field": "string",
      "event_name": "string",
      "event_timestamp": "string",
      "event_value_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "inst_date_field": "string",
      "ip_field": "string",
      "lang_field": "string",
      "os_field": "string",
      "segment_ids": [
        "string"
      ],
      "ua_field": "string",
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.att_fieldoptionalstring

iOS only. Lytics user field containing the App Tracking Transparency status (0,1,2,3). If att is 0/1/2 and no idfa is mapped, the zero-UUID is sent per AppsFlyer spec.

config.audience_eventsoptionalstring

Select which type of audience trigger events to send. By default both enters and exits will be sent.

One of: enters_only, exits_only

config.bundle_idoptionalstring

Optional bundle ID (iOS) or package name override (Android). If empty, the field is omitted from the payload and AppsFlyer uses the App ID from the auth config.

config.counteroptionalstring

App-open counter. Post-install conversion events must use "3" or higher; default "4".

config.currency_codeoptionalstring

Default currency for the event when af_currency is not mapped.

One of: AED, AUD, BRL, CAD, CNY, EUR, GBP, INR, JPY, MXN, SAR, SEK, SGD, TRY, USD

config.device_type_fieldoptionalstring

Lytics user field containing the device type/model.

config.event_namerequiredstring

AppsFlyer event name to send (e.g. af_purchase, af_login, or a custom name).

config.event_timestampoptionalstring

Lytics user field containing the event timestamp (ISO8601 UTC). Required: users missing this field are dropped from the export.

config.event_value_mappingoptionalobject[]

Map Lytics user fields to AppsFlyer event_value keys (e.g. af_revenue, af_currency, af_content_type).

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to AppsFlyer.

config.identifier_mappingrequiredobject[]

Map Lytics user fields to AppsFlyer device/user identifiers. iOS supports uid, idfa, idfv, cid. Android supports uid, advertising_id, oaid, android_id, cid.

config.inst_date_fieldoptionalstring

Lytics user field containing the app install date (ISO8601 UTC). If empty, the event timestamp is used.

config.ip_fieldoptionalstring

Lytics user field containing the device IP address. If empty, a placeholder is sent; AppsFlyer requires a value to be present.

config.lang_fieldoptionalstring

Lytics user field containing the device locale (e.g. en-US). If empty, "en-US" is used.

config.os_fieldoptionalstring

Lytics user field containing the device OS version.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contain the users to export

config.ua_fieldoptionalstring

Lytics user field containing the device user agent. If empty, a generic UA is used.

config.withbackfilloptionalboolean

Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience.

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.att_fieldoptionalstring

iOS only. Lytics user field containing the App Tracking Transparency status (0,1,2,3). If att is 0/1/2 and no idfa is mapped, the zero-UUID is sent per AppsFlyer spec.

config.audience_eventsoptionalstring

Select which type of audience trigger events to send. By default both enters and exits will be sent.

One of: enters_only, exits_only

config.bundle_idoptionalstring

Optional bundle ID (iOS) or package name override (Android). If empty, the field is omitted from the payload and AppsFlyer uses the App ID from the auth config.

config.counteroptionalstring

App-open counter. Post-install conversion events must use "3" or higher; default "4".

config.currency_codeoptionalstring

Default currency for the event when af_currency is not mapped.

One of: AED, AUD, BRL, CAD, CNY, EUR, GBP, INR, JPY, MXN, SAR, SEK, SGD, TRY, USD

config.device_type_fieldoptionalstring

Lytics user field containing the device type/model.

config.event_namerequiredstring

AppsFlyer event name to send (e.g. af_purchase, af_login, or a custom name).

config.event_timestampoptionalstring

Lytics user field containing the event timestamp (ISO8601 UTC). Required: users missing this field are dropped from the export.

config.event_value_mappingoptionalobject[]

Map Lytics user fields to AppsFlyer event_value keys (e.g. af_revenue, af_currency, af_content_type).

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to AppsFlyer.

config.identifier_mappingrequiredobject[]

Map Lytics user fields to AppsFlyer device/user identifiers. iOS supports uid, idfa, idfv, cid. Android supports uid, advertising_id, oaid, android_id, cid.

config.inst_date_fieldoptionalstring

Lytics user field containing the app install date (ISO8601 UTC). If empty, the event timestamp is used.

config.ip_fieldoptionalstring

Lytics user field containing the device IP address. If empty, a placeholder is sent; AppsFlyer requires a value to be present.

config.lang_fieldoptionalstring

Lytics user field containing the device locale (e.g. en-US). If empty, "en-US" is used.

config.os_fieldoptionalstring

Lytics user field containing the device OS version.

config.segment_idsrequiredstring[]

Select the Lytics audiences that contain the users to export

config.ua_fieldoptionalstring

Lytics user field containing the device user agent. If empty, a generic UA is used.

config.withbackfilloptionalboolean

Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the audience.

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring