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, Config config) Creates a new Segment.io client.

Method Summary

Modifier and Type	Method and Description
void	alias(String previousId, String userId) Aliases an anonymous user into an identified user.
void	alias(String previousId, String userId, Options options) 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.
Config	getOptions()
int	getQueueDepth()
AnalyticsStatistics	getStatistics()
String	getWriteKey()
void	group(String userId, String groupId, Traits traits) The `group` method lets you associate a user with a group.
void	group(String userId, String groupId, Traits traits, Options options) The `group` method lets you associate a user with a group.
void	identify(String userId) Identifying a user ties all of their actions to an id, and associates user traits to that id.
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, Options options) Identifying a user ties all of their actions to an id, and associates user traits to that id.
void	page(String userId, String name) The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.
void	page(String userId, String name, Props properties) The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.
void	page(String userId, String name, Props properties, Options options) The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.
void	page(String userId, String name, String category, Props properties, Options options) The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.
void	screen(String userId, String name) The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.
void	screen(String userId, String name, Props properties) The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.
void	screen(String userId, String name, Props properties, Options options) The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.
void	screen(String userId, String name, String category, Props properties, Options options) The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.
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, Props properties) Whenever a user triggers an event, you’ll want to track it.
void	track(String userId, String event, Props properties, Options options) 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,
                       Config config)

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

config - Configure the behavior of this Segment.io client

Method Detail

identify

public void identify(String userId)

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.

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 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,
                     Options options)

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.

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

group

public void group(String userId,
                  String groupId,
                  Traits traits)

The `group` method lets you associate a user with a group. Be it a company, organization, account, project or team! It also lets you record custom traits about the group, like industry or number of employees.

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.

groupId - the group's id as it would appear in your database.

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

group

public void group(String userId,
                  String groupId,
                  Traits traits,
                  Options options)

The `group` method lets you associate a user with a group. Be it a company, organization, account, project or team! It also lets you record custom traits about the group, like industry or number of employees.

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.

groupId - the group's id as it would appear in your database.

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

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

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,
                  Props 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,
                  Props properties,
                  Options options)

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.

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

page

public void page(String userId,
                 String name)

The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the web page, like "Signup", "Login"

page

public void page(String userId,
                 String name,
                 Props properties)

The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the web page, like "Signup", "Login"

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.

page

public void page(String userId,
                 String name,
                 Props properties,
                 Options options)

The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the web page, like "Signup", "Login"

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.

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

page

public void page(String userId,
                 String name,
                 String category,
                 Props properties,
                 Options options)

The `page` method let your record whenever a user sees a web page on your web site, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the web page, like "Signup", "Login"

category - The category of the web page, like "Sports" or "Authentication"

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.

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

screen

public void screen(String userId,
                   String name)

The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the mobile screen, like "Signup", "Login"

screen

public void screen(String userId,
                   String name,
                   Props properties)

The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the mobile screen, like "Signup", "Login"

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.

screen

public void screen(String userId,
                   String name,
                   Props properties,
                   Options options)

The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the mobile screen, like "Signup", "Login"

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.

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

screen

public void screen(String userId,
                   String name,
                   String category,
                   Props properties,
                   Options options)

The `screen` method let your record whenever a user sees a mobile screen, and attach a `name`, `category` or `properties` to the web page load.

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.

name - The name of the mobile screen, like "Signup", "Login"

category - The category of the web page, like "Sports" or "Authentication"

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.

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

alias

public void alias(String previousId,
                  String userId)

Aliases an anonymous user into an identified user.

Parameters:

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

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

alias

public void alias(String previousId,
                  String userId,
                  Options options)

Aliases an anonymous user into an identified user.

Parameters:

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

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

options - options allows you to set a timestamp, an anonymousId, a context, and target integrations.

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 Config getOptions()

getStatistics

public AnalyticsStatistics getStatistics()

getQueueDepth

public int getQueueDepth()