Element451Integrations Guide

el_metadata_raw

Updated Article

el_metadata_raw Columns#

Distinct Metadata Types#

JSON Keys for Metadata Object#

Sample JSON Objects for Metadata Types#

application

json
{
  "_id": "64f8daa29a1b470bb877",
  "_subdom": "instance",
  "active": false,
  "created_at": "2023-09-06T20:01:38.878000",
  "decision_confirmation": {
    "active": false
  },
  "deposit": {
    "_id": "BZHTXQ2J"
  },
  "description": "Main Application for Freshman, Transfer and Graduate Students",
  "guid": "instance.applications.59520",
  "info_request": [
    "instance.info_request.568"
  ],
  "info_request_items": [
    {
      "index_weight": 0,
      "info_request": "instance.info_request.568",
      "info_request_filters": [],
      "info_request_max": 9999,
      "info_request_min": 0,
      "info_request_name": "Professional Experience Documentation"
    }
  ],
  "name": "Admissions Application",
  "payment": {
    "account": null,
    "active": true,
    "address": null,
    "amount": "1.00",
    "currency": "USD",
    "methods": [],
    "payable_to": null,
    "required_to_submit": false
  },
  "updated_at": "2023-09-06T20:01:39.935000"
}

campus

json
{
  "_id": "64f241291d41290f1907d288",
  "_subdom": "instance",
  "active": true,
  "created_at": "2023-09-01T19:53:13.460000",
  "guid": "instance.campus.2168",
  "location": {
    "address": "1 Glenwood Ave.",
    "city": "Raleigh",
    "country": "US",
    "geo": {
      "latitude": 35.780404,
      "longitude": -78.647929
    },
    "state": "NC",
    "zip": "27603"
  },
  "name": "Home Campus",
  "updated_at": "2023-09-01T19:57:43.524000"
}

communication

json
{
  "_id": "64f935a9b7d30db9611",
  "_subdom": "instance",
  "audience": {
    "segment": "instance.segments.71378",
    "type": "segment"
  },
  "author": "619d6ae64d519b6ffc25",
  "channels": {
    "email": true,
    "sms": false
  },
  "content": {
    "notification": "instance.notifications.98903"
  },
  "created_at": "2023-09-07T02:30:01.303000",
  "guid": "instance.communications.83005",
  "preview_key": "3DEE9C68E0592A3FEA4D7551741",
  "priority": "med",
  "sent_at": null,
  "settings": {
    "bounce_email": "",
    "title": "Chapter Invite-3"
  },
  "started_at": null,
  "status": "draft",
  "type": "dynamic",
  "updated_at": "2023-09-07T02:53:59.941000"
}

data source

json
{
  "_id": "64edfdd7eed3f9083492",
  "_subdom": "instance",
  "active": true,
  "client": "instance",
  "created_at": "2023-08-29T14:16:56.005000",
  "dimensions": [
    {
      "key": "column_1",
      "name": "Name",
      "type": "string"
    },
    {
      "key": "column_2",
      "name": "Value",
      "type": "string"
    }
  ],
  "guid": "instance.data_source.203801",
  "label_field": "column_1",
  "name": "[INSTANCE] Student Types",
  "owner": "instance",
  "settings": [
    {
      "column_1": "Freshman",
      "column_2": "f",
      "id": "FLB9DA9R",
      "index_weight": 1
    },
    {
      "column_1": "Transfer",
      "column_2": "r",
      "id": "B9AJ3QQ2",
      "index_weight": 2
    },
    {
      "column_1": "Graduate",
      "column_2": "gr",
      "id": "4DLMSQXW",
      "index_weight": 3
    },
    {
      "column_1": "Transfer International",
      "column_2": "ti",
      "id": "RHX1QSQC",
      "index_weight": 5
    },
    {
      "column_1": "Freshman International",
      "column_2": "int",
      "id": "6FHBRGHT",
      "index_weight": 4
    }
  ],
  "sortby_field": "index_weight",
  "sortby_order": "ascending",
  "type": "regular",
  "updated_at": "2023-09-05T23:17:07.689000",
  "value_field": "column_2",
  "visible_by": "user"
}

