Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[workspace_id]

[Workspace Id]

Unique ID of a workspace

[workspace_name]

[Workspace Name]

Workspace name

[workspace_created_at]

[Workspace Created At]

Timestamp at which the workspace was created

Timezone is UTC. Returns as Unix epoch time

[workspace_updated_at]

[Workspace Updated At]

Timestamp at which the workspace was updated

Timezone is UTC. Returns as Unix epoch time

[workspace_deleted_at]

[Workspace Deleted At]

Timestamp at which the workspace was deleted

Timezone is UTC. Returns as Unix epoch time

[guide_id]

[Guide Id]

Unique ID of a guide

[guide_title]

[Guide Title]

Title of the guide in its default language

[guide_created_at]

[Guide Created At]

Timestamp at which the guide was created

Timezone is UTC. Returns as Unix epoch time

[guide_updated_at]

[Guide Updated At]

Timestamp at which the guide was updated

Timezone is UTC. Returns as Unix epoch time

[guide_archived]

[Guide Archived]

Flag indicating whether or not a guide is archived

[guide_publish_status]

[Guide Publish Status]

Publish status of a guide

[guide_first_published_at]

[Guide First Published At]

Timestamp at which the guide was first published

Timezone is UTC. Returns as Unix epoch time

[guide_last_published_at]

[Guide Last Published At]

Timestamp at which the guide was most recently published

Timezone is UTC. Returns as Unix epoch time

[ai_generated]

[Ai Generated]

Flag indicating whether or not a guide was AI-generated

[guide_copied_from]

[Guide Copied From]

Guide Id of the parent guide, if this guide was created as a copy

[topic_id]

[Topic Id]

Unique ID of a topic

[topic_title]

[Topic Title]

Title of the topic in its default language

[topic_position]

[Topic Position]

Position of a topic within a guide. Zero indexed

[topic_created_at]

[Topic Created At]

Timestamp at which the topic was created

Timezone is UTC. Returns as Unix epoch time

[topic_updated_at]

[Topic Updated At]

Timestamp at which the topic was updated

Timezone is UTC. Returns as Unix epoch time

[topic_archived]

[Topic Archived]

Flag indicating whether or not a topic is archived

[topic_visible]

[Topic Visible]

Flag indicating whether or not a topic is visible

[instruction_id]

[Instruction Id]

Unique ID of an instruction

[instruction_title]

[Instruction Title]

Title of the instruction in its default language

[instruction_position]

[Instruction Position]

Position of an instruction within a topic. Zero indexed

[instruction_type]

[Instruction Type]

Indicates whether the instruction is a checklist or normal instruction

[instruction_created_at]

[Instruction Created At]

Timestamp at which the instruction was created

Timezone is UTC. Returns as Unix epoch time

[instruction_updated_at]

[Instruction Updated At]

Timestamp at which the instruction was updated

Timezone is UTC. Returns as Unix epoch time

[instruction_archived]

[Instruction Archived]

Flag indicating whether or not an instruction is archived

[instruction_publish_status]

[Instruction Publish Status]

Publish status of an instruction

[step_id]

[Step Id]

Unique ID of a step

[step_text]

[Step Text]

Text of the step in its default language

Formatting may vary slightly from SwipeGuide platform due differences in html decoding

[step_position]

[Step Position]

Position of a step within an instruction. Zero indexed

[step_created_at]

[Step Created At]

Timestamp at which the step was created

Timezone is UTC. Returns as Unix epoch time

[step_updated_at]

[Step Updated At]

Timestamp at which the step was updated

Timezone is UTC. Returns as Unix epoch time

[step_archived]

[Step Archived]

Flag indicating whether or not a step is archived

[assigned_team_id]

[Assigned Team Id]

Unique ID of the team that is assigned to a guide

[assigned_team_name]

[Assigned Team Name]

Name of the team assigned to a guide

[parent_id]

[Parent Id]

ID of the parent of feedback and/or tag

Parent can be a guide, instruction, or step. Hierarchy level flag indicates which level of hierarchy it is related to.

[url]

[URL]

URL of the content item in the viewer platform

[events_join_key]

[Events Join Key]

Key used for joining the Events source data to its relevant content

[pagination_timestamp]

[Pagination Timestamp]

Timestamp indicating the most recent timestamp per row

Used for page sorting during API calls. At finest level of content detail per row in underlying table. In case of querying at higher level of detail than [Step Id], it may be best to choose a different timestamp for pagination reference. Otherwise duplicate rows may be retrieved.

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[event_id]

[Event Id]

Unique ID of the event

[event_timestamp]

[Event Timestamp]

Timestamp at which the event was created

Indicates the starting time of a page view. Timezone is UTC. Returns as Unix epoch time

[event_user_id]

[Event User Id]

