Web API
Start typing to search…

Tracking endpoint

get https://{account}.piwik.pro/ppms.php

Endpoint tracking events (page views, goal conversions, custom events).

IMPORTANT: All of string type values HAVE TO be urlencoded in raw URL, according to https://url.spec.whatwg.org/ specification, as shown in examples. Decoded value is provided in at the end of description.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 36 and 36

Recommended Application ID (previously Website ID).

IMPORTANT: Requests should contain idsite parameter with actual UUID of one of your apps, otherwise they won't appear in reports.

integer

Recommended Whether the request should be recorded.

IMPORTANT: Requests should contain rec=1 parameter, otherwise they won't appear in reports.

string

Recommended URL of an event.

IMPORTANT: URL/URI has to have authority or mailto scheme.
You can lean more about authority and scheme here.

Decoded value: https://example.com/path/to/page.html

string

Recommended Name of event. Could be page title or custom-built path expressing the location in application.

Decoded value: help/delivery/shipping

string
length between 16 and 16

Recommended Visitor ID.

It allows you to use the application identifier of a Visitor instead of a default identifier generated by
the analytics. See: Recognizing Visitors.

string

Recommended Cache buster.

Its value should be unique for every request to make sure that the request is sent to server and not
read from a cache. Value can be random or sequential (e.g. UNIX timestamp). It is especially useful if
the visitor is behind some kind of caching proxy.

string

HTTP referrer.

The URL of the previous page that linked to current one.

IMPORTANT: URL/URI has to have authority or mailto scheme.
You can lean more about authority and scheme here.

Decoded value: http://example.com/path/to/previous/page.html

string

Custom variables set in the session scope.

IMPORTANT: value have to be urlencoded in raw URL, below is decoded JSON, do not use it directly in raw URL.

Decoded value: {"1":["AspectRatio","16:9"],"2":["Height","1080"],"3":["Width","1920"]}

Format: Object serialized with JSON:

  • key - (string) Custom variable ID
  • value - Array with:
    • (string) Custom variable name, max length: 200 characters
    • (string) Custom variable value, max length: 200 characters
string

Custom variables set in the event scope.

IMPORTANT: value have to be urlencoded in raw URL, below is decoded JSON, do not use it directly in raw URL.

Decoded value: {"1":["AspectRatio","16:9"],"2":["Height","1080"],"3":["Width","1920"]}

Format: Object serialized with JSON:

  • key - (string) Custom variable ID
  • value - Array with:
    • (string) Custom variable name, max length: 200 characters
    • (string) Custom variable value, max length: 200 characters
integer

Visit counter.

It sets the visit number of the visitor. It should be used when the application already tracks how many times the visitor
used it and you want to override default visit counter.

integer

Time of previous visit in UNIX timestamp format (number of seconds since 1970-01-01).

integer

Time of first visit.

string

Resolution of the visitor's device in pixels.

integer
0 to 23

Hour when the request was made in the visitor's local time.

integer
0 to 59

Minute when the request was made in the visitor's local time.

integer
0 to 59

Second when the request was made in the visitor's local time.

string

User-Agent browser value. It can be used to override value send in request HTTP header.

It is used to detect Visitors browser and operating system.

Decoded value: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.162 Safari/537.36

string

Accept-Language browser value. It can be used to override value send in request HTTP header.

It's used to guess Visitors country when GeoIP is not able to determine it.

Decoded value: en-US,en;q=0.9,pl;q=0.8

string
length ≥ 1

User ID.

Can be used to identify Visitor by the application (e.g. login name, email address or internal
user ID). See: Recognizing Visitors.

Decoded value PhilipFry@example.com

string
length between 16 and 16

Configuration ID.

Semi-unique hash generated for the visitor's browser (based on configuration and installed plugins).
This parameter overwrites visitor's visitor_id sent with _id parameter. For further explanation
please read the following article:
Recognizing Visitors - the VisitorID section.

integer
Defaults to 0

Force start of new visit when value is 1.

string

Custom dimension value for specific ID.
Assigns arbitrary value to specific session or event dimension.

ID in the parameter name should be replaced with its integer value (e.g. dimension1, dimension2,
dimension999).

It is possible to override page view's event custom dimension by sending ping request with updated dimension value.

