Apsalar Event API

Last Updated: Apr 22, 2017 04:18PM PDT
Apsalar provides a REST API, to pass: installs and events as an alternative method of integration.  This simplified approach enables easy passing of data from both attribution measurement companies and directly to Apsalar.

Please note that the REST API event calls are not reported in Apsalar's Event Report.

Caution: Apsalar recommends using either an SDK or REST API integration. In the event that both the SDK and Event API are used in a hybrid integration, it is recommended to use a different naming convention for SDK and API events. Please contact support for clarity if you have questions.

Please review the restrictions on Event names, attributes, and query string lengths here.

Reporting installs

Required query string parameters to report an App Launch.

NOTE: The first App launch, recognized for a device, will be recorded as an install. Subsequent App launch calls will be considered an App open event. The 'launch' call should be sent for each App open event.

Base URI
  •  https://api.apsalar.com/api/v1/launch?
Device ID
  • iOS IDs
    • idfa - raw AdvertiserIdentifier upper-case with dashes
    • idfv - the raw 'identifierForVendor' upper-case with dashes
  • Android IDs
    • aifa - raw Android advertising ID
    • andi - raw Android ID without any alteration to the ID
Device profile
  • ip - raw IP address of the device (with decimal points or colons); both IPv4 and IPv6 are supported
  • ve - version of the OS on the device (e.g. 9.2)
  • ma - make of the device hardware, typically the consumer-facing name (e.g. Samsung, LG, Apple).  This parameter must be used with the model parameter.
  • mo - model of the device hardware (e.g. iPhone 4S, Galaxy SIII).  This parameter must be used with the make parameter.
  • lc - the IETF local tag for the device, using two-letter language and country code separated by an underscore.
    Example: 'lc=en_US'
Platform
  • p - 'Android' or 'iOS'
Token
  • a - Apsalar API key
Application
  • i - longname (com.domain.prod) of the application for iOS or Android
Operating System
  • bd - Build number of the device OS.
    Example: 'bd=Build/13D15' (pass as string: "Build%2F" + Build.ID)
    Note: the "/" is http encoded

Optional query string parameters for reporting installs

  • Campaign parameters
    • clid - the Apsalar-generated click ID returned in a postback
  • Application parameters
    • n - human readable name of the application as displayed in the UI
  • Session/install parameters
    • utime - time of the session in UNIX time
    • umilisec - time of the session in miliseconds UNIX time
  • Device parameters
    • dnt - pass 1 if do not track is enabled, 0 if do not track is disabled
    • dntoff - pass 0 if do not track is enabled, 1 if do not track is disabled
    • c - connection type 'wifi' or 'carrier'
    • cn - carrier name of the internet provider
  • Android additional identifiers
    • aif1 - SHA-1 hash the raw Android Advertising ID without any alteration to the ID
    • aif5 - MD5 hash of the raw Android Advertising ID without any alteration to the ID

Sample calls

Basic install or session start call
https://api.apsalar.com/api/v1/launch?aifa=8ecd7512-2864-440c-93f3-a3cabe62525b&andi=fc8d449516de0dfb&p=Android&a=ArNCAdef&i=com.apsalarapp.prod&ip=10.1.2.3&ve=9.2&lc=en_US&bd=Build%2FMMB29K&ma=samsung&mo=SM-G935F​

Advanced call with additional device and application attributes
https://api.apsalar.com/api/v1/launch?aifa=8ecd7512-2864-440c-93f3-a3cabe62525b&andi=fc8d449516de0dfb&p=Android&a=ArNCAdef&i=com.apsalarapp.prod&ip=10.1.2.3&ve=9.2&n=Balloon+Jump&dnt=0&ma=Apple&mo=iPhone+4S&c=wifi&cn=Comcast&lc=en_US&bd=Build%2FMMB29K&ma=samsung&mo=SM-G935F​

 

Reporting events

Required query string parameters for reporting events

Base URI
  • https://api.apsalar.com/api/v1/evt?
Event
  • n - name of the event
Device ID
  • iOS IDs
    • idfa - raw AdvertiserIdentifier upper-case with dashes
    • idfv - the raw 'identifierForVendor' upper-case with dashes
  • Android IDs
    • aifa - raw Android advertising ID
    • andi - raw Android ID without any alteration to the ID