Unique ID of the user linked to the event

Only available for users signing in with SSO or with email and password

[user_session_id]

[User Session Id]

Unique ID of the user session

A session is defined as continuous activity by a single user with no breaks of >30 minutes

[event_duration]

[Event Duration]

Duration of time spent per page view event in seconds

Calculated as the difference between the starting timestamps of two back-to-back page views within the same user session

[content_join_key]

[Content Join Key]

Foreign key for joining to Content table

[check_answer_id]

[Check Answer Id]

ID of check answer

Only applicable when event was created during a checklist submission

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[tag_id]

[Tag Id]

Unique ID of the tag

[tag_title]

[Tag Title]

Title of the tag in its default language

[tag_created_at]

[Tag Created At]

Timestamp at which the tag was created

Timezone is UTC. Returns as Unix epoch time

[tag_updated_at]

[Tag Updated At]

Timestamp at which the tag was updated

Timezone is UTC. Returns as Unix epoch time

[tag_is_archived]

[Tag Is Archived]

Flag indicating whether or not a tag is archived

[tag_content]

[Tag Content]

Tag titles in all available languages

JSON with locale & title stored as key:value pairs

[tag_default_locale]

[Tag Default Locale]

Default locale & language of the tag

[parent_id]

[Parent Id]

ID of the content item that a tag is linked to

[parent_type]

[Parent Type]

Type of content of the parent (example: Guide, Instruction, or Skill)

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

[feedback_id]

[Feedback Id]

Unique ID of the feedback item

[feedback_text]

[Feedback Text]

Text of the feedback

[feedback_created_at]

[Feedback Created At]

Timestamp at which the feedback item was created

[feedback_updated_at]

[Feedback Updated At]

Timestamp at which the feedback item was updated

[parent_id]

[Parent ID]

ID of the content item that a tag is linked to

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[workspace_id]

[Workspace Id]

Unique ID of a workspace

[workspace_name]

[Workspace Name]

Workspace name

[guide_id]

[Guide Id]

Unique ID of a guide

[guide_title]

[Guide Title]

Title of the guide in its default language

[checklist_id]

[Checklist Id]

Unique ID of a checklist

[checklist_title]

[Checklist Title]

Title of the checklist in its default language

[template_id]

[Template Id]

Unique ID of the checklist template

[template_type]

[Template Type]

Type of checklist template

[check_id]

[Check Id]

Unique ID of a checklist

A check in a checklist is hierarchically equivalent to a step in an instruction

[check_position]

[Check Position]

Position of a check within a checklist. Zero indexed

[check_text]

[Check Text]

Text of a check in its default language

Equivalent to 'step text' in the Content table

[assigned_team_id]

[Assigned Team Id]

Unique ID of the team that is assigned to a guide

[assigned_team_name]

[Assigned Team Name]

Name of the team assigned to a guide

[checklist_answer_id]

[Checklist Answer Id]

Unique ID of the checklist answer

This is for the answer for the entire checklist

[check_answer_id]

[Check Answer Id]

Unique ID of the check answer

A check is one component of a checklist. This ID is for the answer to a particular check rather than the entire checklist

[check_answer_value]

[Check Answer Value]

Value of an individual check response that uses default "BINARY" type checklist template

TRUE/FALSE. Only applies to default "BINARY" type checklists

[check_answer_template_value]

[Check Answer Template Value]

Value of an individual check response that uses any checklist template

Value applies to all checklist template types

[check_answer_template_score]

[Check Answer Template Score]

Score of an individual check response according to checklist template

[check_feedback]

[Check Feedback]

Feedback for an individual check

[check_answer_media_url]

[Check Answer Media Url]

URL to image or video shared with check answer

[answer_created_at]

[Answer Created At]

Timestamp at which the checklist answer was created

Timezone is UTC. Returns as Unix epoch time

[checklist_user_id]

[Checklist User Id]

ID of the user who answered a checklist

Only available for users signing in with SSO or with email and password

[checklist_user_name]

[Checklist User Name]

User inputted name when they submit a checklist

[percent_checklist_passed]

[Percent Checklist Passed]

Percentage of checks in a checklist answer with a value of "true"

Returns the same value for all rows with the same Checklist Answer Id

[pagination_timestamp]

[Pagination Timestamp]

Timestamp indicating the most recent timestamp per row

Used for page sorting during API calls. At finest level of content detail per row in underlying table. In case of querying at higher level of detail than [Check Id], it may be best to choose a different timestamp for pagination reference. Otherwise duplicate rows may be retrieved.

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[workspace_id]

[Workspace Id]

Unique ID of a workspace

[workspace_name]

[Workspace Name]

Workspace name

[guide_id]

[Guide Id]

Unique ID of a guide

[guide_title]

[Guide Title]

Title of the guide in its default language

