Chartbeat
The table below gives information about all the data fields that you can import from Chartbeat.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs. As a result, the fields shown here may not be the same as the fields available in Adverity. If you notice a difference between this documentation and the fields you see in Adverity, please contact your Adverity account manager for more information.
To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.
Field UI name |
Field API name |
Description |
Use in Adverity |
Docs |
---|---|---|---|---|
author |
author |
The author of a page. |
dimension |
|
canonical_referrer |
canonical_referrer |
A rolled-up view of the referrer domain. For instance, traffic from m.facebook.com and facebook.com both have a canonical referrer of Facebook. |
dimension |
|
city |
city |
The city the visitor was in. |
dimension |
|
client_day |
client_day |
The calendar day, according to the timezone set by the visitor. |
dimension |
|
client_hour |
client_hour |
The hour of the day (0-23), according to the timezone set by the visitor. |
dimension |
|
client_minute |
client_minute |
The minute, according to the timezone set by the visitor. |
dimension |
|
contenttype |
contenttype |
The content type (e.g. gallery, article) as tagged on your site or AMP page. |
dimension |
|
country |
country |
The country the visitor was in. |
dimension |
|
device |
device |
The device used (mobile/desktop/tablet). |
dimension |
|
distribution |
distribution |
The distribution channel used (site/FBIA/app). |
dimension |
|
host |
host |
The reported domain. |
dimension |
|
internal_path |
internal_path |
The page path that users clicked off from when they traveled to a new page. Useful for learning about historical click-through data. |
dimension |
|
os |
os |
The operating system used. |
dimension |
|
page_avg_scroll |
page_avg_scroll |
The average maximum depth that visitors have scrolled to, in pixels, from the top of the page. |
metric |
|
page_avg_time |
page_avg_time |
The average amount of time in seconds visitors actively spent on a page. |
metric |
|
page_load_hist |
page_load_hist |
Histogram of the page load time (100 millisecond bins). |
dimension |
|
page_scroll_starts |
page_scroll_starts |
The percentage of page views where a scroll event occurred, expressed as a decimal. |
metric |
|
page_total_time |
page_total_time |
The total amount of time in seconds spent actively on a page across sites. |
metric |
|
page_uniques |
page_uniques |
A count of the number of unique cookies who visited the page. |
metric |
|
page_views |
page_views |
A count of the number of page views. |
metric |
|
page_views_loyal |
page_views_loyal |
The number of pageviews from visitors who visit your site an average of every other day. |
metric |
|
page_views_quality |
page_views_quality |
The number of pageviews that received at least 15 seconds of engaged time. |
metric |
|
pagetype |
pagetype |
The type of page, returned as either Article, LandingPage, or Unknown. |
dimension |
|
pagewidth_hist |
pagewidth_hist |
Width of the page in pixels (50 pixels bins). Useful when analyzing responsive designs. |
dimension |
|
path |
path |
The URL/path of the page. |
dimension |
|
publish_date |
publish_date |
The date that a piece of content on your site was first tracked by Chartbeat. |
dimension |
|
referrer |
referrer |
The referring domain. |
dimension |
|
referrer_type |
referrer_type |
The page referrer type: social, search, direct, internal, and external (aka links). |
dimension |
|
region |
region |
The region the visitor was in (returns states for US) |
dimension |
|
scroll_hist |
scroll_hist |
Histogram of the number of pixels scrolled (100 pixel bins). |
dimension |
|
section |
section |
The section of a page visited. |
dimension |
|
site_experience |
site_experience |
The site experience for the visitor (AMP/Standard). An NA value indicates that the visitor comes from an off-site distribution channel. |
dimension |
|
sponsor |
sponsor |
The sponsor ID. Note that this is only available to domains that are using Paid Content tracking. |
dimension |
|
subdomain |
subdomain |
The specific subdomain (e.g. blog.chartbeat.com, chartbeat.com. |
dimension |
|
subscriber |
subscriber |
The visitor's subscriber status (Guest, Registered, Subscribed, Unspecified). |
dimension |
|
time_hist |
time_hist |
Histogram of active engaged time (15 second bins) |
dimension |
|
title |
title |
Page title. |
dimension |
|
tz_day |
tz_day |
The calendar day in your time zone. |
dimension |
|
tz_hour |
tz_hour |
The hour of the day (0-23) in your time zone. Can be used with Day to get hourly time series. |
dimension |
|
tz_minute |
tz_minute |
The minute in your time zone. Can be used with Hour to get per-minute time series. |
dimension |
|
tz_month |
tz_month |
The month, with day boundaries in your timezone. |
dimension |
|
utc_day |
utc_day |
The calendar day in the UTC time zone. |
dimension |
|
utc_hour |
utc_hour |
The hour of the day (0-23) in the UTC time zone. Can be used with utc_day to get hourly time series. |
dimension |
|
utc_minute |
utc_minute |
The minute in the UTC time zone. Use paired with utc_hour to get per-minute time series. |
dimension |
|
utm_campaign |
utm_campaign |
Identifies a specific promotion/campaign. |
dimension |
|
utm_content |
utm_content |
Identifies what specifically was clicked. |
dimension |
|
utm_medium |
utm_medium |
Identifies the type of link, ‘email’ for example. |
dimension |
|
utm_source |
utm_source |
Identifies to which site a link was posted. |
dimension |
|
utm_term |
utm_term |
Identifies search term/terms. |
dimension |
|
visit_frequency |
visit-frequency |
Returns New, Returning, or Loyal. |
dimension |
|