• Home
• Piwik
• Plugins
• Goals
• API

PHP Class Piwik\Plugins\Goals\API

If you are tracking Ecommerce orders and products on your site, the functions "getItemsSku", "getItemsName" and "getItemsCategory" will return the list of products purchased on your site, either grouped by Product SKU, Product Name or Product Category. For each name, SKU or category, the following metrics are returned: Total revenue, Total quantity, average price, average quantity, number of orders (or abandoned carts) containing this product, number of visits on the Product page, Conversion rate. By default, these functions return the 'Products purchased'. These functions also accept an optional parameter &abandonedCarts=1. If the parameter is set, it will instead return the metrics for products that were left in an abandoned cart therefore not purchased. The API also lets you request overall Goal metrics via the method "get": Conversions, Visits with at least one conversion, Conversion rate and Revenue. If you wish to request specific metrics about Ecommerce goals, you can set the parameter &idGoal=ecommerceAbandonedCart to get metrics about abandoned carts (including Lost revenue, and number of items left in the cart) or &idGoal=ecommerceOrder to get metrics about Ecommerce orders (number of orders, visits with an order, subtotal, tax, shipping, discount, revenue, items ordered) See also the documentation about Tracking Goals in Piwik. Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
addGoal ( integer $idSite, string $name, string $matchAttribute, string $pattern, string $patternType, boolean $caseSensitive = false, boolean | float $revenue = false, boolean $allowMultipleConversionsPerVisit = false, string $description = '' ) : integer	Creates a Goal for a given website.
deleteGoal ( integer $idSite, integer $idGoal ) : void	Soft deletes a given Goal.
get ( integer $idSite, string $period, string $date, boolean $segment = false, boolean | integer $idGoal = false, array $columns = [] ) : DataTable	Returns Goals data.
getConversionRate ( $idSite, $period, $date, $segment = false, $idGoal = false )
getConversions ( $idSite, $period, $date, $segment = false, $idGoal = false )
getDaysToConversion ( integer $idSite, string $period, string $date, string | boolean $segment = false, integer | boolean $idGoal = false ) : false | DataTable	Gets a DataTable that maps ranges of days to the number of conversions that occurred within those ranges, for the specified site, date range, segment and goal.
getGoal ( integer $idSite, integer $idGoal ) : array	Return a single goal.
getGoals ( string | array $idSite ) : array	Returns all Goals for a given website, or list of websites
getItemsCategory ( $idSite, $period, $date, $abandonedCarts = false, $segment = false )
getItemsName ( $idSite, $period, $date, $abandonedCarts = false, $segment = false )
getItemsSku ( $idSite, $period, $date, $abandonedCarts = false, $segment = false )
getMetrics ( $idSite, $period, $date, $segment = false, $idGoal = false, $columns = [] )	Similar to {@link get()} but does not return any metrics for new and returning visitors. It won't apply any segment by default. This method is deprecated from the API as it is only there to make the implementation of the actual {@link get()} method easy.
getNbVisitsConverted ( $idSite, $period, $date, $segment = false, $idGoal = false )
getRevenue ( $idSite, $period, $date, $segment = false, $idGoal = false )
getVisitsUntilConversion ( integer $idSite, string $period, string $date, string | boolean $segment = false, integer | boolean $idGoal = false ) : boolean | DataTable	Gets a DataTable that maps ranges of visit counts to the number of conversions that occurred on those visits for the specified site, date range, segment and goal.
updateGoal ( integer $idSite, integer $idGoal, $name, $matchAttribute, string $pattern, string $patternType, boolean $caseSensitive = false, boolean | float $revenue = false, boolean $allowMultipleConversionsPerVisit = false, string $description = '' ) : void	Updates a Goal description.

Protected Methods

Method	Description
appendSegment ( $segment, $segmentToAppend )
convertSpecialGoalIds ( string | integer $idGoal ) : integer	Helper function that checks for special string goal IDs and converts them to their integer equivalents.
enrichItemsDataTableWithItemsViewMetrics ( $dataTable, $idSite, $period, $date, $segment, $idSubtable )
enrichItemsTableWithViewMetrics ( $dataTable, $recordName, $idSite, $period, $date, $segment )	Enhances the dataTable with Items attributes found in the Custom Variables report.
getGoalSpecificDataTable ( string $recordName, integer | string $idSite, string $period, string $date, string $segment, integer | boolean $idGoal ) : false | DataTable	Utility method that retrieve an archived DataTable for a specific site, date range, segment and goal. If not goal is specified, this method will retrieve and sum the data for every goal.
getItems ( $recordName, $idSite, $period, $date, $abandonedCarts, $segment )	Returns a datatable of Items SKU/name or categories and their metrics If $abandonedCarts set to 1, will return items abandoned in carts. If set to 0, will return items ordered
getNumeric ( $idSite, $period, $date, $segment, $toFetch )
renameNotDefinedRow ( $dataTable, $notDefinedStringPretty )

Private Methods

Method	Description
checkDescription ( $description )
checkName ( $name )
checkPattern ( $pattern )
checkPatternIsValid ( $patternType, $pattern, $matchAttribute )
formatGoal ( $goal )
getCacheId ( $idSite )
getGoalsInfoStaticCache ( )
getModel ( )

Method Details