[topic_id]

[Topic Id]

Unique ID of a topic

[instruction_id]

[Instruction Id]

Unique ID of an instruction

[instruction_title]

[Instruction Title]

Title of the instruction in its default language

[assigned_team_id]

[Assigned Team Id]

Unique ID of the team that is assigned to a guide

[assigned_team_name]

[Assigned Team Name]

Name of the team assigned to a guide

[signoff_id]

[Signoff Id]

Unique ID of sign-off

[signoff_title]

[Signoff Title]

Title of sign-off

[signoff_publish_status]

[Signoff Publish Status]

Publish status of a sign-off

[signoff_default_locale]

[Signoff Default Locale]

Default language for the sign-off

[signoff_assigned_team_id]

[Signoff Assigned Team Id]

Unique ID of the team assigned to the sign-off

[signoff_created_at]

[Signoff Created At]

Timestamp at which the sign-off was created

Timezone is UTC. Returns as Unix epoch time

[signoff_updated_at]

[Signoff Updated At]

Timestamp at which the sign-off was updated

Timezone is UTC. Returns as Unix epoch time

[signoff_result_text]

[Signoff Result Text]

Value of the sign-off result

Number indicating the value of the sign-off result. Meaning depends on the Sign-off Question Type. Final "translated" result found in [Signoff Result Value] field

[signoff_follow_up_result]

[Signoff Follow Up Result]

Value of the follow-up question result

User inputted answer to follow-up question

[signoff_result_id]

[Signoff Result Id]

Unique ID of the sign-off result

[signoff_question_type]

[Signoff Question Type]

Type of sign-off question

Options include text, star, etc.

[user_platform_locale]

[User Platform Locale]

[signoff_result_user_id]

[Signoff Result User Id]

ID of the user who submitted the sign-off result

Only available for users signing in with SSO or with email and password

[signoff_result_user_name]

[Signoff Result User Name]

Name of the user who submitted the sign-off result

This is a user submitted response

[signoff_guide_version_id]

[Signoff Guide Version Id]

ID of the guide version that the sign-off was attached to upon result submission

[signoff_result_created_at]

[Signoff Result Created At]

Timestamp at which the sign-off result was submitted

Timezone is UTC. Returns as Unix epoch time

[signoff_question_updated_at]

[Signoff Question Updated At]

Timestamp at which the sign-off question was last updated

Timezone is UTC. Returns as Unix epoch time

[number_of_ratings]

[Number of Ratings]

Number of rating options available for the user to answer from

For example, a "Star" question could offer 3 stars to choose from, hence 3 rating options

[text_type_options]

[Text Type Options]

In case of TEXT question, the selection options are listed here

[follow_up_type]

[Follow Up Type]

Type of follow-up question

[follow_up_default_text]

[Follow Up Default Text]

Follow up text in its default language

[signoff_result_value]

[Signoff Result Value]

Sign-off result value

Translated to match the type of question. In case of TEXT type, the option selected in shown here. In case of YES/NO type, Yes or No is shown here. In case of PASS/FAIL type, Pass or Fail is shown here. In case of STAR or NUMBER type, the number of the rating is shown here.

[question_default_text]

[Question Default Text]

Sign-off question text in its default language

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

[workspace_id]

[Workspace Id]

Unique ID of a workspace

[workspace_name]

[Workspace Name]

Workspace name

[team_id]

[Team Id]

Unique ID of a team

[team_name]

[Team Name]

Team name

[team_deleted_at]

[Team Deleted At]

Timestamp at which the team was deleted

[parent_team_id]

[Parent Team Id]

ID of the parent team when team hierarchy is in place

[user_id]

[User Id]

Unique ID of a user

[user_role]

[User Role]

Role of the user

[user_name]

[User Name]

Name of the user

[email]

[Email]

Email address of the user

[user_is_disabled]

[User Is Disabled]

Flag indicating whether or not a user is disabled

[sso_id]

[Sso Id]

SSO ID of user

[last_login_at]

[Last Login At]

Timestamp at which the user last logged in

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[team_id]

[Team Id]

Unique ID of a team

VARCHAR

[team_name]

[Team Name]

Team name

VARCHAR

[user_id]

[User Id]

Unique ID of a user

VARCHAR

[email]

[Email]

Email address of the user

VARCHAR

[job_title_id]

[Job Title Id]

Unique ID of a job title

VARCHAR

[job_title_name]

[Job Title Name]

Job title name

VARCHAR

[job_title_created_at]

[Job Title Created At]

Timestamp at which a job title was created

Number representing Unix epoch time. Timezone is UTC

[skill_profile_id]

[Skill Profile Id]

Unique ID of a skill profile

VARCHAR

[skill_profile_name]

[Skill Profile Name]

Skill profile name

VARCHAR

