Branch Metrics

FREE
By maephet
Updated 7 months ago
Social
-/10
Popularity Score
-
Latency
-
Success Rate

Branch Metrics API Documentation

The Branch SDK Less API under branch metrics is used to track events associated with user and tie back to referring source and generate URL for sharing/referral purposes (optional for tracking shareability/invites/referrals).

View API Details
Integration
POSTSession start
POSTSession end
POSTChanging the identity
POSTIdendity
POSTAction tracking
POSTCreating a deeplinking referral URL
GETGetting credit count
POSTRedeeming credits
POSTSession start

Start up app.

Authorization:
Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
app_idSTRING
REQUIREDThe id of the originating app.
hardware_idSTRING
REQUIREDIDFA/ANDROID_ID
ipSTRING
REQUIREDthe IP address of the client mobile device.
app idQUERY
REQUIREDQUERYAuth
Optional Parameters
identitySTRING
OPTIONALSet the identity of the user.
is_referrableSTRING
OPTIONALwhich dictates whether the user can be referred in on this call. Does not overwrite previous referral association
app_versionSTRING
OPTIONALCurrent app version
carrierSTRING
OPTIONALWireless carrier of the device owner
bluetoothSTRING
OPTIONALSet to "none", "ble", or "classic"
has_nfcSTRING
OPTIONALHas NFC
has_telephoneSTRING
OPTIONALSet to true if this device has telephone functionality, false if not
brandSTRING
OPTIONAL
modelSTRING
OPTIONALDevice model
osSTRING
OPTIONAL
os_versionSTRING
OPTIONALCurrent Android version for this device
screen_dpiSTRING
OPTIONALPixel density of the device screen
screen_heightSTRING
OPTIONALHeight, in pixels, of the device screen
screen_widthSTRING
OPTIONALWidth, in pixels, of the device screen
wifiSTRING
OPTIONALSet to true is Wifi is connected, false if not
link_identifierSTRING
OPTIONALAppend the identifier passed in to the deep link to this call
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication