Server-to-Server In-App Events API (HTTP API)

Introduction

The purpose of this API is to allow you to send events which occur outside the mobile app, directly to the AppsFlyer server.  For example, if you have both a web and mobile interface, you can record all events from both mediums in AppsFlyer. 

It is important to pay extra attention that the App ID on iOS contains the leading "id" before the ID, otherwise the request ends with HTTPS 200 OK, but the event is not registered.

Method: POST

Header - "authentication"= {dev-key}

The dev key is found in Dashboard >> App Settings >> Dev Key

{
"appsflyer_id": {This is a mandatory field, AppsFlyer Device ID must be used },  // e.g. 1415211453000-6513894 
"idfa":{idfa},
"customer_user_id": {customer_user_id}, // Customer User ID optional parameter 
"bundle_id":{bundle_id},
"eventName": {The event name}, // e.g. "af_purchase"
"eventValue": {A JSON containing a rich in-app event value}, // e.g "{\"af_revenue\":\"6\" ,\"af_content_type\":\"wallets\", \"af_content_id\":\"15854\"}"
"eventCurrency": {Event currency}, // e.g "USD"
"ip": {device IP},
"eventTime": {Event timestamp in UTC}, // e.g  "2014-05-15 12:17:00.000"
"af_events_api" :"true"
}

{
"appsflyer_id": {This is a mandatory field, "AppsFlyer Device id" must be used },  // e.g. 1415211453000-6513894 
"advertising_id": {advertising_id},
"customer_user_id": {customer_user_id}, // Customer User ID optional parameter ---
"eventName": {The event name}, // e.g "af_purchase"
"eventValue": {A JSON containing a rich in-app event value}, // e.g "{\"af_revenue\":\"6\" ,\"af_content_id\":\"15854\"}"
"eventCurrency": {Event currency}, // e.g "USD"
"ip": {device IP},
"eventTime": {Event timestamp in UTC}, // e.g  "2014-05-15 12:17:00.000"
"af_events_api" :"true"
}

Requirements

1. Mandatory parameters: appsflyer_id (AppsFlyer Device id), eventName, eventValue and af_events_api
2. Highly recommended parameters: idfa for iOS and advertising_id for Android
3. eventValue can be with an empty value, i.e., "eventValue":"", (no space is needed)
4. IP address (ip) should be the IP of the mobile device (during the event occurrence)
5. The customer user ID field (customer_user_id) is a user identifier parameter, mapped to the Customer User ID field in the Raw Reports. The Customer User ID SDK API attaches this value automatically to all SDK originated in-app events. Make sure to include this field will ALL your S2S events to enjoy the same functionality.

Timing the Events

Server-to-server events can be sent in real time or in batch mode. 

You can use the optional eventTime parameter to specify the time of the event occurrence (in UTC timezone). If the parameter is not included in the message, AppsFlyer uses the timestamp from the HTTPS message received. 

eventTime format is: "yyyy-MM-dd HH:mm:ss.SSS" (e.g. "2014-05-15 12:17:00.000")  

In batch mode, for events to be recorded with their real time stamps, they must all be sent to AppsFlyer by 02:00 AM (UTC) of the following day.   

Events with past time stamps, which are not sent by 2:00 AM, are recorded under the time that they were sent.

Service Return Codes

200

OK when the request has been processed by the Appsflyer system.

401

unauthorized when the key provided in the authentication header is not the dev-key for this app.

400

Bad request when the request failed at least one of the validation criteria

500

Internal server error this indicates a server error

If your servers are protected by a firewall you will need to white list the incoming responses from AWS IP address Ranges to receive the return messages.

Request Body Example

{
"appsflyer_id": "1415211453000-6513894",
"advertising_id": "38412345-8cf0-aa78-b23e-10b96e40000d",
"eventName": "af_purchase",
"eventValue": "{\"af_revenue\":\"6\",\"af_content_type\":\"wallets\",\"af_content_id\":\"15854\",\"af_quantity\":1}",
"eventCurrency": "USD",
"ip": "1.2.3.4",
"eventTime": "2014-05-15 12:17:00.000",
"af_events_api" :"true"
}

In this case, AppsFlyer receives an S2S in-app event which represents a purchase event with revenue, as well as additional properties such as content type etc.

AppsFlyer is then able, according to the advertiser's configuration, to send such rich in-app events to media sources for advanced targeting, optimisation and audience creation purposes.

Fetching the AppsFlyer Device ID

appsflyer_id is a mandatory parameter in server-to-server event messages. AppsFlyer uses this parameter to attribute the event to the original device and to the attributed media source. 

There are several ways of obtaining this ID.

1. From the mobile device using AppsFlyer's SDK API (Android / iOS)

2. Via the Pull or Push API (click on link for more information about Push API or Pull API)

3. Export the raw data installation report