degree

json
{
  "_id": "64f226a43434f600f2ed",
  "_subdom": "instance",
  "active": true,
  "code": "MA",
  "created_at": "2023-09-01T18:00:04.947000",
  "guid": "instance.degrees.4174",
  "name": "Masters of Art",
  "updated_at": "2023-09-01T18:00:04.947000"
}

event

json
{
  "_id": "64f933fd59561082157",
  "_subdom": "instance",
  "allday": false,
  "attendee_limit": 10,
  "created_at": "2023-09-07T02:22:53.455000",
  "date": {
    "end_date": "2023-10-17T00:00:00",
    "end_time": "11:30:00",
    "start_date": "2023-10-17T00:00:00",
    "start_time": "11:00:00",
    "timezone": "America/New_York"
  },
  "event_guid": "instance.events.406413",
  "event_link": null,
  "guest_limit": null,
  "guid": "instance.event_elements.406414",
  "role": "child",
  "type": "simple",
  "updated_at": "2023-09-07T02:22:53.455000"
}

event series

json
{
  "_id": "64ee551b91d3e05b74c",
  "_subdom": "instance",
  "created_at": "2023-08-29T20:29:15.287000",
  "creator": "64b004b03706604e762",
  "description": "series test",
  "guid": "instance.events_series.395",
  "name": "Series Test",
  "privacy": "private",
  "updated_at": "2023-08-29T20:29:15.287000"
}

form

json
{
  "_id": "64f8cc3a99405e4cb01",
  "_subdom": "instance",
  "created_at": "2023-09-06T19:00:10.027000",
  "follow_form": {
    "enabled": false
  },
  "guid": "instance.forms.3576",
  "main_form": {
    "_field": "instance.field.422110"
  },
  "name": "Prospect Gen and Capture Page  - Form",
  "updated_at": "2023-09-06T19:00:10.222000"
}

major

json
{
  "_id": "64f8cfc6475df20c8e8d",
  "_subdom": "instance",
  "code": "phs",
  "created_at": "2023-09-06T19:15:18.969000",
  "guid": "instance.major.135687",
  "name": "Pre-Health Science",
  "updated_at": "2023-09-06T19:15:24.973000"
}

page

json
{
  "_id": "64f8e19f35cc520fda8c",
  "_subdom": "instance",
  "active": false,
  "api_tokens": {
    "analytics": "C7SJUOdPd1LI5Zzdkl8ZmM4GXswjDXb",
    "feature": "lzxNWDv51Yq3L6r0S97VC7qVh"
  },
  "configuration": {
    "description": "University Page",
    "layout": {
      "general": {
        "colors": {
          "link": "#0F77C7",
          "primary": "#5a646f",
          "secondary": "#fe4f00"
        }
      }
    },
    "primary_domain": {
      "domain": "page451.sites.451.io",
      "subdomain": "instance-6802"
    },
    "title": "University Title"
  },
  "created_at": "2023-09-06T20:31:27.010000",
  "guid": "instance.sites.6802",
  "hosts": [],
  "layout": {
    "general": {
      "colors": {
        "link": "#0F77C7",
        "primary": "#5a646f",
        "secondary": "#fe4f00"
      }
    },
    "preview_key": "43103CFA941F59BE270AA918"
  },
  "name": "test",
  "status": "published",
  "type": "page",
  "updated_at": "2023-09-06T20:31:28.676000"
}

segment

json
{
  "_id": "64f947746431bd2821",
  "_subdom": "instance",
  "created_at": "2023-09-07T03:45:56.275000",
  "guid": "instance.segments.71399",
  "is_calculated": false,
  "name": "Enrolled Fall 2025 For App Promotion",
  "owner": "619d64d519b6ffc25",
  "updated_at": "2023-09-07T03:45:56.275000"
}

