QueryParams (piwik-sdk 2.0.0 API)

java.lang.Object
- java.lang.Enum<QueryParams>
- - org.piwik.sdk.QueryParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QueryParams>
```
public enum QueryParams
extends java.lang.Enum<QueryParams>
```
Query parameters supported by the tracking HTTP API. See Tracking HTTP API

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACTION_NAME` The title of the action being tracked.
`API_VERSION` The parameter apiv=1 defines the api version to use (currently always set to 1)
`CAMPAIGN_KEYWORD` The Campaign Keyword (see Tracking Campaigns).
`CAMPAIGN_NAME` The Campaign name (see Tracking Campaigns).
`CONTENT_INTERACTION` The name of the interaction with the content.
`CONTENT_NAME` The name of the content.
`CONTENT_PIECE` The actual content piece.
`CONTENT_TARGET` The target of the content.
`DATETIME_OF_REQUEST` Override for the datetime of the request (normally the current time is used).
`DISCOUNT` The amount of the discount on the order
`DOWNLOAD` URL of a file the user has downloaded.
`ECOMMERCE_ITEMS` Items in your cart or order for ecommerce tracking
`EVENT_ACTION` The event action.
`EVENT_CATEGORY` The event category.
`EVENT_NAME` The event name.
`EVENT_VALUE` The event value.
`FIRST_VISIT_TIMESTAMP` The UNIX timestamp of this visitor's first visit (seconds since Jan 01 1970.
`GOAL_ID` If specified, the tracking request will trigger a conversion for the goal of the website being tracked with this ID.
`HOURS` The current hour (local time).
`LANGUAGE` An override value for the Accept-Language HTTP header field.
`LINK` An external URL the user has opened.
`MINUTES` The current minute (local time).
`ORDER_ID` The unique identifier for the order
`PREVIOUS_VISIT_TIMESTAMP` The UNIX timestamp of this visitor's previous visit (seconds since Jan 01 1970.
`RANDOM_NUMBER` Meant to hold a random value that is generated before each request.
`RECORD` Required for tracking, must be set to one, eg, rec=1.
`REFERRER` The full HTTP Referrer URL.
`REVENUE` A monetary value that was generated as revenue by this goal conversion.
`SCREEN_RESOLUTION` The resolution of the device the visitor is using, eg 1280x1024.
`SCREEN_SCOPE_CUSTOM_VARIABLES` Deprecated. Consider using Custom Dimensions
`SEARCH_CATEGORY` When `SEARCH_KEYWORD` is specified, you can optionally specify a search category with this parameter.
`SEARCH_KEYWORD` The Site Search keyword.
`SEARCH_NUMBER_OF_HITS` When `SEARCH_KEYWORD` is specified, we also recommend to set this to the number of search results.
`SECONDS` The current second (local time).
`SEND_IMAGE` If set to 0 (send_image=0) Piwik will respond with a HTTP 204 response code instead of a GIF image.
`SESSION_START` If set to 1, will force a new visit to be created for this action.
`SHIPPING` The amount of shipping paid on the order
`SITE_ID` The ID of the website we're tracking a visit/action for.
`SUBTOTAL` The sub total amount of the order
`TAX` The amount of tax paid for the order
`TOTAL_NUMBER_OF_VISITS` The current count of visits for this visitor.
`URL_PATH` The full URL for the current action.
`USER_AGENT` An override value for the User-Agent HTTP header field.
`USER_ID` Defines the User ID for this request.
`VISIT_SCOPE_CUSTOM_VARIABLES` Deprecated. Consider using Custom Dimensions
`VISITOR_ID` The unique visitor ID, must be a 16 characters hexadecimal string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`toString()`
`static QueryParams`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static QueryParams[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SITE_ID
```
public static final QueryParams SITE_ID
```
    The ID of the website we're tracking a visit/action for.
    (required)
  - RECORD
```
public static final QueryParams RECORD
```
    Required for tracking, must be set to one, eg, rec=1.
    (required)
  - URL_PATH
```
public static final QueryParams URL_PATH
```
    The full URL for the current action.
    (required)
  - ACTION_NAME
```
public static final QueryParams ACTION_NAME
```
    The title of the action being tracked.
    It is possible to use slashes / to set one or several categories for this action. For example, Help / Feedback will create the Action Feedback in the category Help.
    (recommended)
  - VISITOR_ID
```
public static final QueryParams VISITOR_ID
```
    The unique visitor ID, must be a 16 characters hexadecimal string.
    Every unique visitor must be assigned a different ID and this ID must not change after it is assigned. If this value is not set Piwik will still track visits, but the unique visitors metric might be less accurate.
    (recommended)
  - RANDOM_NUMBER
```
public static final QueryParams RANDOM_NUMBER
```
    Meant to hold a random value that is generated before each request.
    Using it helps avoid the tracking request being cached by the browser or a proxy.
    (recommended)
  - API_VERSION
```
public static final QueryParams API_VERSION
```
    The parameter apiv=1 defines the api version to use (currently always set to 1)
    (recommended)
  - REFERRER
```
public static final QueryParams REFERRER
```
    The full HTTP Referrer URL.
    This value is used to determine how someone got to your website (ie, through a website, search engine or campaign).
  - VISIT_SCOPE_CUSTOM_VARIABLES
```
@Deprecated
public static final QueryParams VISIT_SCOPE_CUSTOM_VARIABLES
```
    Deprecated. Consider using Custom Dimensions
    
    Visit scope custom variables.
    This is a JSON encoded string of the custom variable array.
    
    See Also:
    
    CustomDimension
  - TOTAL_NUMBER_OF_VISITS
```
public static final QueryParams TOTAL_NUMBER_OF_VISITS
```
    The current count of visits for this visitor.
    To set this value correctly, it would be required to store the value for each visitor in your application (using sessions or persisting in a database). Then you would manually increment the counts by one on each new visit or "session", depending on how you choose to define a visit. This value is used to populate the report Visitors > Engagement > Visits by visit number.
  - PREVIOUS_VISIT_TIMESTAMP
```
public static final QueryParams PREVIOUS_VISIT_TIMESTAMP
```
    The UNIX timestamp of this visitor's previous visit (seconds since Jan 01 1970. (UTC)).
    This parameter is used to populate the report Visitors > Engagement > Visits by days since last visit.
  - FIRST_VISIT_TIMESTAMP
```
public static final QueryParams FIRST_VISIT_TIMESTAMP
```
    The UNIX timestamp of this visitor's first visit (seconds since Jan 01 1970. (UTC)).
    This could be set to the date where the user first started using your software/app, or when he/she created an account. This parameter is used to populate the Goals > Days to Conversion report.
  - CAMPAIGN_NAME
```
public static final QueryParams CAMPAIGN_NAME
```
    The Campaign name (see Tracking Campaigns).
    Used to populate the Referrers > Campaigns report. Note: this parameter will only be used for the first pageview of a visit.
  - CAMPAIGN_KEYWORD
```
public static final QueryParams CAMPAIGN_KEYWORD
```
    The Campaign Keyword (see Tracking Campaigns).
    Used to populate the Referrers > Campaigns report (clicking on a campaign loads all keywords for this campaign). Note: this parameter will only be used for the first pageview of a visit.
  - SCREEN_RESOLUTION
```
public static final QueryParams SCREEN_RESOLUTION
```
    The resolution of the device the visitor is using, eg 1280x1024.
  - HOURS
```
public static final QueryParams HOURS
```
    The current hour (local time).
  - MINUTES
```
public static final QueryParams MINUTES
```
    The current minute (local time).
  - SECONDS
```
public static final QueryParams SECONDS
```
    The current second (local time).
  - USER_AGENT
```
public static final QueryParams USER_AGENT
```
    An override value for the User-Agent HTTP header field.
    The user agent is used to detect the operating system and browser used.
  - LANGUAGE
```
public static final QueryParams LANGUAGE
```
    An override value for the Accept-Language HTTP header field.
    This value is used to detect the visitor's country if GeoIP is not enabled.
  - USER_ID
```
public static final QueryParams USER_ID
```
    Defines the User ID for this request.
    User ID is any non empty unique string identifying the user (such as an email address or a username). To access this value, users must be logged-in in your system so you can fetch this user ID from your system, and pass it to Piwik. The User ID appears in the visitor log, the Visitor profile, and you can Segment reports for one or several User ID (userId segment). When specified, the User ID will be "enforced". This means that if there is no recent visit with this User ID, a new one will be created. If a visit is found in the last 30 minutes with your specified User ID, then the new action will be recorded to this existing visit.
  - SESSION_START
```
public static final QueryParams SESSION_START
```
    If set to 1, will force a new visit to be created for this action.
  - SCREEN_SCOPE_CUSTOM_VARIABLES
```
public static final QueryParams SCREEN_SCOPE_CUSTOM_VARIABLES
```
    Deprecated. Consider using Custom Dimensions
    
    Page scope custom variables. This is a JSON encoded string of the custom variable array.
    
    See Also:
    
    CustomDimension
  - LINK
```
public static final QueryParams LINK
```
    An external URL the user has opened.
    Used for tracking outlink clicks. We recommend to also set the url parameter to this same value.
  - DOWNLOAD
```
public static final QueryParams DOWNLOAD
```
    URL of a file the user has downloaded.
    Used for tracking downloads. We recommend to also set the url parameter to this same value.
  - SEARCH_KEYWORD
```
public static final QueryParams SEARCH_KEYWORD
```
    The Site Search keyword.
    When specified, the request will not be tracked as a normal pageview but will instead be tracked as a Site Search request.
  - SEARCH_CATEGORY
```
public static final QueryParams SEARCH_CATEGORY
```
    When SEARCH_KEYWORD is specified, you can optionally specify a search category with this parameter.
  - SEARCH_NUMBER_OF_HITS
```
public static final QueryParams SEARCH_NUMBER_OF_HITS
```
    When SEARCH_KEYWORD is specified, we also recommend to set this to the number of search results.
  - GOAL_ID
```
public static final QueryParams GOAL_ID
```
    If specified, the tracking request will trigger a conversion for the goal of the website being tracked with this ID.
  - REVENUE
```
public static final QueryParams REVENUE
```
    A monetary value that was generated as revenue by this goal conversion.
    Only used if GOAL_ID is specified in the request.
  - DATETIME_OF_REQUEST
```
public static final QueryParams DATETIME_OF_REQUEST
```
    Override for the datetime of the request (normally the current time is used).
    This can be used to record visits and page views in the past. The expected format is: 2011-04-05 00:11:42 (remember to URL encode the value!). The datetime must be sent in UTC timezone. Events can only be backdated for a maximum time of 24h. Note: if you record data in the past, you will need to force Piwik to re-process reports for the past dates.
  - CONTENT_NAME
```
public static final QueryParams CONTENT_NAME
```
    The name of the content. For instance 'Ad Foo Bar'
    
    See Also:
    
    Content Tracking
  - CONTENT_PIECE
```
public static final QueryParams CONTENT_PIECE
```
    The actual content piece. For instance the path to an image, video, audio, any text
    
    See Also:
    
    Content Tracking
  - CONTENT_TARGET
```
public static final QueryParams CONTENT_TARGET
```
    The target of the content. For instance the URL of a landing page
    
    See Also:
    
    Content Tracking
  - CONTENT_INTERACTION
```
public static final QueryParams CONTENT_INTERACTION
```
    The name of the interaction with the content. For instance a 'click'
    
    See Also:
    
    Content Tracking
  - EVENT_CATEGORY
```
public static final QueryParams EVENT_CATEGORY
```
    The event category. Must not be empty. (eg. Videos, Music, Games...)
    
    See Also:
    
    Event Tracking
  - EVENT_ACTION
```
public static final QueryParams EVENT_ACTION
```
    The event action. Must not be empty. (eg. Play, Pause, Duration, Add Playlist, Downloaded, Clicked...)
    
    See Also:
    
    Event Tracking
  - EVENT_NAME
```
public static final QueryParams EVENT_NAME
```
    The event name. (eg. a Movie name, or Song name, or File name...)
    
    See Also:
    
    Event Tracking
  - EVENT_VALUE
```
public static final QueryParams EVENT_VALUE
```
    The event value. Must be a float or integer value (numeric), not a string.
    
    See Also:
    
    Event Tracking
  - ECOMMERCE_ITEMS
```
public static final QueryParams ECOMMERCE_ITEMS
```
    Items in your cart or order for ecommerce tracking
  - TAX
```
public static final QueryParams TAX
```
    The amount of tax paid for the order
  - ORDER_ID
```
public static final QueryParams ORDER_ID
```
    The unique identifier for the order
  - SHIPPING
```
public static final QueryParams SHIPPING
```
    The amount of shipping paid on the order
  - DISCOUNT
```
public static final QueryParams DISCOUNT
```
    The amount of the discount on the order
  - SUBTOTAL
```
public static final QueryParams SUBTOTAL
```
    The sub total amount of the order
  - SEND_IMAGE
```
public static final QueryParams SEND_IMAGE
```
    If set to 0 (send_image=0) Piwik will respond with a HTTP 204 response code instead of a GIF image.
    This improves performance and can fix errors if images are not allowed to be obtained directly (eg Chrome Apps). Available since Piwik 2.10.0
- Method Detail
  - values
```
public static QueryParams[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (QueryParams c : QueryParams.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static QueryParams valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<QueryParams>

Enum QueryParams

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SITE_ID

RECORD

URL_PATH

ACTION_NAME

VISITOR_ID

RANDOM_NUMBER

API_VERSION

REFERRER

VISIT_SCOPE_CUSTOM_VARIABLES

TOTAL_NUMBER_OF_VISITS

PREVIOUS_VISIT_TIMESTAMP

FIRST_VISIT_TIMESTAMP

CAMPAIGN_NAME

CAMPAIGN_KEYWORD

SCREEN_RESOLUTION

HOURS

MINUTES

SECONDS

USER_AGENT

LANGUAGE

USER_ID

SESSION_START

SCREEN_SCOPE_CUSTOM_VARIABLES

LINK

DOWNLOAD

SEARCH_KEYWORD

SEARCH_CATEGORY

SEARCH_NUMBER_OF_HITS

GOAL_ID

REVENUE

DATETIME_OF_REQUEST

CONTENT_NAME

CONTENT_PIECE

CONTENT_TARGET

CONTENT_INTERACTION

EVENT_CATEGORY

EVENT_ACTION

EVENT_NAME

EVENT_VALUE

ECOMMERCE_ITEMS

TAX

ORDER_ID

SHIPPING

DISCOUNT

SUBTOTAL

SEND_IMAGE

Method Detail

values

valueOf

toString