com.github.segmentio

Class AnalyticsClient

java.lang.Object

com.github.segmentio.AnalyticsClient

public class AnalyticsClient
extends Object

The Segment.io Client - Instantiate this to use the Segment.io API. The client is an HTTP wrapper over the Segment.io REST API. It will allow you to conveniently consume the API without making any HTTP requests yourself. This client is also designed to be thread-safe and to not block each of your calls to make a HTTP request. It uses batching to efficiently send your requests on a separate resource-constrained thread pool.

Constructor Summary

Constructors

Constructor and Description
AnalyticsClient(String writeKey) Creates a new Segment.io client.
AnalyticsClient(String writeKey, Options options) Creates a new Segment.io client.

Method Summary

Methods

Modifier and Type	Method and Description
void	alias(String from, String to) Aliases an anonymous user into an identified user.
void	alias(String from, String to, Context context) Aliases an anonymous user into an identified user.
void	alias(String from, String to, org.joda.time.DateTime timestamp) Aliases an anonymous user into an identified user.
void	alias(String from, String to, org.joda.time.DateTime timestamp, Context context) Aliases an anonymous user into an identified user.
void	alias(String from, String to, org.joda.time.DateTime timestamp, Context context, Callback callback) Aliases an anonymous user into an identified user.
void	close() Closes the queue and the threads associated with flushing the queue
void	flush() Blocks until all messages in the queue are flushed.
Options	getOptions()
AnalyticsStatistics	getStatistics()
String	getWriteKey()
void	identify(String userId, Traits traits) Identifying a user ties all of their actions to an id, and associates user traits to that id.
void	identify(String userId, Traits traits, Context context) Identifying a user ties all of their actions to an id, and associates user traits to that id.
void	identify(String userId, Traits traits, org.joda.time.DateTime timestamp, Context context) Identifying a user ties all of their actions to an id, and associates user traits to that id.
void	identify(String userId, Traits traits, org.joda.time.DateTime timestamp, Context context, Callback callback) Identifying a user ties all of their actions to an id, and associates user traits to that id.
void	setWriteKey(String writeKey)
void	track(String userId, String event) Whenever a user triggers an event, you’ll want to track it.
void	track(String userId, String event, EventProperties properties) Whenever a user triggers an event, you’ll want to track it.
void	track(String userId, String event, EventProperties properties, org.joda.time.DateTime timestamp) Whenever a user triggers an event, you’ll want to track it.
void	track(String userId, String event, EventProperties properties, org.joda.time.DateTime timestamp, Context context) Whenever a user triggers an event, you’ll want to track it.
void	track(String userId, String event, EventProperties properties, org.joda.time.DateTime timestamp, Context context, Callback callback) Whenever a user triggers an event, you’ll want to track it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalyticsClient

public AnalyticsClient(String writeKey)

Creates a new Segment.io client. The client is an HTTP wrapper over the Segment.io REST API. It will allow you to conveniently consume the API without making any HTTP requests yourself. This client is also designed to be thread-safe and to not block each of your calls to make a HTTP request. It uses batching to efficiently send your requests on a separate resource-constrained thread pool.

Parameters:

writeKey - Your segment.io writeKey. You can get one of these by registering for a project at https://segment.io

AnalyticsClient

public AnalyticsClient(String writeKey,
               Options options)

Creates a new Segment.io client. The client is an HTTP wrapper over the Segment.io REST API. It will allow you to conveniently consume the API without making any HTTP requests yourself. This client is also designed to be thread-safe and to not block each of your calls to make a HTTP request. It uses batching to efficiently send your requests on a separate resource-constrained thread pool.

Parameters:

writeKey - Your segment.io writeKey. You can get one of these by registering for a project at https://segment.io

options - Options to configure the behavior of the Segment.io client

Method Detail

identify

public void identify(String userId,
            Traits traits)

Identifying a user ties all of their actions to an id, and associates user traits to that id.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

traits - a dictionary with keys like email, name, subscriptionPlan or age. You only need to record a trait once, no need to send it again.

identify

public void identify(String userId,
            Traits traits,
            Context context)

Identifying a user ties all of their actions to an id, and associates user traits to that id.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

traits - a dictionary with keys like subscriptionPlan or age. You only need to record a trait once, no need to send it again.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

identify

public void identify(String userId,
            Traits traits,
            org.joda.time.DateTime timestamp,
            Context context)

Identifying a user ties all of their actions to an id, and associates user traits to that id.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

traits - a dictionary with keys like subscriptionPlan or age. You only need to record a trait once, no need to send it again.

timestamp - a DateTime representing when the identify took place. If the identify just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

identify

public void identify(String userId,
            Traits traits,
            org.joda.time.DateTime timestamp,
            Context context,
            Callback callback)

