TaleArt docs

Type a word to find a page, a heading or a sentence in the docs.

GitHub

Read your analytics

This guide reads a zone's Analytics tab, step by step: the period, the metric tiles and their definitions, the chart and the tables, and the empty state with the opt-out. The tab counts what the Web SDK sends from a page, so the zone must be on a page first (see the Web guide). The definitions and the event rules are in the Analytics reference.

  1. Open the zone's Analytics tab and choose the period.

    On the zone page, select the Analytics tab. The period picker sets the window: the last 7, 30 or 90 days, in UTC days with today included. The default is 30 days, and the choice stays in the address (?period=7d), so a reload or a shared link shows the same window.
    The Analytics tab of a zone with 30 days chosen: seven metric tiles across the top with their numbers, and below them a line chart of daily impressions and clicks that rises through the month and peaks on a launch day.
    The Analytics tab, a real screenshot of the dashboard with a sample zone's events. The numbers are the sample's.

  2. Read a tile, and open its definition.

    Each tile shows one metric of the period. Under each tile, Definition opens the published definition, the same text as the Analytics reference. Engagement rate, for one, is the engaged visitors divided by Reach, and the tile says so.
    The metric tiles with the Engagement rate tile's Definition open. It reads: engaged visitors divided by Reach, as a percentage, one decimal, where engaged visitors are the distinct visitors with at least one impression and at least one open in the period.
    The Engagement rate tile with its definition open, a real screenshot of the dashboard.

  3. Read the tables by tale group and by tale.

    The chart plots impressions and clicks by UTC day, and a day's counts show when you point at it. Under it, By tale group gives each group's figures, and By tale gives each tale's views and clicks. A dash means the count is not kept per tale: impressions, reach, opens and engagement name a group. Reach is distinct per row, so a total is not the sum of its rows.
    Two tables. By tale group lists four groups with impressions, reach, opens, tale views, clicks, engagement rate and CTR. By tale lists tales with their group, a dash where a group-level count does not apply, views, clicks and CTR.
    The two tables of a period, a real screenshot of the dashboard with the sample zone.

  4. When nothing is counted yet, or to turn sending off.

    Until a visitor sees a tale group, the tab shows No events yet and every count stays at zero. Sending is on by default. Turn it off for the whole page with analytics: false in init, or for one element with analytics="off"; the element's attribute wins. 
    import { init } from 'https://api.example.com/sdk/v1/taleart.js';

// Off for every element on the page:
init({ analytics: false });
    <!-- Off for this element only; any other value, or none, leaves it to the page: -->
<taleart-view zone-key="YOUR_ZONE_KEY" analytics="off"></taleart-view>
    The Analytics tab of a zone with no events: the heading No events yet, a paragraph that says the counts stay at zero until a visitor sees a tale group, and the note on setting analytics off on the element or with Taleart.init.
    The empty state of a zone with no events, a real screenshot of the dashboard. It names the same opt-out as the snippets above.

Where the numbers come from

The Web SDK sends four events: an impression when a group is half on screen, an open, a view of a tale and a click on a tale's button. Events are sent in batches. The Delivery API accepts an event up to 7 days after it happened, and the counts are kept for 400 days, so every period the tab offers is counted from stored events. The Android and iOS SDKs do not send analytics events yet, so the tab counts the web only. The full rules, the endpoints and the stored fields are in the Analytics reference.

Edit this page on GitHub