FlurryAnalytics

iOSSDKInstructions

SDKversion5.2.0
Updated:07/01/2014

WelcometoFlurryAnalytics!

Thisfilecontains:

1.Introduction
2.IntegrationInstructions
3.OptionalFeatures
4.Recommendations
5.FAQ

1.Introduction

TheFlurryiOSAnalyticsAgentallowsyoutotracktheusageandbehaviorofyouriOSapplication
onusers'phonesforviewingintheFlurryAnalyticssystem.Itisdesignedtobeaseasyaspossible
withabasicsetupcompleteinunder5minutes.

PleasenotethatthisSDKwillonlyworkwithXcode4.5orabove.IfyouneedanSDKforanolderXcodeversion
pleaseemailsupport.

FlurryAgentdoesnotrequireCoreLocationframeworkandwillnotcollectGPSlocationbydefault.Developerswho
usetheirownCLLocationManagercansetGPSlocationinformationintheFlurryAgent(seeOptionalFeaturesfor
moreinformation).

WealsorecommendcallingFlurryAnalyticsfromthemainthread.FlurryAnalyticsisnotsupportedwhencalled
fromotherthreads.

ThereareadditionalfoldersforusewithFlurryAds.Theseoptionallibrariesprovidealternatestreamsofrevenuefor
yourapps.IfyouwouldliketouseFlurryAdspleaserefertoFlurryAdsiOSREADME.pdf.
2.Integration

1.Inthefinder,dragFlurry/intoproject'sfilefolder.(NOTE:IfyouareupgradingtheFlurryiOSSDK,besureto
removeanyexistingFlurrylibraryfoldersfromyourproject'sfilefolderbeforeproceeding.)

2.Nowaddittoyourproject:
File>AddFilestoYourProject>Flurry
Destination:selectCopyitemsintodestinationgroupsfolder(ifneeded)
Folders:Choose'Creategroupsforanyaddedfolders'
Addtotargets:selectalltargetsthatthelibwillbeusedfor

3.AddSecurity.frameworktoyourapp.iOSSecurityframeworkisrequiredtobuildFlurryAnalytics.Flurry
librarywillthrowalinkingerrorduringbuildprocesswithoutit.

4.AddSystemConfiguration.frameworktoyourapp.ThisisrequiredforReachabilitytomanagenetworkoperations
efficiently.

5.InyourApplicationDelegate:
ImportFlurryandinside"applicationDidFinishLaunching:"add:[FlurrystartSession:@"YOUR_API_KEY"]

#import"Flurry.h"

(void)applicationDidFinishLaunching:(UIApplication*)application{

[FlurrystartSession:@"YOUR_API_KEY"]
//yourcode
}

You'redone!That'sallyouneedtodotobeginreceivingbasicmetricdata.

NoteOnAdvancedFeatures

FlurrystronglyrecommendsthatyoureadtheAdvancedFeaturessectionbelow.Thesefeaturesareoptionalonly
becausetheyrequireconfigurationonyourpart.ItismostoftenthecasethatusersofFlurryAnalyticsfindasmuch
ormorevalueintheAdvancedFeatureslistedbelowasinthefeaturesenabledbytheabovesteps.Examples
include:
CrashAnalyticsReviewanalyticsandstacktracesfortheerrorsandcrashesthatoccurinyourapp.
CustomEventsUnderstandtheinteractionbetweenyourusersandspecificareasoffunctionalityinthe
app.
DemographicsAnalyzeandsegmentyourusersbydemographicgroupbasedonthedatatheysharewith
yourapp.

BesuretoreadtheFlurryiOSAdvertisingREADMEaswelltolearnhowyoucanmonetizeyourappbyshowing
adstoyourusersthataretargetedusingthedatafromFlurryAnalytics.

3.AdvancedFeatures

Youcanusethefollowingmethodstoreportadditionaldata.

TrackingUserBehavior

UtilizingCustomEventsinyourapp,youcantracktheoccurrenceandstateofmostactionstakenbyusersoreven
yourappitself.CustomEventssupportfunctionalitywithinFlurryAnalyticssuchasFunnels,Segments,UserPaths
andothers.TogainabetterunderstandingofthevalueofCustomEvents,seethevideowalkthroughavailablehere.

