Index (Matomo Java Tracker Core 3.0.1 API)

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AcceptLanguage - Class in org.matomo.java.tracking.parameters: Describes the content for the Accept-Language header field that can be overridden by a custom parameter.
AcceptLanguage.AcceptLanguageBuilder - Class in org.matomo.java.tracking.parameters
actionName(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The title of the action being tracked.
actionUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The full URL for the current action.
add(int, EcommerceItem) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
add(CustomVariable) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Adds a custom variable to the list with the next available index.
add(CustomVariable, int) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Adds a custom variable to the list with the given index.
add(EcommerceItem) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
addAll(int, Collection<? extends EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
addAll(Collection<? extends EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
addCustomTrackingParameter(String, Object) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.MatomoRequestBuilder.additionalParameters(Map) instead.
addEcommerceItem(EcommerceItem) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use @link MatomoRequest.MatomoRequestBuilder.ecommerceItems(EcommerceItems) instead
additionalParameters(Map<String, Collection<Object>>) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Allows you to specify additional HTTP request parameters that will be sent to Matomo.
apiEndpoint(URI) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The Matomo Tracking HTTP API endpoint, for example https://your-matomo-domain.example/matomo.php
apiVersion(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Defines the API version to use (default: 1).
authToken(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: 32 character authorization key used to authenticate the API request.

B

build() - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder
build() - Method in class org.matomo.java.tracking.parameters.AcceptLanguage.AcceptLanguageBuilder
build() - Method in class org.matomo.java.tracking.parameters.DeviceResolution.DeviceResolutionBuilder
build() - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
build() - Method in class org.matomo.java.tracking.parameters.EcommerceItems.EcommerceItemsBuilder
build() - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder
builder() - Static method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.request() instead.
builder() - Static method in class org.matomo.java.tracking.parameters.AcceptLanguage
builder() - Static method in class org.matomo.java.tracking.parameters.DeviceResolution
builder() - Static method in class org.matomo.java.tracking.parameters.EcommerceItem
builder() - Static method in class org.matomo.java.tracking.parameters.EcommerceItems
builder() - Static method in class org.matomo.java.tracking.TrackerConfiguration

C

campaignKeyword(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The campaign keyword (see Tracking Campaigns).
campaignName(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The campaign name.
canEqual(Object) - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
canEqual(Object) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.
canEqual(Object) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
category(String) - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
characterSet(Charset) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The charset of the page being tracked.
clear() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
clearCustomTrackingParameter() - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Please use MatomoRequest.MatomoRequestBuilder.additionalParameters(Map) instead so that you can manage the map yourself.
clearEcommerceItems() - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use @link MatomoRequest.MatomoRequestBuilder.ecommerceItems(EcommerceItems) instead
clearItems() - Method in class org.matomo.java.tracking.parameters.EcommerceItems.EcommerceItemsBuilder
clearLanguageRanges() - Method in class org.matomo.java.tracking.parameters.AcceptLanguage.AcceptLanguageBuilder
connectTimeout(Duration) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The timeout until a connection is established.
contains(Object) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
containsAll(Collection<?>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
contentInteraction(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The name of the interaction with the content.
contentName(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The name of the content.
contentPiece(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The actual content piece.
contentTarget(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The target of the content.
cookies(Map<String, String>) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Appends additional cookies to the request.
Country - Class in org.matomo.java.tracking.parameters: A two-letter country code representing a country.
Country(Locale) - Constructor for class org.matomo.java.tracking.parameters.Country: Deprecated.
crashCategory(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Category of a crash to group crashes by.
crashColumn(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The column within the line where the crash occurred.
crashLine(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The line number of the crash source, where the crash occurred.
crashLocation(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The originating source of the crash.
crashMessage(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Contains an error message describing the error that occurred during the last tracking request.
crashStackTrace(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: A stack trace of the exception that occurred during the last tracking request.
crashType(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The type of exception that occurred during the last tracking request.
createSender(TrackerConfiguration, QueryCreator) - Method in interface org.matomo.java.tracking.SenderFactory
currentHour(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The current hour (local time).
currentMinute(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The current minute (local time).
currentSecond(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The current second (local time).
customAction(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: can be optionally sent along any tracking request that isn't a page view.
customTrackingParameters(Map<String, Object>) - Method in class org.matomo.java.tracking.MatomoRequestBuilder: Deprecated.
Use MatomoRequest.MatomoRequestBuilder.additionalParameters(Map)}
CustomVariable - Class in org.matomo.java.tracking: Deprecated.
Use EcommerceItem instead.
CustomVariable - Class in org.matomo.java.tracking.parameters: Deprecated.
Should not be used according to the Matomo FAQ: How do I use Custom Variables?
CustomVariable - Class in org.piwik.java.tracking: Deprecated.
Use CustomVariable instead.
CustomVariable(int, String, String) - Constructor for class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
CustomVariable(String, String) - Constructor for class org.matomo.java.tracking.CustomVariable: Deprecated.

Instantiates a new custom variable.
CustomVariable(String, String) - Constructor for class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.

Instantiates a new custom variable.
CustomVariable(String, String) - Constructor for class org.piwik.java.tracking.CustomVariable: Deprecated.
Use CustomVariable instead.
CustomVariables - Class in org.matomo.java.tracking.parameters: Deprecated.
Should not be used according to the Matomo FAQ: How do I use Custom Variables?
CustomVariables() - Constructor for class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

D

debug(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Meant to hold a random value that is generated before each request.
defaultAuthToken(String) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The authorization token (parameter token_auth) to use if not specified explicitly.
defaultSiteId(Integer) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The default ID of the website that will be used if not specified explicitly.
deviceResolution(DeviceResolution) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The resolution of the device the visitor is using.
DeviceResolution - Class in org.matomo.java.tracking.parameters: The resolution (width and height) of the user's output device (monitor / phone).
DeviceResolution(int, int) - Constructor for class org.matomo.java.tracking.parameters.DeviceResolution
DeviceResolution.DeviceResolutionBuilder - Class in org.matomo.java.tracking.parameters
dimensions(Map<Long, Object>) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Custom Dimension values for specific Custom Dimension IDs.
disableSslCertValidation(boolean) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: Disables SSL certificate validation.
disableSslHostVerification(boolean) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: Disables SSL host verification.
domCompletionTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: How long it takes for the browser to load media and execute any Javascript code listening for the DOMContentLoaded event.
domProcessingTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: How long the browser spends loading the webpage after the response was fully received until the user can start interacting with it.
downloadUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: URL of a file the user has downloaded.

E

ecommerceDiscount(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Discount offered.
ecommerceId(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: he unique string identifier for the ecommerce order (required when tracking an ecommerce order).
EcommerceItem - Class in org.matomo.java.tracking: Deprecated.
Use EcommerceItem instead.
EcommerceItem - Class in org.matomo.java.tracking.parameters: Represents an item in an ecommerce order.
EcommerceItem - Class in org.piwik.java.tracking: Deprecated.
Use EcommerceItem instead.
EcommerceItem(String, String, String, Double, Integer) - Constructor for class org.matomo.java.tracking.EcommerceItem: Deprecated.

Instantiates a new ecommerce item.
EcommerceItem(String, String, String, Double, Integer) - Constructor for class org.matomo.java.tracking.parameters.EcommerceItem
EcommerceItem(String, String, String, Double, Integer) - Constructor for class org.piwik.java.tracking.EcommerceItem: Deprecated.
Use EcommerceItem instead.
EcommerceItem.EcommerceItemBuilder - Class in org.matomo.java.tracking.parameters
ecommerceItems(EcommerceItems) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Items in the Ecommerce order.
EcommerceItems - Class in org.matomo.java.tracking.parameters: Multiple things that you can buy online.
EcommerceItems() - Constructor for class org.matomo.java.tracking.parameters.EcommerceItems
EcommerceItems(List<EcommerceItem>) - Constructor for class org.matomo.java.tracking.parameters.EcommerceItems
EcommerceItems.EcommerceItemsBuilder - Class in org.matomo.java.tracking.parameters
ecommerceLastOrderTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The UNIX timestamp of this customer's last ecommerce order.
ecommerceRevenue(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The grand total for the ecommerce order (required when tracking an ecommerce order).
ecommerceShippingCost(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Shipping cost of the order.
ecommerceSubtotal(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The subtotal of the order; excludes shipping.
ecommerceTax(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Tax amount of the order.
enabled(boolean) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: Allows to stop the tracker to send requests to the Matomo endpoint.
enableEcommerce() - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Please use MatomoRequest.setGoalId(Integer) instead
equals(Object) - Method in class org.matomo.java.tracking.parameters.AcceptLanguage
equals(Object) - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
equals(Object) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.
equals(Object) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
equals(Object) - Method in class org.matomo.java.tracking.TrackerConfiguration
eventAction(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An event action like Play, Pause, Duration, Add Playlist, Downloaded, Clicked...
eventCategory(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: eg.
eventName(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The event name for example a Movie name, or Song name, or File name...
eventValue(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Some numeric value that represents the event value.

F

forEach(Consumer<? super EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
fromCode(String) - Static method in class org.matomo.java.tracking.parameters.Country: Creates a country from a given code.
fromHash(long) - Static method in class org.matomo.java.tracking.parameters.VisitorId: Creates always the same visitor id for the given input.
fromHeader(String) - Static method in class org.matomo.java.tracking.parameters.AcceptLanguage: Creates the Accept-Language definition for a given header.
fromHex(String) - Static method in class org.matomo.java.tracking.parameters.VisitorId: Creates a visitor id from a hexadecimal string.
fromLanguageRanges(String) - Static method in class org.matomo.java.tracking.parameters.Country: Extracts the country from the given accept language header.
fromString(String) - Static method in class org.matomo.java.tracking.parameters.DeviceResolution: Creates a device resolution from a string representation.
fromString(String) - Static method in class org.matomo.java.tracking.parameters.RandomValue: Static factory to generate a random value from a given string.
fromString(String) - Static method in class org.matomo.java.tracking.parameters.VisitorId: Creates a visitor id from a string.
fromUUID(UUID) - Static method in class org.matomo.java.tracking.parameters.VisitorId: Creates a visitor id from a UUID.
fromValue(long) - Static method in class org.matomo.java.tracking.parameters.UniqueId: Creates a unique id from a number.

G

get(int) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Returns the custom variable at the given index.
get(int) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
get(String) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Returns the value of the custom variable with the given key.
getActionName() - Method in class org.matomo.java.tracking.MatomoRequest: The title of the action being tracked.
getActionUrl() - Method in class org.matomo.java.tracking.MatomoRequest: The full URL for the current action.
getAdditionalParameters() - Method in class org.matomo.java.tracking.MatomoRequest: Allows you to specify additional HTTP request parameters that will be sent to Matomo.
getApiEndpoint() - Method in class org.matomo.java.tracking.TrackerConfiguration: The Matomo Tracking HTTP API endpoint, for example https://your-matomo-domain.example/matomo.php
getApiVersion() - Method in class org.matomo.java.tracking.MatomoRequest: Defines the API version to use (default: 1).
getAuthToken() - Method in class org.matomo.java.tracking.MatomoRequest: 32 character authorization key used to authenticate the API request.
getCampaignKeyword() - Method in class org.matomo.java.tracking.MatomoRequest: The campaign keyword (see Tracking Campaigns).
getCampaignName() - Method in class org.matomo.java.tracking.MatomoRequest: The campaign name.
getCategory() - Method in class org.matomo.java.tracking.parameters.EcommerceItem
getCharacterSet() - Method in class org.matomo.java.tracking.MatomoRequest: The charset of the page being tracked.
getConnectTimeout() - Method in class org.matomo.java.tracking.TrackerConfiguration: The timeout until a connection is established.
getContentInteraction() - Method in class org.matomo.java.tracking.MatomoRequest: The name of the interaction with the content.
getContentName() - Method in class org.matomo.java.tracking.MatomoRequest: The name of the content.
getContentPiece() - Method in class org.matomo.java.tracking.MatomoRequest: The actual content piece.
getContentTarget() - Method in class org.matomo.java.tracking.MatomoRequest: The target of the content.
getCookies() - Method in class org.matomo.java.tracking.MatomoRequest: Appends additional cookies to the request.
getCrashCategory() - Method in class org.matomo.java.tracking.MatomoRequest: Category of a crash to group crashes by.
getCrashColumn() - Method in class org.matomo.java.tracking.MatomoRequest: The column within the line where the crash occurred.
getCrashLine() - Method in class org.matomo.java.tracking.MatomoRequest: The line number of the crash source, where the crash occurred.
getCrashLocation() - Method in class org.matomo.java.tracking.MatomoRequest: The originating source of the crash.
getCrashMessage() - Method in class org.matomo.java.tracking.MatomoRequest: Contains an error message describing the error that occurred during the last tracking request.
getCrashStackTrace() - Method in class org.matomo.java.tracking.MatomoRequest: A stack trace of the exception that occurred during the last tracking request.
getCrashType() - Method in class org.matomo.java.tracking.MatomoRequest: The type of exception that occurred during the last tracking request.
getCurrentHour() - Method in class org.matomo.java.tracking.MatomoRequest: The current hour (local time).
getCurrentMinute() - Method in class org.matomo.java.tracking.MatomoRequest: The current minute (local time).
getCurrentSecond() - Method in class org.matomo.java.tracking.MatomoRequest: The current second (local time).
getCustomAction() - Method in class org.matomo.java.tracking.MatomoRequest: can be optionally sent along any tracking request that isn't a page view.
getCustomTrackingParameter(String) - Method in class org.matomo.java.tracking.MatomoRequest: Gets the list of objects currently stored at the specified custom tracking parameter.
getDebug() - Method in class org.matomo.java.tracking.MatomoRequest: Meant to hold a random value that is generated before each request.
getDefaultAuthToken() - Method in class org.matomo.java.tracking.TrackerConfiguration: The authorization token (parameter token_auth) to use if not specified explicitly.
getDefaultSiteId() - Method in class org.matomo.java.tracking.TrackerConfiguration: The default ID of the website that will be used if not specified explicitly.
getDeviceResolution() - Method in class org.matomo.java.tracking.MatomoRequest: The resolution of the device the visitor is using.
getDimensions() - Method in class org.matomo.java.tracking.MatomoRequest: Custom Dimension values for specific Custom Dimension IDs.
getDomCompletionTime() - Method in class org.matomo.java.tracking.MatomoRequest: How long it takes for the browser to load media and execute any Javascript code listening for the DOMContentLoaded event.
getDomProcessingTime() - Method in class org.matomo.java.tracking.MatomoRequest: How long the browser spends loading the webpage after the response was fully received until the user can start interacting with it.
getDownloadUrl() - Method in class org.matomo.java.tracking.MatomoRequest: URL of a file the user has downloaded.
getEcommerceDiscount() - Method in class org.matomo.java.tracking.MatomoRequest: Discount offered.
getEcommerceId() - Method in class org.matomo.java.tracking.MatomoRequest: he unique string identifier for the ecommerce order (required when tracking an ecommerce order).
getEcommerceItem(int) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use @link MatomoRequest.MatomoRequestBuilder.ecommerceItems(EcommerceItems) instead
getEcommerceItems() - Method in class org.matomo.java.tracking.MatomoRequest: Items in the Ecommerce order.
getEcommerceLastOrderTimestamp() - Method in class org.matomo.java.tracking.MatomoRequest: The UNIX timestamp of this customer's last ecommerce order.
getEcommerceRevenue() - Method in class org.matomo.java.tracking.MatomoRequest: The grand total for the ecommerce order (required when tracking an ecommerce order).
getEcommerceShippingCost() - Method in class org.matomo.java.tracking.MatomoRequest: Shipping cost of the order.
getEcommerceSubtotal() - Method in class org.matomo.java.tracking.MatomoRequest: The subtotal of the order; excludes shipping.
getEcommerceTax() - Method in class org.matomo.java.tracking.MatomoRequest: Tax amount of the order.
getEventAction() - Method in class org.matomo.java.tracking.MatomoRequest: An event action like Play, Pause, Duration, Add Playlist, Downloaded, Clicked...
getEventCategory() - Method in class org.matomo.java.tracking.MatomoRequest: eg.
getEventName() - Method in class org.matomo.java.tracking.MatomoRequest: The event name for example a Movie name, or Song name, or File name...
getEventValue() - Method in class org.matomo.java.tracking.MatomoRequest: Some numeric value that represents the event value.
getGoalId() - Method in class org.matomo.java.tracking.MatomoRequest: If specified, the tracking request will trigger a conversion for the goal of the website being tracked with this ID.
getHeaderAcceptLanguage() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the Accept-Language HTTP header field.
getHeaders() - Method in class org.matomo.java.tracking.MatomoRequest: You can set additional HTTP headers for the request sent to Matomo.
getHeaderUserAgent() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the User-Agent HTTP header field.
getIndex() - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
getItems() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
getKey() - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
getLanguageRanges() - Method in class org.matomo.java.tracking.parameters.AcceptLanguage
getLocale() - Method in class org.matomo.java.tracking.parameters.Country: Deprecated.
Since you instantiate this class, you can determine the language on your own using Locale.forLanguageTag(String)
getName() - Method in class org.matomo.java.tracking.parameters.EcommerceItem
getNetworkTime() - Method in class org.matomo.java.tracking.MatomoRequest: How long it took to connect to server.
getNewVisit() - Method in class org.matomo.java.tracking.MatomoRequest: will force a new visit to be created for this action.
getNewVisitor() - Method in class org.matomo.java.tracking.MatomoRequest: Tracks if the visitor is a returning visitor.
getOnloadTime() - Method in class org.matomo.java.tracking.MatomoRequest: How long it takes the browser to execute Javascript code waiting for the window.load event.
getOutlinkUrl() - Method in class org.matomo.java.tracking.MatomoRequest: An external URL the user has opened.
getPageCustomVariable(int) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.getPageCustomVariables() instead
getPageCustomVariable(String) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use the MatomoRequest.getPageCustomVariables() method instead.
getPageCustomVariables() - Method in class org.matomo.java.tracking.MatomoRequest: Custom variables are custom name-value pairs that you can assign to your visitors (or page views).
getPageViewId() - Method in class org.matomo.java.tracking.MatomoRequest: Accepts a six character unique ID that identifies which actions were performed on a specific page view.
getPing() - Method in class org.matomo.java.tracking.MatomoRequest: If set to true, the request will be a Heartbeat request which will not track any new activity (such as a new visit, new action or new goal).
getPluginDirector() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use Director plugin.
getPluginFlash() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use the Adobe Flash Plugin.
getPluginGears() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a Gears plugin.
getPluginJava() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use the Java plugin.
getPluginPDF() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a PDF plugin.
getPluginQuicktime() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use Quicktime plugin.
getPluginRealPlayer() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use Realplayer plugin.
getPluginSilverlight() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a Silverlight plugin.
getPluginWindowsMedia() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a Windows Media plugin.
getPrice() - Method in class org.matomo.java.tracking.parameters.EcommerceItem
getProxyHost() - Method in class org.matomo.java.tracking.TrackerConfiguration: The hostname or IP address of an optional HTTP proxy.
getProxyPassword() - Method in class org.matomo.java.tracking.TrackerConfiguration: The corresponding password for the basic auth proxy user.
getProxyPort() - Method in class org.matomo.java.tracking.TrackerConfiguration: The port of an HTTP proxy.
getProxyUsername() - Method in class org.matomo.java.tracking.TrackerConfiguration: If the HTTP proxy requires a username for basic authentication, it can be configured here.
getQuantity() - Method in class org.matomo.java.tracking.parameters.EcommerceItem
getQueuedTracking() - Method in class org.matomo.java.tracking.MatomoRequest: When set to false, the queued tracking handler won't be used and instead the tracking request will be executed directly.
getRandomValue() - Method in class org.matomo.java.tracking.MatomoRequest: Meant to hold a random value that is generated before each request.
getReferrerUrl() - Method in class org.matomo.java.tracking.MatomoRequest: The full HTTP Referrer URL.
getRequestDatetime() - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.getRequestTimestamp() instead
getRequestTimestamp() - Method in class org.matomo.java.tracking.MatomoRequest: Override for the datetime of the request (normally the current time is used).
getRequired() - Method in class org.matomo.java.tracking.MatomoRequest: The ID of the website we're tracking a visit/action for.
getResponseAsImage() - Method in class org.matomo.java.tracking.MatomoRequest: If set to 0 (send_image=0) Matomo will respond with an HTTP 204 response code instead of a GIF image.
getSearchCategory() - Method in class org.matomo.java.tracking.MatomoRequest: When search is specified, you can optionally specify a search category with this parameter.
getSearchQuery() - Method in class org.matomo.java.tracking.MatomoRequest: The Site Search keyword.
getSearchResultsCount() - Method in class org.matomo.java.tracking.MatomoRequest: When search is specified, we also recommend setting the search_count to the number of search results displayed on the results page.
getServerTime() - Method in class org.matomo.java.tracking.MatomoRequest: How long it took the server to generate page.
getSessionId() - Method in class org.matomo.java.tracking.MatomoRequest: The Matomo session ID sent as a cookie MATOMO_SESSID.
getSiteId() - Method in class org.matomo.java.tracking.MatomoRequest: The ID of the website we're tracking a visit/action for.
getSku() - Method in class org.matomo.java.tracking.parameters.EcommerceItem
getSocketTimeout() - Method in class org.matomo.java.tracking.TrackerConfiguration: The socket timeout (SO_TIMEOUT), which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.
getSupportsCookies() - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor's client is known to support cookies.
getThreadPoolSize() - Method in class org.matomo.java.tracking.TrackerConfiguration: The thread pool size for the async sender.
getTime() - Method in class org.matomo.java.tracking.MatomoDate: Deprecated.

Converts this datetime to the number of milliseconds from the epoch of 1970-01-01T00:00:00Z.
getTrackBotRequests() - Method in class org.matomo.java.tracking.MatomoRequest: By default, Matomo does not track bots.
getTransferTime() - Method in class org.matomo.java.tracking.MatomoRequest: How long it takes the browser to download the response from the server.
getUserAgent() - Method in class org.matomo.java.tracking.TrackerConfiguration: A custom user agent to be set.
getUserCustomVariable(String) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use the MatomoRequest.getVisitCustomVariables() method instead.
getUserId() - Method in class org.matomo.java.tracking.MatomoRequest: Defines the User ID for this request.
getValue() - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
getVisitCustomVariable(int) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.getVisitCustomVariables() instead
getVisitCustomVariables() - Method in class org.matomo.java.tracking.MatomoRequest: Custom variables are custom name-value pairs that you can assign to your visitors (or page views).
getVisitorCity() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the city.
getVisitorCountry() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the country.
getVisitorCustomId() - Method in class org.matomo.java.tracking.MatomoRequest: defines the visitor ID for this request.
getVisitorFirstVisitTimestamp() - Method in class org.matomo.java.tracking.MatomoRequest: The UNIX timestamp of this visitor's first visit.
getVisitorId() - Method in class org.matomo.java.tracking.MatomoRequest: The unique visitor ID.
getVisitorIp() - Method in class org.matomo.java.tracking.MatomoRequest: Override value for the visitor IP (both IPv4 and IPv6 notations supported).
getVisitorLatitude() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the visitor's latitude, eg 22.456.
getVisitorLongitude() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the visitor's longitude, eg 22.456.
getVisitorPreviousVisitTimestamp() - Method in class org.matomo.java.tracking.MatomoRequest: The UNIX timestamp of this visitor's previous visit.
getVisitorRegion() - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the region.
getVisitorVisitCount() - Method in class org.matomo.java.tracking.MatomoRequest: The current count of visits for this visitor.
getZonedDateTime() - Method in class org.matomo.java.tracking.MatomoDate: Deprecated.
goalId(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: If specified, the tracking request will trigger a conversion for the goal of the website being tracked with this ID.

H

hashCode() - Method in class org.matomo.java.tracking.parameters.AcceptLanguage
hashCode() - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
hashCode() - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.
hashCode() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
hashCode() - Method in class org.matomo.java.tracking.TrackerConfiguration
headerAcceptLanguage(String) - Method in class org.matomo.java.tracking.MatomoRequestBuilder: Deprecated.
Use MatomoRequest.MatomoRequestBuilder.headerAcceptLanguage(AcceptLanguage) in combination with AcceptLanguage.fromHeader(String) instead.
headerAcceptLanguage(AcceptLanguage) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the Accept-Language HTTP header field.
headers(Map<String, String>) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: You can set additional HTTP headers for the request sent to Matomo.
headerUserAgent(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the User-Agent HTTP header field.
height(int) - Method in class org.matomo.java.tracking.parameters.DeviceResolution.DeviceResolutionBuilder

I

indexOf(Object) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
InvalidUrlException - Exception in org.matomo.java.tracking: Thrown when an invalid URL is passed to the tracker.
isDisableSslCertValidation() - Method in class org.matomo.java.tracking.TrackerConfiguration: Disables SSL certificate validation.
isDisableSslHostVerification() - Method in class org.matomo.java.tracking.TrackerConfiguration: Disables SSL host verification.
isEmpty() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
isEnabled() - Method in class org.matomo.java.tracking.TrackerConfiguration: Allows to stop the tracker to send requests to the Matomo endpoint.
isLogFailedTracking() - Method in class org.matomo.java.tracking.TrackerConfiguration: Logs if the Matomo Tracking API endpoint responds with an erroneous HTTP code.
item(EcommerceItem) - Method in class org.matomo.java.tracking.parameters.EcommerceItems.EcommerceItemsBuilder
items(Collection<? extends EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems.EcommerceItemsBuilder
iterator() - Method in class org.matomo.java.tracking.parameters.EcommerceItems

L

languageRange(Locale.LanguageRange) - Method in class org.matomo.java.tracking.parameters.AcceptLanguage.AcceptLanguageBuilder
languageRanges(Collection<? extends Locale.LanguageRange>) - Method in class org.matomo.java.tracking.parameters.AcceptLanguage.AcceptLanguageBuilder
lastIndexOf(Object) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
listIterator() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
listIterator(int) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
logFailedTracking(boolean) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: Logs if the Matomo Tracking API endpoint responds with an erroneous HTTP code.

M

MatomoDate - Class in org.matomo.java.tracking: Deprecated.
Please use Instant
MatomoDate() - Constructor for class org.matomo.java.tracking.MatomoDate: Deprecated.
MatomoDate(long) - Constructor for class org.matomo.java.tracking.MatomoDate: Deprecated.
MatomoException - Exception in org.matomo.java.tracking: Thrown when an error occurs while communicating with the Matomo server or when the request is invalid.
MatomoLocale - Class in org.matomo.java.tracking: Deprecated.
Use Country instead
MatomoLocale(Locale) - Constructor for class org.matomo.java.tracking.MatomoLocale: Deprecated.
Please use Country
MatomoRequest - Class in org.matomo.java.tracking: A class that implements the Matomo Tracking HTTP API.
MatomoRequest() - Constructor for class org.matomo.java.tracking.MatomoRequest
MatomoRequest(int, String) - Constructor for class org.matomo.java.tracking.MatomoRequest: Deprecated.
Please use MatomoRequest.request()
MatomoRequest(Boolean, Integer, String, String, String, VisitorId, Boolean, String, CustomVariables, Integer, Instant, Instant, String, String, DeviceResolution, Integer, Integer, Integer, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, String, AcceptLanguage, String, VisitorId, Boolean, CustomVariables, String, String, String, String, Long, UniqueId, Integer, Double, Charset, Boolean, Long, Long, Long, Long, Long, Long, String, String, String, Double, String, String, String, String, String, EcommerceItems, Double, Double, Double, Double, Instant, String, String, Instant, Country, String, String, Double, Double, Boolean, Boolean, Boolean, Boolean, RandomValue, Boolean, String, String, String, String, String, Integer, Integer, String, Map<Long, Object>, Map<String, Collection<Object>>, Map<String, String>, Map<String, String>) - Constructor for class org.matomo.java.tracking.MatomoRequest
MatomoRequest.MatomoRequestBuilder - Class in org.matomo.java.tracking
MatomoRequestBuilder - Class in org.matomo.java.tracking: Deprecated.
Use MatomoRequest.MatomoRequestBuilder instead.
MatomoRequestBuilder() - Constructor for class org.matomo.java.tracking.MatomoRequestBuilder: Deprecated.
MatomoTracker - Class in org.matomo.java.tracking: The main class that sends MatomoRequests to a specified Matomo server.
MatomoTracker(String) - Constructor for class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please use MatomoTracker(TrackerConfiguration)
MatomoTracker(String, int) - Constructor for class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please use MatomoTracker(TrackerConfiguration)
MatomoTracker(String, String, int) - Constructor for class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please use MatomoTracker(TrackerConfiguration)
MatomoTracker(String, String, int, int) - Constructor for class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please use MatomoTracker(TrackerConfiguration)
MatomoTracker(TrackerConfiguration) - Constructor for class org.matomo.java.tracking.MatomoTracker: Creates a new Matomo Tracker instance.

N

name(String) - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
networkTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: How long it took to connect to server.
newVisit(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: will force a new visit to be created for this action.
newVisitor(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Tracks if the visitor is a returning visitor.

O

onloadTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: How long it takes the browser to execute Javascript code waiting for the window.load event.
org.matomo.java.tracking - package org.matomo.java.tracking: This package contains classes that allow you to specify a MatomoTracker with the corresponding TrackerConfiguration.
org.matomo.java.tracking.parameters - package org.matomo.java.tracking.parameters: Contains types for Matomo Tracking Parameters according to the Matomo Tracking HTTP API.
org.piwik.java.tracking - package org.piwik.java.tracking: Piwik Java Tracking API.
outlinkUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An external URL the user has opened.

P

pageCustomVariables(CustomVariables) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Custom variables are custom name-value pairs that you can assign to your visitors (or page views).
pageViewId(UniqueId) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Accepts a six character unique ID that identifies which actions were performed on a specific page view.
parallelStream() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
parse(String) - Static method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Parses a JSON representation of custom variables.
ping(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: If set to true, the request will be a Heartbeat request which will not track any new activity (such as a new visit, new action or new goal).
PiwikDate - Class in org.piwik.java.tracking: Deprecated.
Please use Instant
PiwikDate() - Constructor for class org.piwik.java.tracking.PiwikDate: Deprecated.
Use Instant instead.
PiwikDate(long) - Constructor for class org.piwik.java.tracking.PiwikDate: Deprecated.
Use Instant instead.
PiwikLocale - Class in org.piwik.java.tracking: Deprecated.
Use Country instead.
PiwikLocale(Locale) - Constructor for class org.piwik.java.tracking.PiwikLocale: Deprecated.
Use Country instead.
PiwikRequest - Class in org.piwik.java.tracking: Deprecated.
Use MatomoRequest instead.
PiwikRequest(int, URL) - Constructor for class org.piwik.java.tracking.PiwikRequest: Deprecated.
Use MatomoRequest instead.
PiwikTracker - Class in org.piwik.java.tracking: Deprecated.
Use MatomoTracker instead.
PiwikTracker(String) - Constructor for class org.piwik.java.tracking.PiwikTracker: Deprecated.
Use MatomoTracker instead.
PiwikTracker(String, int) - Constructor for class org.piwik.java.tracking.PiwikTracker: Deprecated.
Use MatomoTracker instead.
PiwikTracker(String, String, int) - Constructor for class org.piwik.java.tracking.PiwikTracker: Deprecated.
Use MatomoTracker instead.
PiwikTracker(String, String, int, int) - Constructor for class org.piwik.java.tracking.PiwikTracker: Deprecated.
Use MatomoTracker instead.
pluginDirector(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use Director plugin.
pluginFlash(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use the Adobe Flash Plugin.
pluginGears(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use a Gears plugin.
pluginJava(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use the Java plugin.
pluginPDF(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use a PDF plugin.
pluginQuicktime(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use Quicktime plugin.
pluginRealPlayer(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use Realplayer plugin.
pluginSilverlight(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use a Silverlight plugin.
pluginWindowsMedia(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor use a Windows Media plugin.
price(Double) - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
proxyHost(String) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The hostname or IP address of an optional HTTP proxy.
proxyPassword(String) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The corresponding password for the basic auth proxy user.
proxyPort(int) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The port of an HTTP proxy.
proxyUsername(String) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: If the HTTP proxy requires a username for basic authentication, it can be configured here.

Q

quantity(Integer) - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
queuedTracking(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: When set to false, the queued tracking handler won't be used and instead the tracking request will be executed directly.

R

random() - Static method in class org.matomo.java.tracking.parameters.RandomValue: Static factory to generate a random value.
random() - Static method in class org.matomo.java.tracking.parameters.UniqueId: Static factory to generate a random unique id.
random() - Static method in class org.matomo.java.tracking.parameters.VisitorId: Static factory to generate a random visitor id.
randomValue(RandomValue) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Meant to hold a random value that is generated before each request.
RandomValue - Class in org.matomo.java.tracking.parameters: A random value to avoid the tracking request being cached by the browser or a proxy.
RandomValue() - Constructor for class org.matomo.java.tracking.parameters.RandomValue
referrerUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The full HTTP Referrer URL.
remove(int) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Removes the custom variable at the given index.
remove(int) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
remove(String) - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Removes the custom variable with the given key.
remove(Object) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
removeAll(Collection<?>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
removeIf(Predicate<? super EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
replaceAll(UnaryOperator<EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
request() - Static method in class org.matomo.java.tracking.MatomoRequest
requestTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Override for the datetime of the request (normally the current time is used).
required(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The ID of the website we're tracking a visit/action for.
responseAsImage(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: If set to 0 (send_image=0) Matomo will respond with an HTTP 204 response code instead of a GIF image.
retainAll(Collection<?>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems

S

searchCategory(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: When search is specified, you can optionally specify a search category with this parameter.
searchQuery(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The Site Search keyword.
searchResultsCount(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: When search is specified, we also recommend setting the search_count to the number of search results displayed on the results page.
sendBulkRequest(Iterable<? extends MatomoRequest>) - Method in class org.matomo.java.tracking.MatomoTracker: Send multiple requests in a single HTTP POST call.
sendBulkRequest(Iterable<? extends MatomoRequest>, String) - Method in class org.matomo.java.tracking.MatomoTracker: Deprecated.
use MatomoTracker.sendBulkRequest(Iterable) instead and set the auth token in the tracker configuration or the requests directly.
sendBulkRequest(MatomoRequest...) - Method in class org.matomo.java.tracking.MatomoTracker: Send multiple requests in a single HTTP POST call.
sendBulkRequestAsync(Iterable<? extends MatomoRequest>) - Method in class org.matomo.java.tracking.MatomoTracker: Send multiple requests in a single HTTP call.
sendBulkRequestAsync(Iterable<? extends MatomoRequest>, String) - Method in class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please set the auth token in the tracker configuration or the requests directly and use MatomoTracker.sendBulkRequestAsync(Iterable) instead.
sendBulkRequestAsync(Iterable<? extends MatomoRequest>, String, Consumer<Void>) - Method in class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please set the auth token in the tracker configuration or the requests directly and use CompletableFuture.thenAccept(Consumer) instead for the callback.
sendBulkRequestAsync(Iterable<? extends MatomoRequest>, Consumer<Void>) - Method in class org.matomo.java.tracking.MatomoTracker: Send multiple requests in a single HTTP call.
sendBulkRequestAsync(MatomoRequest...) - Method in class org.matomo.java.tracking.MatomoTracker: Send multiple requests in a single HTTP call.
SenderFactory - Interface in org.matomo.java.tracking: A factory for Sender instances.
sendRequest(MatomoRequest) - Method in class org.matomo.java.tracking.MatomoTracker: Sends a tracking request to Matomo using the HTTP GET method.
sendRequestAsync(MatomoRequest) - Method in class org.matomo.java.tracking.MatomoTracker: Send a request asynchronously via HTTP GET.
sendRequestAsync(MatomoRequest, Consumer<MatomoRequest>) - Method in class org.matomo.java.tracking.MatomoTracker: Deprecated.
Please use MatomoTracker.sendRequestAsync(MatomoRequest) in combination with CompletableFuture.thenAccept(Consumer) instead
serverTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: How long it took the server to generate page.
sessionId(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The Matomo session ID sent as a cookie MATOMO_SESSID.
set(int, EcommerceItem) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
setActionName(String) - Method in class org.matomo.java.tracking.MatomoRequest: The title of the action being tracked.
setActionUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest: The full URL for the current action.
setAdditionalParameters(Map<String, Collection<Object>>) - Method in class org.matomo.java.tracking.MatomoRequest: Allows you to specify additional HTTP request parameters that will be sent to Matomo.
setApiVersion(String) - Method in class org.matomo.java.tracking.MatomoRequest: Defines the API version to use (default: 1).
setAuthToken(String) - Method in class org.matomo.java.tracking.MatomoRequest: 32 character authorization key used to authenticate the API request.
setCampaignKeyword(String) - Method in class org.matomo.java.tracking.MatomoRequest: The campaign keyword (see Tracking Campaigns).
setCampaignName(String) - Method in class org.matomo.java.tracking.MatomoRequest: The campaign name.
setCategory(String) - Method in class org.matomo.java.tracking.parameters.EcommerceItem
setCharacterSet(Charset) - Method in class org.matomo.java.tracking.MatomoRequest: The charset of the page being tracked.
setContentInteraction(String) - Method in class org.matomo.java.tracking.MatomoRequest: The name of the interaction with the content.
setContentName(String) - Method in class org.matomo.java.tracking.MatomoRequest: The name of the content.
setContentPiece(String) - Method in class org.matomo.java.tracking.MatomoRequest: The actual content piece.
setContentTarget(String) - Method in class org.matomo.java.tracking.MatomoRequest: The target of the content.
setCookies(Map<String, String>) - Method in class org.matomo.java.tracking.MatomoRequest: Appends additional cookies to the request.
setCrashCategory(String) - Method in class org.matomo.java.tracking.MatomoRequest: Category of a crash to group crashes by.
setCrashColumn(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The column within the line where the crash occurred.
setCrashLine(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The line number of the crash source, where the crash occurred.
setCrashLocation(String) - Method in class org.matomo.java.tracking.MatomoRequest: The originating source of the crash.
setCrashMessage(String) - Method in class org.matomo.java.tracking.MatomoRequest: Contains an error message describing the error that occurred during the last tracking request.
setCrashStackTrace(String) - Method in class org.matomo.java.tracking.MatomoRequest: A stack trace of the exception that occurred during the last tracking request.
setCrashType(String) - Method in class org.matomo.java.tracking.MatomoRequest: The type of exception that occurred during the last tracking request.
setCurrentHour(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The current hour (local time).
setCurrentMinute(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The current minute (local time).
setCurrentSecond(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The current second (local time).
setCustomAction(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: can be optionally sent along any tracking request that isn't a page view.
setCustomTrackingParameter(String, Object) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.MatomoRequestBuilder.additionalParameters(Map) instead.
setDebug(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Meant to hold a random value that is generated before each request.
setDeviceResolution(String) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.setDeviceResolution(DeviceResolution) instead.
setDeviceResolution(DeviceResolution) - Method in class org.matomo.java.tracking.MatomoRequest: The resolution of the device the visitor is using.
setDimensions(Map<Long, Object>) - Method in class org.matomo.java.tracking.MatomoRequest: Custom Dimension values for specific Custom Dimension IDs.
setDomCompletionTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest: How long it takes for the browser to load media and execute any Javascript code listening for the DOMContentLoaded event.
setDomProcessingTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest: How long the browser spends loading the webpage after the response was fully received until the user can start interacting with it.
setDownloadUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest: URL of a file the user has downloaded.
setEcommerceDiscount(Double) - Method in class org.matomo.java.tracking.MatomoRequest: Discount offered.
setEcommerceId(String) - Method in class org.matomo.java.tracking.MatomoRequest: he unique string identifier for the ecommerce order (required when tracking an ecommerce order).
setEcommerceItems(EcommerceItems) - Method in class org.matomo.java.tracking.MatomoRequest: Items in the Ecommerce order.
setEcommerceLastOrderTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest: The UNIX timestamp of this customer's last ecommerce order.
setEcommerceRevenue(Double) - Method in class org.matomo.java.tracking.MatomoRequest: The grand total for the ecommerce order (required when tracking an ecommerce order).
setEcommerceShippingCost(Double) - Method in class org.matomo.java.tracking.MatomoRequest: Shipping cost of the order.
setEcommerceSubtotal(Double) - Method in class org.matomo.java.tracking.MatomoRequest: The subtotal of the order; excludes shipping.
setEcommerceTax(Double) - Method in class org.matomo.java.tracking.MatomoRequest: Tax amount of the order.
setEventAction(String) - Method in class org.matomo.java.tracking.MatomoRequest: An event action like Play, Pause, Duration, Add Playlist, Downloaded, Clicked...
setEventCategory(String) - Method in class org.matomo.java.tracking.MatomoRequest: eg.
setEventName(String) - Method in class org.matomo.java.tracking.MatomoRequest: The event name for example a Movie name, or Song name, or File name...
setEventValue(Double) - Method in class org.matomo.java.tracking.MatomoRequest: Some numeric value that represents the event value.
setGoalId(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: If specified, the tracking request will trigger a conversion for the goal of the website being tracked with this ID.
setHeaderAcceptLanguage(AcceptLanguage) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the Accept-Language HTTP header field.
setHeaders(Map<String, String>) - Method in class org.matomo.java.tracking.MatomoRequest: You can set additional HTTP headers for the request sent to Matomo.
setHeaderUserAgent(String) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the User-Agent HTTP header field.
setIndex(int) - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
setItems(List<EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
setKey(String) - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
setLocale(Locale) - Method in class org.matomo.java.tracking.parameters.Country: Deprecated.
Since you instantiate this class, you can determine the language on your own using Locale.getCountry()
setName(String) - Method in class org.matomo.java.tracking.parameters.EcommerceItem
setNetworkTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest: How long it took to connect to server.
setNewVisit(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: will force a new visit to be created for this action.
setNewVisitor(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Tracks if the visitor is a returning visitor.
setOnloadTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest: How long it takes the browser to execute Javascript code waiting for the window.load event.
setOutlinkUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest: An external URL the user has opened.
setPageCustomVariable(String, String) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.getPageCustomVariables() instead
setPageCustomVariable(CustomVariable, int) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.getPageCustomVariables() instead
setPageCustomVariables(CustomVariables) - Method in class org.matomo.java.tracking.MatomoRequest: Custom variables are custom name-value pairs that you can assign to your visitors (or page views).
setPageViewId(UniqueId) - Method in class org.matomo.java.tracking.MatomoRequest: Accepts a six character unique ID that identifies which actions were performed on a specific page view.
setParameter(String, Object) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use @link MatomoRequest.MatomoRequestBuilder.additionalParameters(Map) instead
setPing(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: If set to true, the request will be a Heartbeat request which will not track any new activity (such as a new visit, new action or new goal).
setPluginDirector(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use Director plugin.
setPluginFlash(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use the Adobe Flash Plugin.
setPluginGears(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a Gears plugin.
setPluginJava(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use the Java plugin.
setPluginPDF(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a PDF plugin.
setPluginQuicktime(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use Quicktime plugin.
setPluginRealPlayer(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use Realplayer plugin.
setPluginSilverlight(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a Silverlight plugin.
setPluginWindowsMedia(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor use a Windows Media plugin.
setPrice(Double) - Method in class org.matomo.java.tracking.parameters.EcommerceItem
setQuantity(Integer) - Method in class org.matomo.java.tracking.parameters.EcommerceItem
setQueuedTracking(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: When set to false, the queued tracking handler won't be used and instead the tracking request will be executed directly.
setRandomValue(RandomValue) - Method in class org.matomo.java.tracking.MatomoRequest: Meant to hold a random value that is generated before each request.
setReferrerUrl(String) - Method in class org.matomo.java.tracking.MatomoRequest: The full HTTP Referrer URL.
setRequestDatetime(MatomoDate) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.setRequestTimestamp(Instant) instead
setRequestTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest: Override for the datetime of the request (normally the current time is used).
setRequired(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: The ID of the website we're tracking a visit/action for.
setResponseAsImage(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: If set to 0 (send_image=0) Matomo will respond with an HTTP 204 response code instead of a GIF image.
setSearchCategory(String) - Method in class org.matomo.java.tracking.MatomoRequest: When search is specified, you can optionally specify a search category with this parameter.
setSearchQuery(String) - Method in class org.matomo.java.tracking.MatomoRequest: The Site Search keyword.
setSearchResultsCount(Long) - Method in class org.matomo.java.tracking.MatomoRequest: When search is specified, we also recommend setting the search_count to the number of search results displayed on the results page.
setSenderFactory(SenderFactory) - Method in class org.matomo.java.tracking.MatomoTracker
setServerTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest: How long it took the server to generate page.
setSessionId(String) - Method in class org.matomo.java.tracking.MatomoRequest: The Matomo session ID sent as a cookie MATOMO_SESSID.
setSiteId(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The ID of the website we're tracking a visit/action for.
setSku(String) - Method in class org.matomo.java.tracking.parameters.EcommerceItem
setSupportsCookies(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: Does the visitor's client is known to support cookies.
setTimeZone(ZoneId) - Method in class org.matomo.java.tracking.MatomoDate: Deprecated.

Sets the time zone of the String that will be returned by Object.toString().
setTimeZone(TimeZone) - Method in class org.piwik.java.tracking.PiwikDate: Deprecated.
Use ChronoZonedDateTime.toInstant() instead.
setTrackBotRequests(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest: By default, Matomo does not track bots.
setTransferTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest: How long it takes the browser to download the response from the server.
setUserCustomVariable(String, String) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.setVisitCustomVariables(CustomVariables) instead
setUserId(String) - Method in class org.matomo.java.tracking.MatomoRequest: Defines the User ID for this request.
setValue(String) - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
setVisitCustomVariable(CustomVariable, int) - Method in class org.matomo.java.tracking.MatomoRequest: Deprecated.
Use MatomoRequest.setVisitCustomVariables(CustomVariables) instead
setVisitCustomVariables(CustomVariables) - Method in class org.matomo.java.tracking.MatomoRequest: Custom variables are custom name-value pairs that you can assign to your visitors (or page views).
setVisitorCity(String) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the city.
setVisitorCountry(Country) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the country.
setVisitorCustomId(VisitorId) - Method in class org.matomo.java.tracking.MatomoRequest: defines the visitor ID for this request.
setVisitorFirstVisitTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest: The UNIX timestamp of this visitor's first visit.
setVisitorId(VisitorId) - Method in class org.matomo.java.tracking.MatomoRequest: The unique visitor ID.
setVisitorIp(String) - Method in class org.matomo.java.tracking.MatomoRequest: Override value for the visitor IP (both IPv4 and IPv6 notations supported).
setVisitorLatitude(Double) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the visitor's latitude, eg 22.456.
setVisitorLongitude(Double) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the visitor's longitude, eg 22.456.
setVisitorPreviousVisitTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest: The UNIX timestamp of this visitor's previous visit.
setVisitorRegion(String) - Method in class org.matomo.java.tracking.MatomoRequest: An override value for the region.
setVisitorVisitCount(Integer) - Method in class org.matomo.java.tracking.MatomoRequest: The current count of visits for this visitor.
siteId(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The ID of the website we're tracking a visit/action for.
size() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
sku(String) - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
socketTimeout(Duration) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The socket timeout (SO_TIMEOUT), which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.
sort(Comparator<? super EcommerceItem>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
spliterator() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
stream() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
subList(int, int) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
supportsCookies(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Does the visitor's client is known to support cookies.

T

threadPoolSize(int) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: The thread pool size for the async sender.
toArray() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
toArray(IntFunction<T[]>) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
toArray(T[]) - Method in class org.matomo.java.tracking.parameters.EcommerceItems
toString() - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder
toString() - Method in class org.matomo.java.tracking.MatomoRequest
toString() - Method in class org.matomo.java.tracking.parameters.AcceptLanguage.AcceptLanguageBuilder
toString() - Method in class org.matomo.java.tracking.parameters.AcceptLanguage: Returns the Accept Language header value.
toString() - Method in class org.matomo.java.tracking.parameters.Country
toString() - Method in class org.matomo.java.tracking.parameters.CustomVariable: Deprecated.
toString() - Method in class org.matomo.java.tracking.parameters.CustomVariables: Deprecated.

Creates a JSON representation of the custom variables.
toString() - Method in class org.matomo.java.tracking.parameters.DeviceResolution.DeviceResolutionBuilder
toString() - Method in class org.matomo.java.tracking.parameters.DeviceResolution
toString() - Method in class org.matomo.java.tracking.parameters.EcommerceItem.EcommerceItemBuilder
toString() - Method in class org.matomo.java.tracking.parameters.EcommerceItem
toString() - Method in class org.matomo.java.tracking.parameters.EcommerceItems.EcommerceItemsBuilder
toString() - Method in class org.matomo.java.tracking.parameters.EcommerceItems
toString() - Method in class org.matomo.java.tracking.parameters.RandomValue
toString() - Method in class org.matomo.java.tracking.parameters.UniqueId
toString() - Method in class org.matomo.java.tracking.parameters.VisitorId
toString() - Method in class org.matomo.java.tracking.TrackerConfiguration
toString() - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder
trackBotRequests(Boolean) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: By default, Matomo does not track bots.
TrackerConfiguration - Class in org.matomo.java.tracking: Defines configuration settings for the Matomo tracking.
TrackerConfiguration.TrackerConfigurationBuilder - Class in org.matomo.java.tracking
transferTime(Long) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: How long it takes the browser to download the response from the server.

U

UniqueId - Class in org.matomo.java.tracking.parameters: A six character unique ID consisting of the characters [0-9a-Z].
userAgent(String) - Method in class org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder: A custom user agent to be set.
userId(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Defines the User ID for this request.

V

validate() - Method in class org.matomo.java.tracking.TrackerConfiguration: Validates the auth token.
visitCustomVariables(CustomVariables) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Custom variables are custom name-value pairs that you can assign to your visitors (or page views).
visitorCity(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the city.
visitorCountry(Country) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the country.
visitorCustomId(VisitorId) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: defines the visitor ID for this request.
visitorFirstVisitTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The UNIX timestamp of this visitor's first visit.
visitorId(VisitorId) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The unique visitor ID.
VisitorId - Class in org.matomo.java.tracking.parameters: The unique visitor ID, must be a 16 characters hexadecimal string.
VisitorId() - Constructor for class org.matomo.java.tracking.parameters.VisitorId
visitorIp(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: Override value for the visitor IP (both IPv4 and IPv6 notations supported).
visitorLatitude(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the visitor's latitude, eg 22.456.
visitorLongitude(Double) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the visitor's longitude, eg 22.456.
visitorPreviousVisitTimestamp(Instant) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The UNIX timestamp of this visitor's previous visit.
visitorRegion(String) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: An override value for the region.
visitorVisitCount(Integer) - Method in class org.matomo.java.tracking.MatomoRequest.MatomoRequestBuilder: The current count of visits for this visitor.

W

width(int) - Method in class org.matomo.java.tracking.parameters.DeviceResolution.DeviceResolutionBuilder

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form