Engagement
What visitors do on your site, from the events they send to the goals they complete and what they search for.
Engagement is what visitors do on your site, beyond reading it:
- Events are what your site sends on purpose with
silktide("…"), such as a form sent or a video played, and what the Silktide Script records itself, such as clicks and downloads. An event your site sends can carry properties, the detail of what happened: which accordion was opened, which form was sent. Get events lists them; the event queries after it look inside one. - Goals are the outcomes you set up in Silktide, such as reaching a thank-you page or sending an event. Get goals says how often each was completed.
- Site search is what people type into your site's own search boxes, once the account has chosen them under Analytics > Settings > Data. Get site search terms lists the terms.
Every query here takes the arguments every Analytics query takes, such as view and period; see Analytics. The over-time queries need a period other than all.
To send events from your site in the first place, see Send events with the Silktide Script.
In Silktide itself: Engagement, in Help.
- GETList the events visitors sent, with how often and by how many
/v1/results/analytics/eventsLists every event sent in the period, one row each, most sent first: the events your site sends with silktide("…"), and the ones the Silktide Script records by itself (pageload, click, download, frustration and the others). - GETGet how often each event was sent, step by step
/v1/results/analytics/events-over-timeCounts how often events were sent across the period, one line per event in multiSeries, and every event together in total and series. - GETList the properties an event was sent with
/v1/results/analytics/event-propertiesLists the properties one event was sent with, most sent first. - GETRank the values one property of an event was sent with
/v1/results/analytics/event-property-valuesRanks one property's values, most sent first, with the number of times each was sent. - GETList every time an event was sent, newest first
/v1/results/analytics/event-occurrencesLists every time one event was sent, newest first. - GETList goals and how often each was completed
/v1/results/analytics/goalsLists every goal of the view, or of the website, with how many times each was completed in the period and the share of visitors who completed it, most completed first. - GETList what people searched your site for
/v1/results/analytics/site-search-termsLists every term people typed into your site's own search boxes in the period, with its searches and visitors, most searched first. - GETCount searches of your site, step by step
/v1/results/analytics/site-searches-over-timeCounts searches of your site's own search boxes over the period, one entry per step.