Identifying a user ties all of their actions to an id, and associates user traits to that id.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

traits - a dictionary with keys like subscriptionPlan or age. You only need to record a trait once, no need to send it again.

timestamp - a DateTime representing when the identify took place. If the identify just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

callback - a callback that is fired when this track's batch is flushed to the server. Note: this callback is fired on the same thread as the async event loop that made the request. You should not perform any kind of long running operation on it.

track

public void track(String userId,
         String event)

Whenever a user triggers an event, you’ll want to track it.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

event - describes what this user just did. It's a human readable description like "Played a Song", "Printed a Report" or "Updated Status".

track

public void track(String userId,
         String event,
         EventProperties properties)

Whenever a user triggers an event, you’ll want to track it.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

event - describes what this user just did. It's a human readable description like "Played a Song", "Printed a Report" or "Updated Status".

properties - a dictionary with items that describe the event in more detail. This argument is optional, but highly recommended—you’ll find these properties extremely useful later.

track

public void track(String userId,
         String event,
         EventProperties properties,
         org.joda.time.DateTime timestamp)

Whenever a user triggers an event, you’ll want to track it.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

event - describes what this user just did. It's a human readable description like "Played a Song", "Printed a Report" or "Updated Status".

properties - a dictionary with items that describe the event in more detail. This argument is optional, but highly recommended—you’ll find these properties extremely useful later.

timestamp - a DateTime object representing when the track took place. If the event just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

track

public void track(String userId,
         String event,
         EventProperties properties,
         org.joda.time.DateTime timestamp,
         Context context)

Whenever a user triggers an event, you’ll want to track it.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

event - describes what this user just did. It's a human readable description like "Played a Song", "Printed a Report" or "Updated Status".

properties - a dictionary with items that describe the event in more detail. This argument is optional, but highly recommended—you’ll find these properties extremely useful later.

timestamp - a DateTime object representing when the track took place. If the event just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

track

public void track(String userId,
         String event,
         EventProperties properties,
         org.joda.time.DateTime timestamp,
         Context context,
         Callback callback)

Whenever a user triggers an event, you’ll want to track it.

Parameters:

userId - the user's id after they are logged in. It's the same id as which you would recognize a signed-in user in your system.

event - describes what this user just did. It's a human readable description like "Played a Song", "Printed a Report" or "Updated Status".

properties - a dictionary with items that describe the event in more detail. This argument is optional, but highly recommended—you’ll find these properties extremely useful later.

timestamp - a DateTime object representing when the track took place. If the event just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

callback - a callback that is fired when this track's batch is flushed to the server. Note: this callback is fired on the same thread as the async event loop that made the request. You should not perform any kind of long running operation on it.

alias

public void alias(String from,
         String to)

Aliases an anonymous user into an identified user.

Parameters:

from - the anonymous user's id before they are logged in.

to - the identified user's id after they're logged in.

alias

public void alias(String from,
         String to,
         org.joda.time.DateTime timestamp)

Aliases an anonymous user into an identified user.

Parameters:

from - the anonymous user's id before they are logged in.

to - the identified user's id after they're logged in.

timestamp - a DateTime object representing when the track took place. If the event just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

alias

public void alias(String from,
         String to,
         Context context)

Aliases an anonymous user into an identified user.

Parameters:

from - the anonymous user's id before they are logged in.

to - the identified user's id after they're logged in.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

alias

public void alias(String from,
         String to,
         org.joda.time.DateTime timestamp,
         Context context)

Aliases an anonymous user into an identified user.

Parameters:

from - the anonymous user's id before they are logged in.

to - the identified user's id after they're logged in.

timestamp - a DateTime object representing when the track took place. If the event just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

alias

public void alias(String from,
         String to,
         org.joda.time.DateTime timestamp,
         Context context,
         Callback callback)

Aliases an anonymous user into an identified user.

Parameters:

from - the anonymous user's id before they are logged in.

to - the identified user's id after they're logged in.

timestamp - a DateTime object representing when the track took place. If the event just happened, leave it blank and we'll use the server's time. If you are importing data from the past, make sure you provide this argument.

context - an object that describes anything that doesn't fit into this event's properties (such as the user's IP)

callback - a callback that is fired when this track's batch is flushed to the server. Note: this callback is fired on the same thread as the async event loop that made the request. You should not perform any kind of long running operation on it.

flush

public void flush()

Blocks until all messages in the queue are flushed.

close

public void close()

Closes the queue and the threads associated with flushing the queue

getWriteKey

public String getWriteKey()

setWriteKey

public void setWriteKey(String writeKey)

getOptions

public Options getOptions()

getStatistics

public AnalyticsStatistics getStatistics()