The tables below list the fields standard to the views provided in Tableau. Tableau's data fields are populated from the analytics collected in the EchoInk Platform. Each field is automatically assigned a data type (such as integer, string, date) and a role: Dimension or Fact.
Dimensions
Dimensions contain qualitative values (such as names, dates, or geographical data). You can use dimensions to categorize, segment, and reveal the details in your data. Dimensions affect the level of detail in the view.
revision
Field
Type
Description
id
UUID
Unique identifier for an Inkdoc's specific revision
inkdoc_id
UUID
Id value for the specific Inkdoc
commit
Integer
SVN commit number that corresponds to the Inkdoc version
publish_revision
Integer
Published build number of the Inkdoc
author
String
Name of the Inkdoc's author
title
String
Name of the Inkdoc
project_id
UUID
Unique identifier to the associated Habitat project
chapter
Field
Type
Description
id
UUID
Unique identifier for an Inkdoc's specific chapter version
commit
Integer
Revision commit number that corresponds to the
chapter
version
content_id
UUID
Chapter id as recorded in the Inkdoc's TOC
designation
String
Designation value for the chapter
enumeration
String
Enumeration value for the chapter
title
String
Name of the Chapter
device
Field
Type
Description
id
UUID
Unique identifier for each device type
os
String
Operating system for the user's device
form_factor
String
Type of device browser used:
Mobile: Includes both mobile app and mobile web browsers
Desktop: Includes desktop browsers
model
String
Device model, if using the EchoInk app
vendor
String
Device manufacturer, if using the EchoInk app
browser
Boolean
True for browsers (desktop and mobile web), false
for mobile
app users
device_family
String
Type of physical device used:
Phone
Tablet
Desktop
page
Field
Type
Description
id
UUID
Unique identifier for an Inkdoc's specific page version
commit
Integer
Revision commit number that corresponds to the page version
path
String
Folder path of the page in SVN
content_id
String
Page id as recorded in the Inkdoc's TOC
designation
String
Page designation in the Inkdoc's TOC
enumeration
String
Page enumeration in the Inkdoc's TOC
title
String
Page title from the Inkdoc's TOC
site
Field
Type
Description
id
UUID
Unique identifier for a site
created_at
datetime
Time the site was created
updated_at
datetime
Time the site was created
slug
String
Base URL of the site (e.g., https://[slug].read.inkling.com/read)
name
String
Name of the site
user
Field
Type
Description
id
UUID
Unique identifier for a user
first_name
String
First name of the user
last_name
String
First name of the user
email
String
Email address of the user, if available
username
String
Username for the user
external_id
String
Unique ID for a user in their organization's system
active
Boolean
True for active, False for inactive
habitat_user
Boolean
True for Habitat access, False if no Habitat access
user_attributes
Field
Type
Description
id
UUID
Unique identifier for a user
updated_at
datetime
Time the latest user attribute was updated
{custom attributes}
String
Specific custom attributes within this field
are
exposed as another
table using a view
assessment
Field
Type
Description
id
UUID
Unique identifier for the assessment widget for
a
given page
min
Integer
The minimum score of the widget at time of publish
max
Integer
The maximum score of the widget at time of publish
content_id
UUID
Author provided assessment id
name
String
Author provided assessment name
Facts (Measures)
Facts contain numeric, quantitative values that you can measure. Facts can be aggregated. When you drag a fact into the view, Tableau applies an aggregation to that fact (by default).
assessment_result
Field
Type
Description
id
UUID
Unique identifier for the assessment widget for
a
given page
date
Integer
Date the assessment was submitted
user_id
UUID
Unique identifier for the user's account
device_id
UUID
Unique identifier for the user's device
site_id
UUID
Unique identifier for the site on which the user
accessed the
assessment
revision_id
UUID
Unique identifier for an Inkdoc's specific revision
page_id
UUID
Unique identifier for the page on which the assessment
is present
chapter_id
UUID
Unique identifier for the chapter in which the
assessment
is
present
passed
Boolean
True if the assessment was Passed, False if Failed
score
Integer
The number of answers the user answered correctly
answer_{n}
String
1 if the user got the answer correct, 0 if the
user
did not.
Null if there was not a question. For example:
An
assessment
with two questions would have answer_1 and answer_2
but not answer_3
through answer_30
additional_info
JSON
A JSON blob containing any additional information
collected from
the assessment result
page_view
Field
Type
Description
id
UUID
Unique identifier for the page view event
date_from
datetime
Date that the event started
date_to
datetime
Date that the event ended
user_id
UUID
Unique identifier for a user's account
device_id
UUID
Unique identifier for the user's device type
site_id
UUID
Unique identifier for the site on which the user
accessed the
page
book_id
UUID
Unique identifier for a specific Inkdoc
project_id
UUID
Unique identifier for a specific Habitat project
page_id
UUID
Unique identifier for the page viewed
chapter_id
UUID
Unique identifier for the chapter in which the
page
is located
short_name
UUID
The Inkdoc's Habitat shortname
min_scroll
Decimal
Minimum scroll percentage on the page
max_scroll
Decimal
Maximum scroll percentage on the page
duration
Integer
Amount of time in seconds that the user was on the page
exhibit_id
UUID
Unique identifier for an exhibit on the page
exhibit_path
String
Folder path of the exhibit or page in SVN
event_count
Integer
Amount of raw events collected on a single page view
reading_sessions
Field
Type
Description
id
UUID
Unique identifier for a user's reading session
device_id
UUID
Unique identifier for the user's device type
start
datetime
Start time for the user's reading session
end
datetime
End time for the user's reading session
user_id
UUID
Unique identifier for a user's account
site_id
UUID
Unique identifier for the site on which a user has
completed
a reading session
num_pages
Integer
Total number of pages visited across Inkdocs accessed
by a user
during a reading session
num_titles
Integer
Total number of Inkdocs opened by a user during a
reading session