[FlurrylogEvent:@"EVENT_NAME"]
UselogEventtocountthenumberoftimescertaineventshappenduringasessionofyourapplication.Thiscanbe
usefulformeasuringhowoftenusersperformvariousactions,forexample.Yourapplicationiscurrentlylimitedto
countingoccurrencesfor300differenteventids(maximumlength255characters)acrossallitssessions.When
decidingoneventstotrackconsideraddingdynamicparameterstocapturevariousincarnationsofanevent(rather
thancreatingmultipledynamicevents)

[FlurrylogEvent:@"EVENT_NAME"withParameters:YOUR_NSDictionary]
UsethisversionoflogEventtocountthenumberoftimescertaineventshappenduringasessionofyourapplication
andtopassdynamicparameterstoberecordedwiththatevent.Eventparameterscanbepassedinasa
NSDictionaryobject(immutablecopy)wherethekeyandvalueobjectsmustbeNSStringobjects.Forexample,you
couldrecordthatauserusedyoursearchboxtoolandalsodynamicallyrecordwhichsearchtermstheuser
entered.Yourapplicationiscurrentlylimitedtocountingoccurrencesfor100differenteventids(maximumlength
255characters)duringoneapplicationsession.Maximumof10eventparameterspereventissupported.Thereis
limitof1000eventsintotalforasession(forinstance,youcanhave100differenteventidseachoccurringupto10
timesduringtheapplicationsession).

AnexampleNSDictionarytousewiththismethodcouldbe:
NSDictionary*dictionary=
[NSDictionarydictionaryWithObjectsAndKeys:@"yourdynamicparametervalue",
@"yourdynamicparametername",
nil]

[FlurrylogEvent:@"EVENT_NAME"timed:YES]
UsethisversionoflogEventtostarttimedevent.

[FlurrylogEvent:@"EVENT_NAME"withParameters:YOUR_NSDictionarytimed:YES]
UsethisversionoflogEventtostarttimedeventwitheventparameters.

[FlurryendTimedEvent:@"EVENT_NAME"withParameters:YOUR_NSDictionary]
UseendTimedEventtoendtimedeventbeforeappexits,otherwisetimedeventsautomaticallyendwhenappexits.
Whenendingthetimedevent,aneweventparametersNSDictionaryobjectcanbeusedtoupdateeventparameters.
Tokeepeventparametersthesame,passinnilfortheeventparametersNSDictionaryobject.

[FlurrylogAllPageViewsForTarget:navigationController]
ToenableFlurryagenttoautomaticallydetectandlogpageview,passinaninstanceofUINavigationControlleror
UITabBarControllertocountPageViews.Flurryagentwillcreateadelegateonyourobjecttodetectuser
interactions.Eachdetecteduserinteractionwillautomaticallybeloggedasapageview.Eachinstanceneedsto
onlybepassedtoFlurryagentonce.MultipleUINavigationControllerorUITabBarControllerinstancescanbepassed
toFlurryagent.ThismethodalongwiththecorrespondingstopLogPageViewsForTargetreplacesthedeprecated
logAllPageViewsroutine.

[FlurrystopLogPageViewsForTarget:navigationController]
StopsloggingpageviewsonanavigationcontrollerthatwaspreviouslyobservedwithlogAllPageViewsForTarget.
CallthismethodbeforetheinstanceofthenavigationcontrollerobservedwithlogAllPageViewsForTargetisreleased.

[FlurrylogPageView]
IntheabsenceofUINavigationControllerandUITabBarController,youcanmanuallydetectuserinteractions.For
eachuserinteractionyouwanttomanuallylog,youcanuselogPageViewtologthepageview.

TrackingApplicationErrors
[FlurrylogError:@"ERROR_NAME"message:@"ERROR_MESSAGE"exception:e]
Usethistologexceptionsand/orerrorsthatoccurinyourapp.Flurrywillreportthefirst10errorsthatoccurineach
session.Themessageparameterhasbeendeprecatedasofrelease4.2.2andthepassedinmessagewillnotbe
viewableontheFlurrydeveloperportal.

Forthefollowingfeatures,pleasecalltheseAPIsbeforecalling[Flurry
startSession:@"YOUR_API_KEY"]:

TrackingDemographics
[FlurrysetUserID:@"USER_ID"]
Usethistologtheuser'sassignedIDorusernameinyoursystemafteridentifyingtheuser.

[FlurrysetAge:21]
Usethistologtheuser'sageafteridentifyingtheuser.Validinputsare0orgreater.

[FlurrysetGender:@"m"]
Usethistologtheuser'sgenderafteridentifyingtheuser.Validinputsarem(male)orf(female)

TrackingLocation
CLLocationManager*locationManager=[[CLLocationManageralloc]init]
[locationManagerstartUpdatingLocation]

CLLocation*location=locationManager.location
[FlurrysetLatitude:location.coordinate.latitude
longitude:location.coordinate.longitude
horizontalAccuracy:location.horizontalAccuracy
verticalAccuracy:location.verticalAccuracy]

ThisallowsyoutosetthecurrentGPSlocationoftheuser.Flurrywillkeeponlythelastlocationinformation.Ifyour
appdoesnotuselocationservicesinameaningfulway,usingCLLocationManagercanresultinApplerejectingthe
appsubmission.

ControllingDataReporting
[FlurrysetSessionReportsOnCloseEnabled:(BOOL)sendSessionReportsOnClose]
Thisoptionisenabledbydefault.Whenenabled,Flurrywillattempttosendsessiondatawhentheappisexitedas
wellasitnormallydoeswhentheappisstarted.Thiswillimprovethespeedatwhichyourapplicationanalyticsare
updatedbutcanprolongtheappterminationprocessduetonetworklatency.

[FlurrysetSessionReportsOnPauseEnabled:(BOOL)sendSessionReportsOnPause]
Thisoptionisenabledbydefault.Whenenabled,Flurrywillattempttosendsessiondatawhentheappispausedas
wellasitnormallydoeswhentheappisstarted.Thiswillimprovethespeedatwhichyourapplicationanalyticsare
updatedbutcanprolongtheapppauseprocessduetonetworklatency.

[FlurrysetSecureTransportEnabled:(BOOL)secureTransport]
Thisoptionisdisabledbydefault.Whenenabled,FlurrywillsendsessiondataoverSSLwhentheappispausedas
wellasitnormallydoeswhentheappisstarted.Thishasthepotentialtoprolongtheapppauseprocessdueto
addednetworklatencyfromsecurehandshakingandencryption.

[FlurrysetBackgroundSessionEnabled:(BOOL)backgroundSessionEnabled]
Thisoptionisdisabledbydefault.Whenenabled,Flurrywillnotfinishthesessioniftheappispausedforlonger
thanthesessionexpirationtimeout.Thesessionreportwillnotbesentwhentheapplicationispausedandwillonly
besentwhentheapplicationisterminated.Thisallowsforapplicationsthatruninthebackgroundtokeepcollecting
eventsdata.Thetimeapplicationspendsinthebackgroundcontributestothelengthoftheapplicationsession
reportedwhentheapplicationterminates.

[FlurrypauseBackgroundSession]
ThismethodisusefulifsetBackgroundSessionEnabled:issettoYES.Itcanbecalledwhenapplication
finishesallbackgroundtasks(suchasplayingmusic)topausethesession.Asessionreportissentif
setSessionReportsOnPauseEnabledissettoYES.Iftheappisresumedbeforethesessionexpiration
timeout,thesessionwillcontinue,otherwiseanewsessionwillbegin.

CrashReporting
[FlurrysetCrashReportingEnabled:(BOOL)crashReportingEnabled]

Pleasenote:Thiscallmustbemadepriorthecall[FlurrystartSession:@"YOUR_API_KEY"].

Thisoptionisoffbydefault.FlurryhasdisabledtheCrashReportingfunctionalitytoensurethatFlurryCrash
Analyticsfeaturedoesnotaffecttheuseofothercrashreportingtoolsthatmightbeinusebytheapplication.When
enabled,Flurrywillcollectcrashreportsandsenditinthesessiondata.TheerrorsthatareloggedusingtheFlurry
librarywillincludestacktracesthatarecapturedatthepointwhentheerrorislogged.Notethatwhenthisfeatureis
enabledFlurryinstallsanuncaughtexceptionhandlerandregistersforsignals.Westronglyrecommendthat
developersdonotinstallanyuncaughtexceptionhandlersintheirappiftheyenablethisfeature.Moreinformation
aboutthefeatureisavailablehere.
Crashreportingisonlysupportedonarmv7,armv7sandarmv8architectures.Ifanapplicationisbuiltusingmultiple
architectureslicesthencrashreportingwillworkonarmv7&abovedevicesbutwillbedisabledonarmv6devices.

