Home Guides Recipes API reference 🚀 Developer Journey

API reference

Home Guides Recipes API reference 🚀 Developer Journey

Overview

API Reference Overview

ONELINK

HiddenTitle

Deep linking REST API

iOS deep linking request
- Deep linking for IOSpost
Android deep linking request
- Deep linking for Androidpost

OneLink API

OneLink REST API

Raw data report

HiddenTitle

Push API Configuration API

Message Fields
- Retrieve per platformget
Event Types
- Retrieve per attributing-entityget
URL Validation
- Validate URLpost
Manage Push API configuration
- Update Push API configurationput
- Get Push API configurationget
Authentication Token
- Set Push API Authentication Tokenput
- Delete Push API Authentication Tokendelete

Raw Data Pull API V2 Token

Overview
Raw data reports (non-organic)
Raw data reports (organic)
Retargeting
- Conversions (re-engagements & re-attributions)get
- In-app eventsget
Ad Revenue raw data
Protect360 fraud
Postbacks

Measurements

HiddenTitle

Engagements API

Click Engagement
- Click Engagementget
- Click Engagementpost
Impression Engagement
- Impression Engagementget
- Impression Engagementpost

PC/Console/CTV Events API

Overview
Measure first app opens
- Measure first app openspost
Measure sessions
- Measure sessionspost
Measure in-app events
- Measure in-app eventspost
Retrieving User Agent

Server-to-server events API (for mobile)

Overview
Inapp Events
- Send Eventpost
- FAQ

WEB Server-TO-Server API

Events management
- Associate Customer User ID with AF User IDpost
- Send Eventpost

Preload Measurement API

Download Events
- Download eventpost

Preload C2S Measurement API

Download Events
- Download eventpost

[Legacy] Server-to-server events API (for mobile)

Inapp Events
- Send Eventpost

SKAN

HiddenTitle

SKAN CV schema API for ad networks

SKAN CV schema API for ad networks

SKAN CV Schema API for Advertisers

Conversion value (CV) schema
- Get CV schemaget

SKAN conversion studio API

SKAN conversion studio API

SKAN aggregated postback by arrival date API

SKAN postbacks
- Get aggregated postbacksget

SKAN aggregated performance report API

SKAN performance report
- Get performance reportget

ROI

HiddenTitle

True Revenue tax API

Tax rate rules

AdRevenue Account Integrations API

Ad revenue partner integration API
Account Integration
- Set integrationpost
- List integrationsget

InCost API

Overview
InCost uploader
- Upload cost datapost
InCost job status
- Get job statusget

Mobile

HiddenTitle

GCD API for SDK attribution testing

Conversion Data for SDK attribution testing
- Get the conversion dataget

Test Console API

Events
- Retrieve eventsget
Allowed devices
- Add devicepost
- Delete devicedelete

Analytics

HiddenTitle

Cohort API

Cohort Report
- Create Cohort Reportpost

Aggregate Pull API V2 Token

Overview
Aggregate (user acquisition and retargeting)

Master API

Overview
Master Report
- Get Master Reportget

Master freshness API

Freshness Report
- Get last updateget

Marketplace

HiddenTitle

Partner integration settings API

Unique partner integration parameters
- Get a list of unique parametersget
Active integrations
- Get active integrationsget
- Get active integration parametersget
Integration settings
- Copy partner integration settingspost
- Deprecated - Copy partner integration settingspost
Google Play install referrer
- Set install referrer decryption keypost

Audiences

HiddenTitle

Audience External API

Overview
Create audience
- Create new imported audiencepost
Audience connections
- List partner connections for audienceget
- Connect audience to existing partnersput
Audience split
- Get split percentages for audienceget
- Update split percentages for audienceput
Audience upload
- Upload audience to partners nowpost
Account connections
- List partner connections for accountget
Account splits
- Get split percentages for accountget
Active audiences
- Get active audiences for accountget
Pauses audience
- Pause audiencepost

Additional Identifiers API

Additional Identifiers Handling
- Add, Modify or Removeput

Audience Import API

Import audience
- Import a new audiencepost

Management

HiddenTitle

App list API for Ad Networks

Overview
Get app list
- App listget

User management

Overview
Managing users in bulk
Managing roles
- Get rolesget

App management API V2.0

Overview
Error messages
Supported formats
App management

Misc

HiddenTitle

Click Signing API

Overview
Get config
- Get click signing configget
Update config
- Update click signing configput
- Remove excluded appdelete
Circuit breaker
- Circuit breakerput
Add excluded app
- Add excluded apppost
Report
- Reportget
Test
- Testpost
Generate secret key
- Generate secret keypost
Revoke secret key
- Revoke secret keydelete

Overview

🚧
It is recommended to use the v2 version based on Bearer authentication.

🚧It is recommended to use the v2 version based on Bearer authentication.

🚧
It is recommended to use the v2 version based on Bearer authentication.