Decoded value: blue crab cult(not that blue)

string

External URL opened by the Visitor. It is recommended to set url parameter to same value.

IMPORTANT: URL/URI has to have authority or mailto scheme.
You can lean more about authority and scheme here.

Decoded value: http://help-example.com/how-to/register.html

string

URL of downloaded file.

IMPORTANT: URL/URI has to have authority or mailto scheme.
You can lean more about authority and scheme here.

Decoded value: http://example.com/files/TermsOfService.pdf

string

Internal search query. Used for tracking keyword the visitor searched for in the application.
See: Site search.

Requests with this parameter create Search events.

Decoded value: sherlock holmes

string

Internal search categories. Used for tracking categories the visitor specified during a search in the application.
See: Site search.

IMPORTANT: value have to be urlencoded in raw URL, below is decoded JSON, do not use it directly in raw URL.

Decoded value: ["Movies & TV","Cartoons","Video games"]

Requests with this parameter create Search events.

The provided value must be a JSON-serialized array of strings.

integer
0 to 4294967295

Internal search result count. Number of results found in a search.
See: Site search.

Requests with this parameter create Search events.

string
6 to 6

Unique page view ID generated when the page is loaded.

Used to connect future events with the last page view.

uuid

Goal ID. Signifies that a goal has been reached and tracks its conversion.

Accepts either Goal UUID or legacy integer Goal ID.

Value 0 is reserved for E-commerce cart tracking.

number

Revenue value of achieved goal; if e_t is 'order' or 'cart-update,' then the revenue reflects the grandTotal of the cart.

Currency of the value does not matter, but only one should be used by the application (e.g. USD).

string

Type of event in tracking request. Used for some event types. Decides how other parameters will be interpreted.

string

E-commerce order ID.

Decoded value: order-123 customer-321

string

Contents of the E-commerce cart in form of two dimensional, index positioned JSON array. This is NOT an associative array.

IMPORTANT: value have to be urlencoded in raw URL, below is decoded JSON, do not use it directly in raw URL.

Decoded value: [ [ "craft-311", "Unicorn Iron on Patch", "Crafts & Sewing", 4.99, 3, "FairyTales", "3-color rainbow" ], [ "craft-312", "Unicorn Lamp", [ "Crafts & Sewing", "Lamps" ], 13.25, 1, "FairyTales", "black-and-white", { "1":"custom glitter" } ] ]

optional parameters can be replaced with JSON null value, put in their respective position.

Each product on the list can contain:

  • [0] sku: string (required) Stock keeping unit. Max 1024 bytes long.
  • [1] name: string (optional) Name of a product. Max 1024 bytes long.
  • [2] category: string|Array<string> (optional) Category of a product. Max 5 categories, each 1024 bytes long.
  • [3] price: number (optional, defaults to 0.0) Price of a product.
    Currency of this value does not matter, but only one should be used by the application (e.g. USD).
  • [4] quantity: integer (optional, defaults to 1) Quantity of a product.
  • [5] brand: string (optional) a brand of the product
  • [6] variant: string (optional) a variant of the product
  • [7] product custom dimensions: Object<string, string> (optional) a dictionary of custom dimension values, numeric string ID and a string with value. Max 20 product custom dimensions, 20 is max ID.

Legend: [index] name: data type (requisite) Description. Restrictions.

E-commerce cart must not contain more than 100 products.

number

E-commerce order sub-total (order cost without shipping).

Currency of the value does not matter, but only one should be used by the application (e.g. USD).

number

E-commerce order tax.

Currency of the value does not matter, but only one should be used by the application (e.g. USD).

number

E-commerce order shipping.

Currency of the value does not matter, but only one should be used by the application (e.g. USD).

number

E-commerce order discount.

Currency of the value does not matter, but only one should be used by the application (e.g. USD).

string

Currency of the revenue and all monetary values in the request. If not provided, the currency value set in app settings will be used.

The currency code must comply with the ISO 4217 standard.

integer

Time of the last E-commerce order in UNIX timestamp format (number of seconds since 1970-01-01).

integer

Page generation and load time in milliseconds.

string
Defaults to UTF-8

Page charset.

Used for decoding parameters in event URL.

integer
Defaults to 0

Status of Cookie capability in Visitor's browser (value "1" indicates that it is enabled).

