Analytics

Performance overview

Visitors, conversions, conversion rate, observed revenue, top sources and channels and a time series for a window, optionally narrowed to one dimension value and compared with the previous period of the same length.

get/sites/{site}/overview

Request

  • Base URL: https://api.onelence.com/v1
  • URL: https://api.onelence.com/v1/sites/{site}/overview
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.onelence.com/oauth/authorize, token URL https://api.onelence.com/oauth/token, scopes: analytics:read)
    • HTTP bearer

Path parameters

sitestring required

Site domain (e.g. example.com) or site id. Defaults to the workspace's newest active site.

Query parameters

startstring

Window start: a date (YYYY-MM-DD) or ISO 8601 date-time. Defaults to 30 days before end.

endstring

Window end, inclusive for a date. Defaults to now.

bucket'auto' | 'hour' | 'day' | 'week' | 'month'

Time series granularity (default auto).

filter_dimension'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device'

Narrow to one value of a dimension, e.g. source, channel, campaign, country, entry (landing page) or page.

filter_valuestring

The value to keep, e.g. google, /pricing or DE. Requires filter_dimension.

compare'none' | 'previous_period'

previous_period adds the same-length window right before, with changes (default none).

Response

Success.

object'overview' required
notestring required
series_truncatedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.