Device profile
  • ip - raw IP address of the device (with decimal points or colons); both IPv4 and IPv6 are supported
  • ve - version of the OS on the device (e.g. 9.2)
  • ma - make of the device hardware, typically the consumer-facing name (e.g. Samsung, LG, Apple).  This parameter must be used with the model parameter.
  • mo - model of the device hardware (e.g. iPhone 4S, Galaxy SIII).  This parameter must be used with the make parameter.
  • lc - the IETF local tag for the device, using two-letter language and country code separated by an underscore.
    Example: 'lc=en_US'
Platform
  • p - 'Android' or 'iOS'
Token
  • a - Apsalar API key
Application
  • i - longname (com.domain.prod) of the application for iOS or Android 
Operating System
  • bd - Build number of the device OS. 
    Example: 'bd=Build/13D15' (pass as string: "Build%2F" + Build.ID)
    Note: the "/" is http encoded

Optional query string parameters for reporting events

  • Event time parameters. Use one of the following:
    • utime - time of the event in UNIX time
    • umilisec - time of the event in milliseconds UNIX time
  • Android additional identifiers
    • aif1 - SHA-1 hash the raw Android Advertising ID without any alteration to the ID
    • aif5 - MD5 hash of the raw Android Advertising ID without any alteration to the ID
  • iOS additional identifiers
    • ifa1 - SHA-1 hash the raw iOS Advertising ID without any alteration to the ID
    • ifa5 - MD5 hash of the raw iOS Advertising ID without any alteration to the ID
  • Revenue parameters
    • amt - the currency amount expressed as a numerical value with decimal points (e.g. 2.51).  This should be used in conjunction with the 'cur' parameter.
    • cur - the ISO 4217 three-letter currency code.  This should be used in conjunction with the 'amt' parameter. For example:
      • USD - the currency amount expressed in United States Dollars
      • EUR - the currency amount expressed in Euros
      • YEN - the currency amount expressed in Yen
Please note: For API revenue events, you need to send revenue in the call itself and cannot rely on the revenue value in the Applications page.
  • Event attributes
    • e - event attributes formatted as a JSON encoded value

      Sample shopping cart data
      {"items": [{"sku": 8675309, "qty": 42},
      {"sku": 11235813, "qty": 21}],
      "shipping": "standard"}
      Sample shopping cart data encoded
      %7B%22items%22%3A%20%5B%7B%22sku%22%3A%208675309%2C%20%22qty%22%3A%2042%7D%2C%20%7B%22sku%22%3A%2011235813%2C%20%22qty%22%3A%2021%7D%5D%2C%20%22shipping%22%3A%20%22standard%22%7D

Sample event calls

Basic event call
https://api.apsalar.com/api/v1/evt?aifa=8ecd7512-2864-440c-93f3-a3cabe62525b&andi=fc8d449516de0dfb&p=Android&a=ArNCAdef&i=com.apsalarapp.prod&n=search&ip=10.1.2.3&ve=9.2&lc=en_US&bd=Build%2FMMB29K&ma=samsung&mo=SM-G935F​
Revenue event call
https://api.apsalar.com/api/v1/evt?aifa=8ecd7512-2864-440c-93f3-a3cabe62525b&andi=fc8d449516de0dfb&p=Android&a=ArNCAdef&i=com.apsalarapp.prod&n=purchase&amt=2.51&cur=USD&ip=10.1.2.3&ve=9.2&lc=en_US&bd=Build%2FMMB29K&ma=samsung&mo=SM-G935F​
Event call with attributes
https://api.apsalar.com/api/v1/evt?aifa=8ecd7512-2864-440c-93f3-a3cabe62525b&andi=fc8d449516de0dfb&p=Android&a=ArNCAdef&i=com.apsalarapp.prod&lc=en_US&bd=Build%2FMMB29K&ma=samsung&mo=SM-G935F&ip=10.1.2.3&ve=9.2&n=purchase&e=%7B%22items%22%3A%20%5B%7B%22sku%22%3A%208675309%2C%20%22qty%22%3A%2042%7D%2C%20%7B%22sku%22%3A%2011235813%2C%20%22qty%22%3A%2021%7D%5D%2C%20%22shipping%22%3A%20%22standard%22%7D​
support@apsalar.com
http://assets2.desk.com/
apsalarinc
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
Invalid characters found
/customer/en/portal/articles/autocomplete