Permalink
Browse files

Update readme

  • Loading branch information...
1 parent 499b212 commit 43b0f8c60970943ac417b21de97d83283aad9403 Akron committed Mar 5, 2013
Showing with 26 additions and 5 deletions.
  1. +26 −5 Readme.pod
View
@@ -122,6 +122,9 @@ not allow third party cookies.
See the L<default tag helper|Mojolicious::Plugin::TagHelpers/tag>
for explanation of usage.
+B<The 'opt-out' and 'opt-out-url' options are
+EXPERIMENTAL and may change in further releases!>
+
=head2 piwik_api
@@ -190,11 +193,6 @@ Defaults to the url given when the plugin was registered.
C<secure> - Boolean value that indicates a request using the https scheme.
Defaults to false.
-=item
-
-C<api_test> - Boolean value that indicates a test request, that returns the
-created request url instead of the JSON response. Defaults to false.
-
=back
C<idSite> is an alias of C<site_id> and C<idsite> and defaults to the id
@@ -218,6 +216,29 @@ encoded and mime-type prefixed in the hash value of C<image>,
ready to be embedded as the C<src> of an C<E<lt>img /E<gt> tag.
+=head2 piwik_api_url
+
+ my $src_url = $c->piwik_api_url(
+ ImageGraph.get => {
+ apiModule => 'VisitsSummary',
+ apiAction => 'get',
+ graphType => 'evolution',
+ period => 'day',
+ date => 'last30',
+ width => 500,
+ height => 250
+ });
+
+ # In template
+ <img src="<%= $src_url %>" alt="Piwik analysis" />
+
+Creates the URL of an API request and returns the L<Mojo::URL> object.
+Accepts the same parameters as the L<piwik_api|/piwik_api> helper,
+excluding the callback.
+
+B<This helper is EXPERIMENTAL and may change without warnings!>
+
+
=head1 LIMITATIONS
The plugin currently lacks support for eCommerce tracking.

0 comments on commit 43b0f8c

Please sign in to comment.