DebugandDiagnostics
[FlurrysetLogLevel:(BOOL)logLevel]
ThisisanoptionalmethodthatcanbeusedtosetthelevelofFlurrySDKlogstobedisplayedontheconsole.The
defaultloglevelisFlurryLogLevelCriticalOnly.

[FlurrysetDebugLogEnabled:(BOOL)debugLogEnabled]
Thisoptionisoffbydefault.WhendisabledtheloglevelissettoFlurryLogLevelCriticalOnly.Whenenabledthelog
levelissettoFlurryLogLevelDebug.ThisroutineinvokessetLogLevel.

[FlurrygetFlurryAgentVersion]
ThisroutineretrievesastringthatcontainstheFlurrySDKagentversionnumberandreleaseversionandisuseful
informationthatthedeveloperscanuseforinvestigations.

[FlurryaddOrigin:(NSString*)withVersion:(NSString*)]
Thisoptionalmethodisusedby3rdpartyproductsthatwrapFlurrySDK.Thismethodallowsdeclarationofthe
FlurrySDKwrapperastheoriginoftheFlurrysessions.Asageneralruleyoushouldcapturealltheorigininfo
relatedtoyourwrapperforFlurrySDKaftereverysessionstart.

[FlurryaddOrigin:(NSString*)withVersion:(NSString*)withParameters:(NSDictionary
*)]
Thisoptionalmethodisusedby3rdpartyproductsthatwrapFlurrySDK.Thismethodallowsdeclarationofthe
FlurrySDKwrapperastheoriginoftheFlurrysessions.Asageneralruleyoushouldcapturealltheorigininfo
relatedtoyourwrapperforFlurrySDKaftereverysessionstart.

5.FAQ

HowmuchdoestheFlurryAnalyticsSDKaddtomyappsize?

TheFlurrySDKwilltypicallyadd150KBtothefinalappsize.

WhendoestheFlurryAgentsenddata?

Bydefault,theFlurryAgentwillsendthestoredmetricsdatatoFlurryserverswhentheappstarts,pauses,
resumes,andterminates.TooverridedefaultAgentbehavior,youcanturnoffsendingdataonterminationbyadding
thefollowingcallbeforeyoucallstartSession:
[FlurrysetSessionReportsOnCloseEnabled:NO]

YoucanturnoffsendingdataonpausebyaddingthefollowingcallbeforeyoucallstartSession:
[FlurrysetSessionReportsOnPauseEnabled:NO]

HowmuchdatadoestheAgentsendeachsession?

AlldatasentbytheFlurryAgentissentinacompactbinaryformat.Thetotalamountofdatacanvarybutinmost
casesitisaround2Kbpersession.

WhatdatadoestheAgentsend?

ThedatasentbytheFlurryAgentincludestimestamps,loggedevents,loggederrors,andvariousdevicespecific
information.ThisisthesameinformationthatcanbeseeninthecustomeventlogsonintheEventAnalytics
section.Wedonotcollectpersonallyidentifiableinformation.

DoestheAgentsupportiOSOS3.x?

Yes,thisversionisafatbinarythatincludesslicesforarmv6,armv7,armv7sandi386.SupportisprovidedforiOS
3.1toiOS6.

WhatversionofXCodeisrequired?

TheFlurrySDKwillsupportXcode4.0andabove.Pleaseemailsupportifyouneedtouseolderversionsofthe
FlurrySDK.

DoesthisversioncollecttheiOSUDID?

ThisversionoftheFlurryiOSSDKdoesnotcollecttheiOSUDID.

Pleaseletusknowifyouhaveanyquestions.Ifyouneedanyhelp,justemailiphonesupport@flurry.com!

Cheers,
TheFlurryTeam
http://www.flurry.com
iphonesupport@flurry.com