adjust-icon

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.

Unlike the App endpoint’s retrieve operations (get by token, get by store ID, list apps), this endpoint returns settings for any app in your account—including apps created or managed only in the Adjust dashboard.

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

ParameterData typeInRequiredDescription
app_tokenStringPathYesThe Adjust app token.
sectionsArray[String]QueryNoFilter 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

Request - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings' \
--header 'Authorization: Bearer {your-adjust-api-token}'
Response
{
"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": false,
"cost_forwarding": false,
"attributed_only": false,
"uninstall_forwarding": false,
"ad_revenue_forwarding": false,
"limited_data_use": true,
"inactive_user_definition": false,
"channel_setup": {
"app_id": "651107451918933"
},
"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

Request - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=events&sections=partners' \
--header 'Authorization: Bearer {your-adjust-api-token}'
Response
{
"events": [
{
"name": "purchase",
"unique": false,
"archived": false,
"token": "abc1de",
"app_token": "abc123xyz"
}
],
"partners": [
{
"name": "facebook",
"revenue_forwarding": true,
"session_forwarding": false,
"limited_data_use": true,
"inactive_user_definition": false,
"channel_setup": {
"app_id": "651107451918933"
},
"events_linking": {}
}
]
}

Get SDK secrets (including v3)

Request - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=combined_secrets' \
--header 'Authorization: Bearer {your-adjust-api-token}'
Response
{
"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

ParameterData typeInRequiredDescription
sectionStringQueryYesThe section to export. Currently only events is supported.
app_tokensStringQueryYesComma-separated list of app tokens to include in the export.

Example

Request - cURL
curl --location 'https://automate.adjust.com/app-automation/settings/csv?section=events&app_tokens=abc123xyz,def456uvw' \
--header 'Authorization: Bearer {your-adjust-api-token}'
Response (CSV)
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.

ParameterData typeDescription
app_infoObjectBasic app information.
attribution_privacy_modelStringAttribution privacy model (iOS only).
attribution_settingsObjectAttribution window configurations.
callbacksArray[Object]Server callback configurations.
csv_upload_settingsObjectCloud storage upload settings.
eventsArray[Object]Event definitions.
external_data_forwardingObjectData forwarding settings.
fraud_prevention_settingsObjectFraud prevention configuration.
partnersArray[Object]Partner module configurations.
purchase_verificationObjectPurchase verification settings.
signatureObjectSignature settings including Android fingerprints.
sdk_secretsObjectLegacy SDK secrets configuration.
combined_secretsObjectAll SDK secrets (legacy + v3).
skad_networkObjectSKAdNetwork v3 settings.
skad_network_v4ObjectSKAdNetwork v4 settings.
preview_link_settingsObjectSocial sharing preview settings.
s2sObjectS2S security settings.
trackersArray[Object]Tracker configurations.

Event Settings

ParameterData typeDescription
name*StringEvent name.
unique*BooleanWhether the event is unique per user.
archived*BooleanWhether the event is archived.
token*StringEvent token for SDK integration.
app_token*StringThe app token this event belongs to.

Partner Settings

ParameterData typeDescription
name*StringPartner name/slug.
revenue_forwardingBooleanWhether revenue data is forwarded.
session_forwardingBooleanWhether session data is forwarded.
parameter_forwardingBooleanWhether partner parameters are forwarded.
cost_forwardingBooleanWhether cost data is forwarded.
attributed_onlyBooleanWhether to forward attributed data only.
uninstall_forwardingBooleanWhether uninstall data is forwarded.
ad_revenue_forwardingBooleanWhether ad revenue is forwarded.
limited_data_useBooleanWhether limited data use is enabled.
inactive_user_definitionBooleanWhether inactive user definition is enabled.
channel_setupObjectPartner-specific configuration.
events_linkingObjectEvent name mapping for this partner.

Combined Secrets Response

ParameterData typeDescription
enforce_install_signing*BooleanWhether to reject unsigned installs.
secrets*Array[Object]List of all SDK secrets including the legacy one.

Legacy Secret

ParameterData typeDescription
id*IntegerSecret ID.
nameStringSecret name/label.
active*BooleanWhether the secret is active.
value*Array[String]Secret values.
internal_version*IntegerSDK Signature library version.
version*IntegerSDK secret version (1 or 2).
created_at*StringISO datetime when created.
updated_at*StringISO datetime when last updated.

SDK Secret

ParameterData typeDescription
id*IntegerSecret ID.
platform*StringTarget platform (android, ios).
label*StringSecret label.
active*BooleanWhether the secret is active.
algorithm*StringSignature algorithm.
internal_version*IntegerSDK Signature library version.
version*IntegerSDK secret version (3 or higher).
created_at*StringISO datetime when created.
updated_at*StringISO datetime when last updated.