survey

json
{
  "_id": "65a69dc293b879042b2d",
  "_subdom": "instance",
  "active": true,
  "author_id": "638a10c467228deb1c031e22",
  "created_at": "2024-01-16T15:16:18.756000",
  "description": "",
  "end_date": "2024-08-15T00:00:00",
  "etl_run_id": "4ebfafd7-42cc-ba44-d991c6b83cde",
  "etl_url": "",
  "field_guid": "instance.field.676322",
  "guid": "instance.survey.136",
  "image": {
    "background_color": "#006834",
    "file": null,
    "opacity": 50
  },
  "mode": "one_at_a_time",
  "name": "Alumni Survey",
  "primary_font": {
    "category": "serif",
    "family": "Georgia"
  },
  "secondary_font": null,
  "show_progress_bar": true,
  "shuffle_questions": false,
  "start_date": "2024-01-16T00:00:00",
  "tags": [],
  "template": null,
  "total_responses": 4,
  "unavailable_msg": "This survey is no longer available",
  "updated_at": "2024-02-19T16:52:59.394000",
  "updated_by": "638a10c48deb1c031e22"
}

taxonomy

json
{
  "_id": "64f949d0a9f02deeac90",
  "_subdom": "instance",
  "created_at": "2023-09-07T03:56:00.302000",
  "guid": "instance.taxonomy.2886048",
  "name": "myApp",
  "properties": {
    "name": "myApp"
  },
  "taxonomy": "instance.taxonomy.2013777",
  "type": "term",
  "updated_at": "2023-09-07T03:56:00.302000",
  "value": "instance-my-app-tag"
}

term

json
{
  "_id": "64f8c139cd4ca410fd673",
  "_subdom": "instance",
  "academic_year": null,
  "active": true,
  "code": "F27",
  "created_at": "2023-09-06T18:13:13.111000",
  "end_date": null,
  "guid": "instance.terms.33920",
  "name": "Fall 2027",
  "start_date": null,
  "updated_at": "2023-09-06T18:13:36.635000"
}

workflow

