App settings endpoint

Use the /app/{app_token}/settings endpoint to retrieve detailed app settings. This endpoint provides comprehensive information about your app’s configuration, including events, partners, attribution settings, and more.

Get app settings

Retrieve detailed settings for a specific app. You can request all settings or filter by specific sections.

API protocol

Endpoint: https://automate.adjust.com/app-automation/app/{app_token}/settings

Method: GET

Response: App Settings Response

Parameters

Parameter	Data type	In	Required	Description
`app_token`	`String`	Path	Yes	The Adjust app token.
`sections`	`Array[String]`	Query	No	Filter to specific sections. If not provided, all sections are returned.

Available sections

This endpoint supports all sections listed in App Settings Response.

Examples

Get all app settings

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "app_info": {
      "id": 12345,
      "name": "My App",
      "app_token": "abc123xyz",
      "default_platform": "android",
      "stores": {
         "google_play": { "store_id": "com.example.myapp" }
      }
   },
   "events": [
      {
         "name": "purchase",
         "unique": false,
         "archived": false,
         "token": "abc1de",
         "app_token": "abc123xyz"
      },
      {
         "name": "registration",
         "unique": true,
         "archived": false,
         "token": "fgh2ij",
         "app_token": "abc123xyz"
      }
   ],
   "partners": [
      {
         "name": "facebook",
         "revenue_forwarding": true,
         "session_forwarding": false,
         "parameter_forwarding": true,
         "events_linking": { "purchase": "fb_purchase" }
      }
   ],
   "attribution_settings": {
      "click_device_matching": { "window": 604800, "enabled": true },
      "click_fingerprinting": { "window": 86400, "enabled": true },
      "impression_device_matching": { "window": 86400, "enabled": true }
   }
}

Get specific sections only

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=events&sections=partners' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "events": [
      {
         "name": "purchase",
         "unique": false,
         "archived": false,
         "token": "abc1de",
         "app_token": "abc123xyz"
      }
   ],
   "partners": [
      {
         "name": "facebook",
         "revenue_forwarding": true,
         "session_forwarding": false,
         "events_linking": {}
      }
   ]
}

Get SDK secrets (including v3)

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=combined_secrets' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "combined_secrets": {
      "enforce_install_signing": true,
      "secrets": [
         {
            "id": 1001,
            "name": "Production Secret",
            "active": true,
            "value": ["secret1", "secret2", "info1", "info2"],
            "internal_version": 2,
            "version": 2,
            "created_at": "2024-01-15T10:30:00Z",
            "updated_at": "2024-01-15T10:30:00Z"
         },
         {
            "id": 2001,
            "platform": "android",
            "label": "Android SDK Secret",
            "active": true,
            "algorithm": "adj1",
            "internal_version": 2,
            "version": 3,
            "created_at": "2024-06-01T12:00:00Z",
            "updated_at": "2024-06-01T12:00:00Z"
         }
      ]
   }
}

Get settings as CSV

Export app settings in CSV format. Currently supports exporting events.

API protocol

Endpoint: https://automate.adjust.com/app-automation/settings/csv

Method: GET

Response: CSV file content

Parameters

Parameter	Data type	In	Required	Description
`section`	`String`	Query	Yes	The section to export. Currently only `events` is supported.
`app_tokens`	`String`	Query	Yes	Comma-separated list of app tokens to include in the export.

Example

curl --location 'https://automate.adjust.com/app-automation/settings/csv?section=events&app_tokens=abc123xyz,def456uvw' \
--header 'Authorization: Bearer {your-adjust-api-token}'

app_token,event_name,event_token,unique,archived
abc123xyz,purchase,abc1de,false,false
abc123xyz,registration,fgh2ij,true,false
def456uvw,purchase,klm3no,false,false
def456uvw,level_complete,pqr4st,false,false

Data models

App Settings Response

All fields are optional and only included if the corresponding section is requested.

Parameter	Data type	Description
`app_info`	`Object`	Basic app information.
`attribution_privacy_model`	`String`	Attribution privacy model (iOS only).
`attribution_settings`	`Object`	Attribution window configurations.
`callbacks`	`Array[Object]`	Server callback configurations.
`csv_upload_settings`	`Object`	Cloud storage upload settings.
`events`	`Array[Object]`	Event definitions.
`external_data_forwarding`	`Object`	Data forwarding settings.
`fraud_prevention_settings`	`Object`	Fraud prevention configuration.
`partners`	`Array[Object]`	Partner module configurations.
`purchase_verification`	`Object`	Purchase verification settings.
`signature`	`Object`	Signature settings including Android fingerprints.
`sdk_secrets`	`Object`	Legacy SDK secrets configuration.
`combined_secrets`	`Object`	All SDK secrets (legacy + v3).
`skad_network`	`Object`	SKAdNetwork v3 settings.
`skad_network_v4`	`Object`	SKAdNetwork v4 settings.
`preview_link_settings`	`Object`	Social sharing preview settings.
`s2s`	`Object`	S2S security settings.
`trackers`	`Array[Object]`	Tracker configurations.

Event Settings

Parameter	Data type	Description
`name`*	`String`	Event name.
`unique`*	`Boolean`	Whether the event is unique per user.
`archived`*	`Boolean`	Whether the event is archived.
`token`*	`String`	Event token for SDK integration.
`app_token`*	`String`	The app token this event belongs to.

Partner Settings

Parameter	Data type	Description
`name`*	`String`	Partner name/slug.
`revenue_forwarding`	`Boolean`	Whether revenue data is forwarded.
`session_forwarding`	`Boolean`	Whether session data is forwarded.
`parameter_forwarding`	`Boolean`	Whether partner parameters are forwarded.
`cost_forwarding`	`Boolean`	Whether cost data is forwarded.
`attributed_only`	`Boolean`	Whether to forward attributed data only.
`uninstall_forwarding`	`Boolean`	Whether uninstall data is forwarded.
`ad_revenue_forwarding`	`Boolean`	Whether ad revenue is forwarded.
`channel_setup`	`Object`	Partner-specific configuration.
`events_linking`	`Object`	Event name mapping for this partner.

Combined Secrets Response

Parameter	Data type	Description
`enforce_install_signing`*	`Boolean`	Whether to reject unsigned installs.
`secrets`*	`Array[Object]`	List of all SDK secrets including the legacy one.

Legacy Secret

Parameter	Data type	Description
`id`*	`Integer`	Secret ID.
`name`	`String`	Secret name/label.
`active`*	`Boolean`	Whether the secret is active.
`value`*	`Array[String]`	Secret values.
`internal_version`*	`Integer`	SDK Signature library version.
`version`*	`Integer`	SDK secret version (1 or 2).
`created_at`*	`String`	ISO datetime when created.
`updated_at`*	`String`	ISO datetime when last updated.

SDK Secret

Parameter	Data type	Description
`id`*	`Integer`	Secret ID.
`platform`*	`String`	Target platform (`android`, `ios`).
`label`*	`String`	Secret label.
`active`*	`Boolean`	Whether the secret is active.
`algorithm`*	`String`	Signature algorithm.
`internal_version`*	`Integer`	SDK Signature library version.
`version`*	`Integer`	SDK secret version (3 or higher).
`created_at`*	`String`	ISO datetime when created.
`updated_at`*	`String`	ISO datetime when last updated.