integer
Defaults to 0

Status of Flash plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of Java plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of Adobe Director plugin in Visitor's browser (value "1" indicates that it is installed).

integer

Status of QuickTime plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of RealPlayer plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of PDF plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of Windows Media Player plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of (Google) Gears plugin in Visitor's browser (value "1" indicates that it is installed).

integer
Defaults to 0

Status of Silverlight plugin in Visitor's browser (value "1" indicates that it is installed).

string
length between 1 and 16384

Custom event category.

string
length between 1 and 16384

Custom event action.

string
length between 1 and 16384

Custom event name.

float
0 to 100000000000

Custom event value.

string
length between 1 and 1024

Content name.

string
length between 1 and 1024

'Content piece.'

Decoded value: Unicorn Iron on Patch

string
length between 1 and 1024

'Content target.'

Decoded value: http://example.com/product/unicorn-iron-on-path.html

string
length between 1 and 1024

'Content interaction.'

Decoded value: show details

integer
Defaults to 0

Whether the server should respond with a 1 pixel GIF:

  • 0 - return text/html [No content]
  • 1 - return image/gif [1 pixel GIF]

Override IP.

string

Override request time. You can use it when importing HTTP logs. Provided value should be in UTC timezone.

Decoded value: 2018-02-24 15:34:48

string

Override country.

string

Override city.

Decoded value: New York

number
-90 to 90

Override latitude.

number
-180 to 180

Override longitude.

integer
Defaults to 0

Whether the user should be tracked anonymously.

  • 1 - all IP bytes will be masked (0.0.0.0), GeoIP data below Country level will be anonymized
  • 0 - available visitor data will be added to the session
integer
Defaults to 0

Anonymize device dimensions/attributes and user agent of received request.

Notice: This parameter will have an effect only when uia is set to 1.

  • 1 - anonymize 'User-Agent' header and device dimensions/attributes
  • 0 - no anonymization will be applied
integer

Indicator of a ping event. Pings update custom variables, custom
dimensions and time metrics of the last page view. They help us
determine time spent on a page.

  • 1 - Periodic heartbeat request (sent every X seconds)
  • 2 - Last heartbeat (sent on page unload event)
  • 3 - Blur heartbeat (sent on page blur event)
  • 4 - Request deanonymizing user
  • 5 - Request with page performance metrics
  • 6 - Request sent by the user (using ping command)
integer
0 to 65535

Unload Event Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.unloadEventStart

integer
0 to 65535

Unload Event End - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.unloadEventEnd

integer
0 to 65535

Redirect Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.redirectStart

integer
0 to 65535

Redirect End - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.redirectEnd

integer
0 to 65535

Secure Connection Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.secureConnectionStart

integer
0 to 65535

Fetch Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.fetchStart

integer
0 to 65535

Domain Lookup Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.domainLookupStart

integer
0 to 65535

Connect Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.connectStart

integer
0 to 65535

Connect End - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.connectEnd

integer
0 to 65535

Request Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.requestStart

integer
0 to 65535

Response Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.responseStart

integer
0 to 65535

Response End - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.responseEnd

integer
0 to 65535

DOM Loading - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.domLoading

integer
0 to 16777215

DOM Interactive - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.domInteractive

integer
0 to 16777215

DOM Content Loaded Event Start - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.domContentLoadedEventStart

integer
0 to 16777215

DOM Content Loaded Event End - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.domContentLoadedEventEnd

integer
0 to 16777215

DOM Complete - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.domComplete

integer
0 to 16777215

Load Event End - one of the Page Performance Metrics.
Designed for the value of PerformanceTiming.loadEventEnd

string

Name of a library used for tracking.

Decoded value: iOs SDK

string

Version of a library used for tracking. Semantic Versioning format required.

integer

Provides on-demand control of the SessionHash feature (0=disabled, 1=enabled)

When this parameter is not used, processing service will default to the current value from the Privacy tab in global or app settings.

integer

Forces tracker to erase IP information from cip query parameter, common headers and socket address when provided with value 1.

The erasure happens before the processing, so that IP information is not stored.

Headers
string

Recommended User agent of the browser that sent the request

Responses
202

Request accepted and waiting for processing

400

Bad Request

Updated 5 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!

Updated 5 days ago

Did this page help you?