json
{
  "_id": "5ece8f9f6686e7ab0bd",
  "_subdom": "instance",
  "active": true,
  "created_at": "2020-05-27T16:04:47",
  "description": "Assign student to staff.",
  "first_step": "ZUDLK7D",
  "guid": "instance.workflow.6938",
  "has_errored": false,
  "name": "Record Assignment",
  "process_id": null,
  "schedule": null,
  "scheduled_for": null,
  "sort": {
    "based_on": "position",
    "direction": "asc"
  },
  "status": "ready",
  "status_updated_at": null,
  "steps": [],
  "trigger_type": "user",
  "triggers": [],
  "type": "rule",
  "updated_at": "2023-09-06T13:56:32.086000",
  "version": 2
}
el_metadata_raw
0 rows
el_metadata_raw
ColumnData TypeDescription
el_metadata_raw Columns
11 rows
el_metadata_raw Columns
ColumnSQL Data TypeDescription
element_idVARCHARUnique student record identifier associated with the Activity
etl_loaded_atTIMESTAMP_NTZActivity loaded to Snowflake timestamp
_idVARCHARUnique activity identifier
subdomVARCHARPartner school instance identifier
updated_atTIMESTAMP_NTZActivity update timestamp
created_atTIMESTAMP_NTZActivity log created timestamp
deleted_atTIMESTAMP_NTZActivity deleted timestamp
timestampTIMESTAMP_NTZActivity occurrence timestamp
app_idVARCHARAnalytics application identifier
typeVARCHARMetadata document type, shown in next table.
srcVARIANTJSON object of activity properties
Distinct Metadata Types
15 rows
Distinct Metadata Types
NameDescriptionKeys
campusMetadata for a Campus._id, _subdom, active, created_at, guid, location, name, schools, tags, updated_at
eventMetadata for an Event._id, _subdom, allday, attendee_limit, author, categories, content, created_at, date, event_guid, event_link, event_type, featured, guest_limit, guid, privacy, publishing_status, registration_status, role, timezone, type, updated_at
segmentMetadata for a Segment._id, _subdom, created_at, guid, is_calculated, name, owner, updated_at
surveyMetadata for a Survey._id, _subdom, active, author, created_at, description, end_date, guid, image, name, start_date, tags, updated_at, primary_font, mode, shuffle_questions, show_progress_bar, secondary_font, unavaliable_msg, total_responses
pageMetadata for a Page._id, _subdom, active, api_tokens, author, components, configuration, created_at, guid, has_unpublished_updates, hosts, infrastructure, last_deployment_message, last_publication_at, layout, name, status, type, updated_at
majorMetadata for a Major._id, _subdom, code, created_at, guid, name, tags, updated_at
applicationMetadata for an Application._id, _subdom, active, app_base_url, created_at, decision_confirmation, deposit, description, guid, info_request, info_request_items, name, payment, updated_at
degreeMetadata for a Degree._id, _subdom, active, code, created_at, guid, name, tags, updated_at
termMetadata for a Term._id, _subdom, academic_year, active, code, created_at, end_date, guid, name, start_date, tags, updated_at
workflowMetadata for a Workflow._id, _subdom, active, allow_multi_instance, context, created_at, description, enrolled_segments, first_step, folder, guid, has_errored, healed_at, name, process_id, register_action, schedule, scheduled_for, sort, status, status_updated_at, steps, subdom, trigger_type, triggers, type, updated_at, version
data_sourceMetadata for a Data Source._clients, _id, _subdom, active, client, code, collection, created_at, default, dimensions, guid, label_field, name, order, owner, parameters, settings, sortby_field, sortby_order, subdom, type, updated_at, value_field, visible_by
formMetadata for a Form._id, _subdom, created_at, follow_form, guid, main_form, name, updated_at
communicationMetadata for a email or SMS Campaign communication._id, _subdom, ab_winner, audience, author, channels, content, created_at, first_sent_at, folder, guid, preview_key, priority, reserved_at, sending_at, sent, sent_at, sent_by, settings, started_at, status, tags, type, updated_at
event_seriesMetadata for an Event series._id, _subdom, created_at, creator, description, guid, image, name, privacy, series, updated_at
taxonomyMetadata for a Taxonomy._id, _subdom, created_at, guid, name, properties, taxonomy, type, updated_at, value
JSON Keys for Metadata Object
108 rows
JSON Keys for Metadata Object
DescriptionApplies toData TypeKey
Timestamp for when the communication will be sent.communicationSTRING (TIMESTAMP)sending_at
An array of objects that identify the events within an event series.event_seriesARRAYseries
Identifier for the Element451 user that created the particular object.event, communication, page, surveySTRINGauthor
Array of tag taxonomy identifiers for the particular object.communication, term, campus, major, degree, surveyARRAYtags
Object containing information about the event's date and time, including 'end_date', 'end_time', 'start_date', 'start_time', and 'timezone'.eventOBJECTdate
Identifier for who can see the data source.data_sourceSTRINGvisible_by
For communication, object with additional settings of the communication. For data source, an array of the rows of the data source.data_source, communicationOBJECTsettings
Sorting order for the data source (i.e. 'ascending').data_sourceSTRINGsortby_order
Indicates the subdomain related to the item's instance.data_source, workflowSTRINGsubdom
Indicates if Segment is continuously calculated or not.segmentBOOLEANis_calculated
Reference to the image associated with the event series.event_series, surveyOBJECTimage
Identifier for the associated process.workflowSTRINGprocess_id
Indicates whether the event is an all-day event.eventBOOLEANallday
Field used as the label (what is displayed in the Element451 interface) from the data source.data_sourceSTRINGlabel_field
Identifier for the Element451 instance that owns the particular object.data_source, segmentSTRINGowner
Code (value) associated with the particular data object.data_source, term, major, degreeSTRINGcode
Unique identifier for the data object.taxonomy, event, term, communication, page, workflow, data_source, application, event_series, major, degree, campus, form, segment, surveySTRING_id
eventcategories
Identifier of the Element451 user that created the Event Seriesevent_seriesSTRINGcreator
Value associated with the taxonomy.taxonomySTRINGvalue
Link to the event.eventSTRINGevent_link
Timestamp for when the ongoing communication was started.communicationSTRING (TIMESTAMP)started_at
Type of trigger for the Workflow Rule (i.e., "user" and "triggered").workflowSTRINGtrigger_type
Timestamp for when the instance was created.data_source, taxonomy, event_series, major, degree, workflow, event, term, communication, page, application, form, segment, campus, surveySTRING (TIMESTAMP)created_at
Timestamp for when the communication was sent.communicationSTRING (TIMESTAMP)sent_at
Timezone that the event takes place in.eventSTRINGtimezone
Array of objects, referencing the Segments that are enrolled in the workflow.workflowARRAYenrolled_segments
Limit on the number of guestseventINTEGERguest_limit
Object containing information about the follow-up form, including whether it is enabled.formOBJECTfollow_form
Version of the workflow build.workflowSTRINGversion
Category of how the survey questions are administered. Options: linear, one_at_a_timesurveySTRINGmode
Priority level of the communication.communicationSTRINGpriority
Globally unique identifier for the event.eventSTRINGevent_guid
Object containing the metadata of the Page components.pageOBJECTcomponents
Limit on the number of attendees for the event (e.g., 10).eventINTEGERattendee_limit
Object containing information about the main form, including a reference to a field configuration GUID.formOBJECTmain_form
Schedule details for the Workflow Rule.workflowOBJECTschedule
Reference to what database collection the default data_source is created by.data_sourceSTRINGcollection
communicationSTRING (TIMESTAMP)reserved_at
Timestamp for when the Workflow Rule is scheduled to runworkflowSTRING (TIMESTAMP)scheduled_for
applicationapp_base_url
Identifier of the campaign variant that won the AB test.communicationSTRINGab_winner
Indicates whether the particular object is active.data_source, degree, page, term, workflow, application, campus, surveyBOOLEANactive
Indicates that the event is featured.eventBOOLEANfeatured
data_sourcedefault
Array of workflow step objects, each containing information about actions, delays, descriptions, filters, and more.workflowARRAYsteps
Array of hostspageARRAYhosts
Date that the workflow was healed.workflowSTRING (TIMESTAMP)healed_at
Reference to the action that registers a student in a workflow.workflowSTRINGregister_action
Globally unique identifier for the object.event, term, communication, page, data_source, application, taxonomy, degree, event_series, major, campus, workflow, form, segment, surveySTRINGguid
Reference to the folder containing the item.workflow, communicationSTRINGfolder
Field used for sorting the data source.data_sourceSTRINGsortby_field
Indicates if the event or series is visible to visitors to the Event site.event_series, eventSTRINGprivacy
Type identifier for the particular object.data_source, workflow, taxonomy, communication, event, pageSTRINGtype
Object containing properties related to the taxonomy, such as 'name'.taxonomyOBJECTproperties
End date of the term, usually the last day of classes.term, surveyend_date
Object containing layout details, including 'general' with 'colors' and 'preview_key'.pageOBJECTlayout
Count of total responses to a survey.surveyINTEGERtotal_responses
Indicates what field the Element UI will use to order data source items.data_sourceOBJECTorder
Identifier for the associated taxonomytaxonomySTRINGtaxonomy
User-assigned name of the particular object.data_source, workflow, taxonomy, page, term, major, degree, event_series, segment, form, application, campus, surveySTRINGname
Object containing information about the campus location.campusOBJECTlocation
User-assigned description of the particular object.event_series, workflow, application, surveySTRINGdescription
Object containing API tokens for the Page.pageOBJECTapi_tokens
Indicates what infrastructure the Page is built on (i.e. "sparknet")pageSTRINGinfrastructure
Reference to the subdomain owner instance of the data_source.data_sourceSTRINGclient
Publish status of an event.eventSTRINGpublishing_status
Reference to data_source owner.data_sourceARRAY_clients
Timestamp for when the instance was last updated.taxonomy, term, communication, event, page, data_source, application, workflow, event_series, major, degree, campus, form, segment, surveySTRING (TIMESTAMP)updated_at
Object containing the user-created content of the particular object.event, communicationOBJECTcontent
Object containing payment-related information.applicationOBJECTpayment
Timestamp for when the workflow status was last updated.workflowSTRING (TIMESTAMP)status_updated_at
Array of items listing the schools associated with a particular campus.campusARRAYschools
Object with references to the event that triggered the workflow. Specific to event registration autoresponders.workflowOBJECTcontext
Array of triggers, each containing information about actions, parameters, and trigger status.workflowARRAYtriggers
Role of the event, such as 'parent' or 'child'eventSTRINGrole
Key used for previewing the communication.communicationSTRINGpreview_key
Object indicating which communication channels are enabled such as 'email' and 'sms'.communicationOBJECTchannels
Object of conditions for how reference data sources are filtered.data_sourceOBJECTparameters
Academic year associated with the term.termSTRINGacademic_year
Attributes of the secondary font of the survey.surveyOBJECTsecondary_font
Current status of the particular object, such as 'active' or 'inactive'.workflow, page, communicationSTRINGstatus
Object containing information about the target audience, such as the Segment GUID.communicationOBJECTaudience
Message shown to user when survey is unavaliable.surveySTRINGunavaliable_msg
An array of information request IDs related to the instance.applicationARRAYinfo_request
Boolean indicating if the survey will shuffle questions.surveyBOOLEANshuffle_questions
Array of objects containing information about data source dimensions. Dimensions are the columns of the data source.data_sourceARRAYdimensions
workflowallow_multi_instance
Attributes of the primary font of a survey.surveyOBJECTprimary_font
Indicator if the communication has been sent or not.communicationBOOLEANsent
Field used as the value from the dimensions. This is what is stored on the student record in the data base.data_sourceSTRINGvalue_field
Object containing configuration details for the Page, including 'description', 'layout', 'primary_domain', and 'title'.pageOBJECTconfiguration
Object containing sorting information for the workflow, including 'based_on' and 'direction'.workflowOBJECTsort
Nested object for application decision confirmation.applicationOBJECTdecision_confirmation
Indicates whether the workflow has encountered errors.workflowBOOLEANhas_errored
Indicates if the event is open or closed.eventSTRINGregistration_status
Indicator of Page deployment, such as "Deployment completed" and "Unpublishing completed"pageSTRINGlast_deployment_message
The Element ID of the internal user that sent the communication.communicationSTRINGsent_by
An array of objects containing information about specific request items.applicationARRAYinfo_request_items
Indicator if the survey will show a progress bar to the user.surveyBOOLEANshow_progress_bar
Identifier for the first step of the workflow.workflowSTRINGfirst_step
Date of when Page was last publishedpageSTRING (TIMESTAMP)last_publication_at
The event "type" of the event.eventSTRINGevent_type
Date that the campaign was first sent.communicationSTRING (TIMESTAMP)first_sent_at
Indicates that page has a draft, or unpublished changes.pageBOOLEANhas_unpublished_updates
Object relating application to deposit.applicationOBJECTdeposit
Start date of the term, usually the first day of classes.term, surveySTRING (TIMESTAMP)start_date
Indicates the subdomain related to a given instance.taxonomy, event, term, communication, page, workflow, data_source, application, event_series, major, degree, campus, form, segment, surveySTRING_subdom