[skill_profile_created_at]

[Skill Profile Created At]

Timestamp at which a skill profile was created

Number representing Unix epoch time. Timezone is UTC

[skill_profile_required_level_id]

[Skill Profile Required Level Id]

Required level of a skill profile for a particular skill

VARCHAR

[skill_profile_required_level_position]

[Skill Profile Required Level Position]

Numeric position of a skill level needed for a particular skill within a skill profile

INT

[skill_id]

[Skill Id]

Unique ID of a skill

VARCHAR

[skill_name]

[Skill Name]

Skill name

VARCHAR

[skill_created_at]

[Skill Created At]

Timestamp at which a skill was created

Number representing Unix epoch time. Timezone is UTC

[skill_expiration_months]

[Skill Expiration Months]

Number of months after which a skill expires

INT

[learning_activity_id]

[Learning Activity Id]

Unique ID of a learning activity

VARCHAR

[learning_activity_title]

[Learning Activity Title]

Title of a learning activity

VARCHAR

[learning_activity_created_at]

[Learning Activity Created At]

Timestamp at which a learning activity was created

Number representing Unix epoch time. Timezone is UTC

[user_skill_id]

[User Skill Id]

Unique ID of a user skill, a skill tied to a particular user

VARCHAR

[user_required_level_position]

[User Required Level Position]

Numeric position of a skill level needed for a particular skill for a user

INT

[user_skill_status]

[User Skill Status]

Status of a user skill

VARCHAR

[user_skill_is_approved]

[User Skill Is Approved]

Indicates whether or not a user skill is currently approved based on the user’s current skill level and required skill level

VARCHAR

[user_skill_started_at]

[User Skill Started At]

Timestamp at which a user skill was started

Number representing Unix epoch time. Timezone is UTC

[user_skill_approved_at]

[User Skill Approved At]

Timestamp at which a user skill was approved

Number representing Unix epoch time. Timezone is UTC

[user_skill_admin_url]

[User Skill Admin Url]

Admin URL of a user skill

VARCHAR

[user_learning_activity_id]

[User Learning Activity Id]

Unique ID of a user learning activity, a learning activity tied to a particular user

VARCHAR

[user_learning_activity_status]

[User Learning Activity Status]

Status of a user learning activity

VARCHAR

[learning_journey_item_id]

[Learning Journey Item Id]

Unique ID of a learning journey item

VARCHAR

[learning_journey_item_position]

[Learning Journey Item Position]

Numeric position of a learning journey item

INT

[learning_journey_item_due_date]

[Learning Journey Item Due Date]

Due date for a learning journey item

Number representing Unix epoch time. Timezone is UTC

[assessed_skill_level_position]

[Assessed Skill Level Position]

Numeric position of a skill level as assessed for a particular user skill

INT

[assessment_notification_id]

[Assessment Notification Id]

Unique ID of a notification sent to indicate an assessment

VARCHAR

[assessment_notification_skill_level_name]

[Assessment Notification Skill Level Name]

Skill level name associated with an assessment notification

VARCHAR

[assessment_notification_type]

[Assessment Notification Type]

Type of assessmenet notification

VARCHAR

[assessment_notification_created_at]

[Assessment Notification Created At]

Timestamp at which an assessment notification was created

Number representing Unix epoch time. Timezone is UTC

[self_assessment_certificate_id]

[Self Assessment Certificate Id]

Unique ID of a self assessment certificate upload

VARCHAR

[self_assessment_certificate_created_at]

[Self Assessment Certificate Created At]

Timestamp at which a self assessment certificate was uploaded

Number representing Unix epoch time. Timezone is UTC

Field Name

"Pretty" Field Name (only available in synchronous version of Data API)

Description

Notes

[event_id]

[Event Id]

Unique ID of an event

[event_type]

[Event Type]

Type of event

[created_at]

[Created At]

Timestamp at which the event was created

Timezone is UTC. Returns as Unix epoch time

[user_id]

[User Id]

Unique ID of the user who initiated the event

[guide_id]

[Guide Id]

Unique ID of a guide

[parent_guide_id]

[Parent Guide Id]

Guide Id of the parent guide, if this guide was created as a copy

[version_id]

[Version Id]

ID of the guide version

[new_assignee_id]

[New Assignee Id]

ID of the user that a guide is reassigned to

Only applies in case of guide reassignment

[workspace_ids]

[Workspace Ids]

IDs of the workspaces this event applied to

Returns a JSON that can contain multiple workspace IDs

[metadata_1]

[Metadata 1]

Supplimentary data dependant on the event type

Returns a JSON that can contain multiple key/value pairs for additional details about the event

[metadata_2]

[Metadata 2]

Supplimentary data dependant on the event type

Returns a JSON that can contain multiple key/value pairs for additional details about the event