Skip to main content

How can we help?

Search

Widget Parameters

Updated: Andy at Concept3D Edited:

Widget Parameters

These are additional parameters that can be used for the Widget, in addition to those available on the Widget builder.

 

Parameter Details

  • Each parameter should be passed in as standard parameter in the Widget URL.
  • Parameters marked as array can be specified as:
    • Array parameter (example: venues[]=1&venues[]=2 )
    • Comma separated values (venues=1,2 )
  • Two forms cannot be mixed.
  • Boolean parameters are true for values of 1, y, yes, true. In many cases, the presence of the parameter is all that is required.
  • When in doubt, don’t include false parameters.

 

Filter Parameters

Parameter Description Type Default
num number of events to return number 10
days number of days in the future (1-365) HEADS UP: If you'd like to create a past events Widget, you'll add - to indicate how many days in the past you'd like to pull from. For example, days=-30. number 7
start date the Widget should start (YYYY-MM-DD) date today
venues only return events at these venues (ID or username) array none
school only return events assigned to these schools (ID or username) array platform specific
campuses only return events assigned to these campuses (ID or username) array platform specific
groups only return events assigned to these Groups array none
departments only return events assigned to these Departments array none
skip_recurring do not include recurring events boolean FALSE
all_instances show all instances of recurring events (instead of only the next instance) boolean FALSE
picks only include events flagged as Featured boolean FALSE
sponsored only include events flagged as Sponsored boolean FALSE
tags return events with any of these Tags or Keywords array (string) none
types return events with any of these Filter values array (type ID) none
exclude_types exclude events matching these Filter values array (type ID) none
match_all controls matching requirements for Tags/Filters:
  • Not set (default): matches events that have at least one of the listed Tags/Filters.
  • All: matches events that have all listed Tags/Filters.
  • Any: matches events that have at least one of the listed Tags/Filters
 array (string) none
sort sort events by the 'Trending' algorithm array chronological

 

Output Parameters

Parameter Description Type Default
hidedesc hide descriptions boolean FALSE
hideimage hide images boolean FALSE
image_size returns:
  • tiny (20x20)
  • small (50x50)
  • medium (80x80)
  • big (200x150)
  • big_square (200x200)
  • big_300 (300x225)
  • square_300 (300x300)
  • original (original size of uploaded photo)
 array (string) small
show_keywords show Keywords assigned to events boolean FALSE
show_times show event start times boolean TRUE
show_year show the year of the event date boolean FALSE
show_types show Event Type Filters below the event description boolean FALSE
style suppress default style array (string) none
target_blank opens event and venue links in a new window boolean none
html_descriptions output the raw HTML in event descriptions boolean FALSE
format=rss convert to RSS feed HTML

Related articles