Source Providers

Each Essentials multi-instance source relies on a provider that manages the source instances and workflow. To learn more about sources, refer to the corresponding documentation.

Airtable Source

The Airtable Source feeds data from Airtable bases supporting Record and Records queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Airtable Account which to authenticate with.
Base	The Airtable base which to retrieve the data from.
Table	The Airtable base table which data to create the source with.

Airtable Record Query

Fetches a single record from an Airtable base and resolves to Airtable Record Type.

Setting	Description	Default	Dynamic
Record ID	The ID of the record to query.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Airtable Records Query

Fetches records from an Airtable base and resolves to a list of Airtable Record Type.

Setting	Description	Default	Dynamic
View	Optional table view to use instead of a raw query.
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Airtable Record Type

The record type will be dynamically generated based on the Airtable base table schema by mapping Airtable field types with GraphQL types as follows.

Airtable Field Types	Type	Filters
Number, Count, Currency, Duration, Percent, Rating, Auto number	Int
AI Text, Long Text, Rich text, Single line text	String	Limit
Date, Date and time, Created time, Last modified time	String	Date
Multiple select	String with separator
Created by, Last modified by, Collaborator, Multiple collaborators	Airtable User
Multiple attachments	Airtable Attachment

Every record has the following fields available regardless of it schema.

Field	Description	Type	Filters
ID	The unique identifier of this record.	String
Created Time	The unixstamp when this record was created.	String	Date

Airtable User Type

Field	Description	Type
Email	The user email.	String
Name	The user name.	String
ID	The user unique identifier.	String

Airtable Attachment Type

Field	Description	Type
URL	The attachment url, e.g. https://v5.airtableusercontent.com/foo. Notice that URLs expire 2 hours after being returned from the Airtable API.	String
Filename	The attachment filename, e.g. foo.jpg.	String
Type	The attachment content type, e.g. image/jpeg.	String
Size	The attachment file size, in bytes.	Int
Width	The attachment width in pixels, if attachment is an image.	Int
Height	The attachment height in pixels, if attachment is an image.	Int
Thumbnail	The attachment thumbnail, if attachment is an image.	String
ID	Unique attachment id.	String

Cloudflare Stream Source

The Cloudflare Stream Source feeds data from Cloudflare Stream supporting Video and Videos queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Token	The Cloudflare API Token which to authenticate with.
Account	The Cloudflare account which to connecto to.
Signing Key	An auto-generated key used to signing private videos. Not necessary for public videos.

Cloudflare Stream Video Query

Fetches a single video from the authenticated account and resolves to a Cloudflare Stream Video Type.

Setting	Description	Default	Dynamic
Video	The Cloudflare Stream video to create the source from.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Cloudflare Stream Videos Query

Fetches videos from the authenticated account and resolves to a list of Cloudflare Stream Video Type.

Setting	Description	Default	Dynamic
Search	The video name search term by which to filter the results.		✓
Since/Until	Restricts the results to videos that have been published within the specified range of dates.		✓
Status	The status by whic to filter the results, within Ready, Queued, In Progress, Downloading, and Error.	Ready
Quantity	The amount of videos to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Cloudflare Stream Video Type

Defines the mapping options of a Cloudflare Stream Video object.

Option	Description	Type	Filters
ID	The unique identifier of this video.	String
Title	The title of this video.	String	Limit
Iframe URL	Generates an iframe URL with Autoplay, Loop, Muted, Controls, and Time arguments.	String
Preview URL	The preview URL of this video.	String
Playback URL	The streaming playback URL of this video.	String
Size	The formated size of this video.	String
Duration	The duration of this video in seconds.	Int
Width	The width of this video in pixels.	Int
Height	The height of this video in pixels.	Int
Thumbnail	The path to the dynamically generated and locally cached thumbnail of this video, with Time, Height, Width, and Fit arguments.	String
Thumbnail (animated)	The path to the dynamically generated and locally cached animated thumbnail of this video, with Time, Height, Width, and Fit arguments.	String
Created At	The time this video was created.	String	Date
Modified At	The time this video was last modified.	String	Date
Uploaded At	The time this video was uploaded.	String	Date

CSV Source

The CSV Source feeds data from local CSV or TSV files supporting Records query with dynamic filtering and/or ordering.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description	Default
File	The relative or absolute local path to the file which to use as source.
Delimeter	The delimiter character the content is formated with.	,
Enclosure	The enclosure character the content is formated with.	"

CSV Records Query

Fetches records from the file and resolves to a list of dynamically generated CSV record type based on the file schema.

Setting	Description	Default	Dynamic
Filters	The list of filter conditions applied to the query.	[]	✓
Ordering	The list of ordering conditions applied to the query.	[]	✓
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Database Source

The Database Source feeds data from local or external MySQL Database Tables, supporting Record and Records queries with relations and dynamic filtering and/or ordering.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description	Required
Database	The name of the database to which to connect to. Defaults to the site database.
Table	The table from which to create the source.	✓
Primary Key	The primary key of the selected table, this is specially important when using relations.	✓
Custom Connection	Should the connection to the database use custom connection instead of the site one.
Relations	The list of relations and their configuration.

The connection to the database will use the site configuration, but if Custom Connection is enabled the settings inputs will be used instead with support for local as remote servers.

Setting	Description	Required
Host	The IP or domain of the database server.	✓
Port	The port which to use to connect to the server.	✓
Username / Password	The credentials which to use to connect to the server.	✓

Complex data structures typically involve several tables related between them, if that's the case you can set as many relations as needed of the type:

Type	Description
One to One	Also known as BelongsTo, where a single entry relates with another single entry, e.g. Article belongs to an Author.
One to Many	Also known as HasMany, where a single entry relates with multiple entries, e.g. Article is assigned to many Categories.

Setting	Description
Name	The name to associate the relation with. Should be meaningfull, e.g. Author.
Relation Type	The relation type, One to One or One to Many.
Related Table	The table that is being related with the main table.
Main Table Key	The column key from the main table to use for the relation.
Related Table Key	The column key from the related table to use for the relation.

MySQL Views

Relations can get complex and difficult to debug, an alternative simpler approach is to create a MySQL View with the relations solved and use that view as the main table.

Database Record Query

Fetches a single record from the table and resolves to a dynamically generated record type based on the table schema.

Setting	Description	Default	Dynamic
Filters	The list of filter conditions applied to the query.	[]	✓
Ordering	The list of ordering conditions applied to the query.	[]	✓
Random	Should the ordering be randomized ignoring any ordering condition.	false
Start	The offset applied to the query.	1	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Database Records Query

Fetches records from the table and resolves to a dynamically generated list of record type based on the table schema.

Setting	Description	Default	Dynamic
Filters	The list of filter conditions applied to the query.	[]	✓
Ordering	The list of ordering conditions applied to the query.	[]	✓
Random	Should the ordering be randomized ignoring any ordering condition.	false
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Facebook Source

The Facebook Source feeds data from Facebook supporting Page and Page Posts queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Facebook Account which to authenticate with.
Page	The Facebook page from which to create the source content.

Facebook Page Query

Fetches the content from the page resolving to a list of Facebook Page Type.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Facebook Page Posts Query

Fetches the posts from the page resolving to a list of Facebook Page Post Type.

Setting	Description	Default	Dynamic
Limit	The maximum amount of posts to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Facebook Page Type

Defines the mapping options of a Facebook Page object.

Option	Description	Type	Filters
ID	Unique identifier of this Page.	String
Name	The name of this Page.	String
Username	The alias of this Page, e.g for www.facebook.com/platform the username is platform.	String
Link	The Page's Facebook URL.	String
Category	The Page's category, e.g. Product/Service, Computers/Technology.	String
Description	The description of this Page.	String	Limit
Description HTML	The description of this Page in raw HTML.	String
About	Information about this Page.	String	Limit
General Info	General information provided by this Page.	String	Limit
Website	The URL of this Page's website.	String
WhatsApp Number	The WhatsApp number of this Page.	String
Total Ratings	Number of public ratings for this Page.	Int
Total Followers	Number of page followers.	Int
Total Mentions	Number of people talking about this Page.	Int

Page Person Options	Description	Type	Filters
Birthday	The birthday of this Person Page.	String	Date
Personal Info	The personal info of this Person Page.	String	Limit
Personal Interests	The personal interests of this Person Page.	String	Limit
Affiliation	The affiliation of this Person Page.	String	Limit

Facebook Page Post Type

Defines the mapping options of a Facebook Page Post object.

Option	Description	Type	Filters
ID	Unique identifier of this post.	String
Permalink	The permanent static URL of this post, e.g www.facebook.com/.../posts/10153449196.	String
Picture URL	The full size picture attached to this post.	String
Message	The message written in this post.	String	Limit
From	The name of the user, page, group, or event that published this post.	String
Tags	The profiles tagged in post message as a custom formated string with Separator, Show Link and Link Style arguments.	String
Created At	The time this post was published.	String	Date
Updated At	The time this post was last updated, which occurs when a user comments on this post.	String	Date
Is Published	Whether this post was published.	Boolean
Is Expired	Whether this post has expiration time that has passed.	Boolean
Is Hidden	Whether this post has been set to hidden.	Boolean
Is Popular	Whether this post is currently popular based on whether the total actions as a percentage of reach exceeds a certain threshold.	Boolean
Total Shares	Number of times this post has been shared.	Int
Total Likes	Number of times this post has been liked.	Int
Total Comments	Number of comments made on this post.	Int
Total Reactions	Number of times people reacted to this post.	Int
Parent ID	Unique identifier of a parent post for this post, if it exists.	String

Google Business Profile Source

The Google Business Profile Source feeds data from Google Business Profile supporting Location, Review, Reviews, Media and Posts queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Google Account which to authenticate with.
Profile	The Google Business Profile from which to retrieve the locations.
Location	The Google Business Profile location from which to create the source.

Google Business Profile Location Query

Fetches a single location from the profile resolving to a Google Business Profile Location Type.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600
Multiple Items
-- Business Hours	A subquery fetching this location open hours.
-- Special Hours	A subquery fetching this location special hours.

Google Business Profile Review Query

Fetches a single review from the profile location resolving to a Google Business Profile Review Type.

Setting	Description	Default	Dynamic
Review	The location review which content to fetch.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Business Profile Reviews Query

Fetches reviews from the profile location resolving to a list of Google Business Profile Review Type.

Setting	Description	Default	Dynamic
Order By	The order by which to fetch the reviews, Latest, Rating Ascending, or Rating Descending.	Latest
Quantity	The maximum amount of reviews to fetch.	10	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Business Profile Media Query

Fetches media from the profile location resolving to a list of Google Business Profile Media Type.

Setting	Description	Default	Dynamic
Quantity	The maximum amount of media to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Business Profile Posts Query

Fetches posts from the profile location resolving to a list of Google Business Profile Post Type.

Setting	Description	Default	Dynamic
Quantity	The maximum amount of posts to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Business Profile Location Type

Defines the mapping options of a Google Business Profile Location object.

Option	Description	Type	Filters
ID	The unique identifier of this location.	String
Title	The title of this location.	String	Limit
Description	The description of this location.	String	Limit
Phone	The primary phone number of this location.	String
Website	The website of this location.	String
Category	The primary category that describes this location business.	String
Labels	The free-form tags of this location, separated by a comma.	String
Language	The language of this location.	String
Store Code	The external identifier for this location.	String
Coordinates	The latitude and longitude for this location, separated by a comma.	String
Latitude	The latitude for this location.	String
Longitude	The longitude for this location.	String
Total Reviews	The number of reviews for this location.	Int
Average Rating	The average star rating of all reviews for this location on a scale of 1 to 5, where 5 is the highest rating.	Int
Reviews URI	The Google URI pointing to this location reviews.	String
New Review URI	The Google URI pointing to a form where a new review for this location can be posted.	String
Google Maps URI	The Google Maps URI pointing to this location.	String
Google Maps Place ID	The Google Maps Place ID for this location.	String
Address	The address for this location.	Postal Address

Google Business Profile Review Type

Defines the mapping options of a Google Business Profile Location Review object.

Option	Description	Type	Filters
ID	The unique identifier of this location.	String
Comment	The body of this review comment as plain text with markups.	String	Limit
Original Comment	The comment of this review without translation.	String	Limit
Translated Comment	The translated comment of this review.	String	Limit
Star Rating	The star rating given by this review where five is the highest rated.	Int
Created At	The date this review was created.	String	Date
Updated At	The date this review was last modified.	String	Date
Reply	The owner/manager of this location's reply to this review.	Review Reply Type
Reviewer	The author of this review.	Reviewer Type

Google Business Profile Review Reply Type

Defines the mapping options of a Google Business Profile Review Reply object.

Option	Description	Type	Filters
Comment	The body of this reply as plain text with markups.	String	Limit
Updated At	The date this reply was last modified.	String	Date

Google Business Profile Reviewer Type

Defines the mapping options of a Google Business Profile Reviewer object.

Option	Description	Type
Display Name	The name of the reviewer, only populated with the reviewer's real name if is not anonymous.	String
Profile Photo URL	The path to the locally cached reviewer profile photo.	String
Is Anonymous	Indicates whether the reviewer has opted to remain anonymous.	Boolean

Google Business Profile Post Type

Defines the mapping options of a Google Business Profile Post object.

Option	Description	Type	Filters
ID	The unique identifier of this post.	String
URL	The link to the post in Google search.	String
Topic Type	The topic type of the post, STANDARD, EVENT, OFFER, or ALERT.	String
Summary	The description/body of the post.	String
Primary Media URL	The path to the locally cached post primary media thumbnail.	String
Language	The language of the post.	String
Created At	The date this post was created.	String	Date
Updated At	The date this post was last modified.	String	Date
Offer
Coupon Code	Offer code that is usable in store or online.	String
Redeem Online URL	Online link to redeem this offer.	String
Terms & Conditions	Terms and conditions of this offer.	String

Google Business Profile Media Type

Defines the mapping options of a Google Business Profile Media object.

Option	Description	Type	Filters
ID	The unique identifier of this media.	String
Description	The description of this media.	String	Limit
Format	The format of this media, PHOTO, VIDEO, OR MEDIA_FORMAT_UNSPECIFIED.	String
Width	The width of the media, in pixels.	String
Height	The height of the media, in pixels.	String
Thumbnail URL	The path to the locally cached media thumbnail.	String
Source URL	A publicly accessible URL where the media can be retrieved from.	String
Google URL	The Google-hosted URL for this media. For video this will be a preview image with an overlaid play icon.	String
Created At	The date this media was created.	String	Date
Total Views	The number of times this media has been viewed.	Int
Attribution
Profile Name	The name of the attributed user.	String
Profile URL	The URL of the attributed user's Google Maps profile page.	String
Profile Photo URL	The path to the locally cached attributed user's profile photo thumbnail.	String
Location Association
Category	The category that this location photo belongs to.	String
Price List Item ID	The ID of a price list item that this location media is associated with.	String

Google Business Profile Period Type

Defines the mapping options of a Google Business Profile time period object.

Option	Description	Type	Filters
Open Period	The current period during which the location is open, formated as {start time} - {end time} with a custom time format setting.	String
Open Day	The day of the week this period starts on.	String
Close Day	The day of the week this period ends on.	String
Open Time	The time this period starts on.	String	Time
Close Time	The time this period ends on.	String	Time

Google Business Profile Postal Address Type

Defines the mapping options of a Google Business Profile Postal Address object.

Option	Description	Type
Organization	The name of the organization for this address.	String
Address	The address lines separated by comma.	String
Address Full	The address lines with postal, locality and area separated by comma.	String
Locality	The city/town portion of this address.	String
Sublocality	The sublocality of this address, this can be neighborhoods, boroughs, districts.	String
Administrative Area	The highest administrative subdivision which is used for postal addresses of a country or region.	String
Region Code	The CLDR region code of the country/region of this address.	String
Sorting Code	The country-specific sorting code, if applicable.	String
Postal Code	The postal code of this address, if applicable.	String
Language Code	The BCP-47 language code of the contents of this address.	String

Google Calendar Source

The Google Calendar Source feeds data from Google Calendar supporting Calendar, Event and Events queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Google account which to authenticate with.
Calendar	The Google calendar which data to create the source with.

Google Calendar Query

Fetches the Calendar data resolving to a Google Calendar Type.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Calendar Event Query

Fetches a single event from the calendar and resolves to a Google Calendar Event Type.

Setting	Description	Default	Dynamic
Event ID	The ID of the event to query.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Calendar Events Query

Fetches events from the calendar and resolves to a list of Google Calendar Event Type.

Setting	Description	Default	Dynamic
Query	Optionaly filter matching terms in the summary, description, location, attendee's displayName and attendee's email fields.		✓
Time Min / Max	Lower and Upper bounds (exclusive) for an event's start or end time to filter by. Can be date without time, e.g. 2011-06-03 formated as Y-m-d, in which case the current time will be appended, or a timestamp with time zone offset, e.g. 2011-06-03T10:00:00-07:00 formated as c.		✓
Order By	The order by which to query the events. Start Time, by event start date/time (ascending) or Updated, by event last modification time (ascending). The default is an unspecified, stable order.	Default
Quantity	The maximum amount of events to query, cannot be higher than 2500.	250	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Calendar Type

Defines the mapping options of a Google Calendar object.

Option	Description	Type	Filters
ID	Unique identifier of the calendar.	String
Summary	Title of the calendar.	String	Limit
Description	Description of the calendar.	String	Limit
Location	Geographic location of the event as free-form text.	String	Limit
Time Zone	The calendars default time zone.	String

Google Calendar Event Type

Defines the mapping options of a Google Calendar Event object.

Option	Description	Type	Filters
ID	Opaque identifier of the event.	String
URL	An absolute link to the event in the Google Calendar Web UI.	String
Type	Specific type of the event, default, outOfOffice, focusTime or workingLocation.	String
Status	Status of the event, confirmed, tentative or cancelled. -	String
Visibility	Visibility of the event, default, public, private, or `confidential*	String
Summary	Title of the event.	String	Limit
Description	Description of the calendar.	String	Limit
Location	Geographic location of the event as free-form text.	String	Limit
Start	The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.	String	Date
End	The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.	String	Date
Created	Creation time of the event.	String	Date
Updated	Last modification time of the event.	String	Date
Creator	The creator of the event.	Google Calendar Profile Type
Organizer	The organizer of the event.	Google Calendar Profile Type
Attendees	The attendees of the event.	Google Calendar Attendee Type
Attachments	File attachments of the event.	Google Calendar Attachment Type

Google Calendar Profile Type

Defines the mapping options of a Google Calendar Profile object.

Option	Description	Type	Filters
ID	Identifier of the profile.	String
Email	The profile's email.	String
Name	The profile's name.	String	Limit

Google Calendar Attendee Type

Defines the mapping options of a Google Calendar Attendee object.

Option	Description	Type	Filters
ID	Identifier of the attendee.	String
Email	The attendee's email.	String
Name	The attendee's name.	String	Limit
Comment	The attendee's name.	String	Limit
Response Status	The attendee's response status, needsAction, declined, tentative or accepted.	String
Is Organizer	Whether the attendee is the organizer of the event.	Boolean
Is Resource	Whether the attendee is a resource.	Boolean
Is Optional	Whether this is an optional attendee.	Boolean
Additional Guests Count	Number of additional guests.	Int

Google Calendar Attachment Type

Defines the mapping options of a Google Calendar Attachment object.

Option	Description	Type	Filters
ID	Identifier of the attached file.	String
Title	Title of the attachment.	String	Limit
Mime Type	Internet media type (MIME type) of the attachment.	String
File URL	URL link to the attachment.	String
Icon URL	URL link to the attachment's icon.	String

Google Photos Source

The Google Photos Source feeds media from Google Photos supporting Album, Albums and Album Media queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Google account which to authenticate with.

Google Photos Album Query

Fetches a single album resolving to a Google Photos Album Type.

Setting	Description	Default	Dynamic
Album ID	The ID of the album to query.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Photos Album Media Query

Fetches media from a single album resolving to a list of Google Photos Media Type.

Setting	Description	Default	Dynamic
Album ID	The ID of the album to query.		✓
Type	The media type which to query, All, Images or Videos.	All
Order By	The order by which to query the media Date (desc) or Date (asc).	Date (desc)
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Photos Albums Query

Fetches all albums from the library resolving to a list of Google Photos Album Type.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Google Photos Album Type

Defines the mapping options of a Google Photos Album object.

Option	Description	Type	Filters
ID	Unique identifier of the album.	String
Title	Title of the album.	String	Limit
Cover Photo URL	The album cover photo URL.	String
Total Media Count	The album total amount of media.	Int

Google Photos Media Type

Defines the mapping options of a Google Photos Media object.

Option	Description	Type	Filters
ID	Opaque identifier of the media.	String
URL	The path to the locally cached media file, with optionall arguments Width and Height .	String
Description	Description of the media. This is shown to the user in the item's info section in the Google Photos app.	String	Limit
Filename	Filename of the media. This is shown to the user in the item's info section in the Google Photos app.	String
MIME Type	MIME type of the media. For example, image/jpeg.	String

Google Photos Metadata Type

Defines the mapping options of a Google Photos Metadata object.

Option	Description	Type
Width	Original width (in pixels) of the media.	Int
Height	Original height (in pixels) of the media.	Int
Creation Time	Time when the media was first created (not when it was uploaded to Google Photos).	String
Camera Brand	Brand of the camera with which the photo was taken.	String
Camera Model	Model of the camera with which the photo was taken.	String
Frame Rate	Frame rate of the media in case is a video.	Int
Camera ISO	ISO of the camera with which the photo was taken.	Int
Focal Length	Focal length of the camera lens with which the photo was taken.	Int
Aperture F	Aperture f number of the camera lens with which the photo was taken.	Int
Exposure Time	Exposure time of the camera aperture in seconds when the photo was taken.	String

Google Sheets Source

The Google Sheets Source feeds data from Google Sheets supporting Records query.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Default	Description	Required
Account		The Google Account which to authenticate with.	✓
Spreadsheet		The spreadsheet which to retrieve the data from.	✓
Sheet	Default	The spreadsheet sheet which data to create the source with.
Start Column	A	The starting column to restrict the sheet data with.
End Column	Z	The ending column to restrict the sheet data with.

Google Sheets Records Query

Fetches records from the spreadsheet and resolves to a dynamically generated list of record type based on the sheet schema.

Setting	Default	Description
Start	1	The offset applied to the query.
Quantity	20	The limit applied to the query.
Cache	3600	The duration in seconds before the cache is invalidated and the query re-executed.

Instagram Source

The Instagram Source feeds data from Personal and Business Instagram accounts supporting Media, Media Single, Hashtagged Media and User queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Instagram Account which to authenticate with.
Page	The Facebook Page associated with the Instagram Business account. Not applicable for Instagram Personal.

Instagram Media Query

Fetches media from the authenticated account and resolves to a list of Instagram Media Type.

Setting	Description	Default	Dynamic
Type	The type of media to fetch, All, Image, or Video.	All
Offset	The offset media to fetch.	0	✓
Limit	The maximum amount of media to fetch.	20	✓
Since/Until	The start and/or end datetime the fetched media will be restricted to.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Instagram Media Single Query

Fetches a single media from the authenticated account and resolves to a Media Type.

Setting	Description	Default	Dynamic
ID	Unique identifier of the media to retrieve.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

If the Media is of Album Type you can fetch it media with the Multi Items query which resolves to a list of Instagram Album Media Type.

Setting	Description	Default	Dynamic
ID	Unique identifier of the media to retrieve.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Instagram Hashtagged Media Query

Fetches top and recent hashtagged media from the authenticated business account and resolves to a list of Instagram Media Type.

Setting	Description	Default	Dynamic
Hashtag	The hashtag to query for.		✓
Edge	Should the query look for Top Media or Recent Media hashtagged with.	Top
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Notice

Take into consideration that this query is available for Instagram Business Accounts only and that the API imposes the following limitations:

• Only returns public photos and videos.
• Will not return promoted/boosted/ads media.
• Responses will not always be in chronological order.
• Maximum of 30 unique hashtags within a 7 day period.

Instagram User Query

Fetches the user profile from the authenticated account and resolves to a Instagram User Type.

Setting	Default	Description
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	0

Notice

This query is only available for Instagram Business Accounts

Instagram Media Type

Option	Description	Type	Filters
ID	Unique identifier of this media.	String
Type	The type of this media, Album, Image, or Video.	String
URL	The path to the locally cached media asset.	String
Thumbnail URL	The path to the locally cached media thumbnail asset.	String
Permalink	The Instagram Media URL, e.g. www.instagram.com/p/CO9O62hnpR5nkt.	String
Caption	The caption content.	String	Limit
Hashtags	The media hashtags as a custom formated string with Separator argument.	String
Created At	The time this media was created.	String	Date
Created By	The username of the user who created this media.	String

Business Only Options	Description	Type
Total Comments	Number of comments made one this media.	Int
Total Likes	Number of user that liked this media.	Int

Instagram Album Media Type

Option	Description	Type	Filters
ID	Unique identifier of this media.	String
Type	The type of this media, Album, Image, or Video.	String
URL	The path to the locally cached media asset.	String
Thumbnail URL	The path to the locally cached media thumbnail asset.	String
Permalink	The Instagram Media URL, e.g. www.instagram.com/p/CO9O62hnpR5nkt.	String
Created At	The time this media was created.	String	Date
Created By	The username of the user who created this media.	String

Instagram User Type

Option	Description	Type	Filters
ID	Unique identifier of this user.	String
Name	The name of this user.	String
Website	The website of this user profile.	String
Biography	The biography of this user profile.	String	Limit
Picture URL	The profile picture URL of this user.	String
Total Followers	Number of Instagram users following this user.	Int
Total Follows	Number of Instagram users this user follows.	Int
Total Media	Number of Instagram Media published on this user.	Int

RSS Source

The RSS Source is a specialized version of the XML Source that feeds data from RSS 0.9, 1.0, 2.0, and Atom specifications supporting Feed and Entries queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
URL	The feed URL from which to generate the source content.

RSS Feed Query

Fetches information from the feed and resolves to a dynamically generated feed type based on it schema.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

RSS Entries Query

Fetches records from the feed and resolves to a list of dynamically generated record type based on the feed schema.

Setting	Description	Default	Dynamic
Filters	The list of filter conditions applied to the query.	[]	✓
Ordering	The list of ordering conditions applied to the query.	[]	✓
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

TikTok Source

The TikTok Source feeds media from TikTok supporting My Videos query.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The TikTok Account which to authenticate with.

TikTok My Videos Query

Fetches videos from the authenticated account and resolves to a list of TikTok Video Type.

Setting	Description	Default	Dynamic
Filter by ID	Filter videos comma separated list of IDs, up to maximum 20 videos.		✓
Filter by date	Filter videos created before the specified date.		✓
Start	The starting point, e.g of a list of 20 videos start from the number 2.	1	✓
Quantity	The maximum amount of videos to retrieve.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

TikTok Video Type

Defines the mapping options of a TikTok Video object.

Option	Description	Type	Filters
ID	The unique identifier of this video.	String
Title	The title of this video, max length 150.	String	Limit
Description	The description for this video, max length 150.	String	Limit
Duration	The duration of this video in seconds.	Int
Width	The width of this video.	Int
Height	The height of this video.	Int
Cover	The path to the locally cached video cover.	String
Embed Link	The embed link of tiktok.com for this video.	String
Embed HTML	The HTML code for embedded video.	String
Share URL	A shareable link for this video. Note that the website behaves differently on Mobile and Desktop devices.	String
Created At	The time this video was created.	String	Date
Total Shares	Number of times this video has been shared.	Int
Total Likes	Number of times this video has been liked.	Int
Total Comments	Number of times this video has been commented.	Int
Total Views	Number of times this video has been viewed.	Int

Twitter Source

The Twitter Source feeds data from Twitter supporting My Tweets and User queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Twitter Account which to authenticate with.

My Tweets Query

Fetches tweets from the authenticated account resolving to a list of Tweet Type.

Setting	Description	Default	Dynamic
Since/Until	The start and/or end datetime the fetched tweets will be restricted to.		✓
Limit	The maximum amount of tweets to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Twitter User Query

Fetches the authenticated user account resolving to a list of Twitter User Type.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Tweet Type

Defines the mapping options of a Twitter Tweet object.

Option	Description	Type	Filters
ID	Unique identifier of this Tweet.	String
Text	The content of the Tweet.	String	Limit
Text HTML	The content of the Tweet as HTML.	String	Limit
Permalink	The Tweet URL, e.g. twitter.com/Twitter/status/123456789.	String
Created At	The time this Tweet was created.	String	Date
Language	Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag.	String
Total Retweets	Number of times this Tweet has been Retweeted.	Int
Total Replies	Number of Replies of this Tweet.	Int
Total Likes	Number of Likes of this Tweet.	Int
Total Quotes	Number of times this Tweet has been Retweeted with a comment (also known as Quote).	Int

Twitter User Type

Defines the mapping options of a Twitter User object.

Option	Description	Type	Filters
ID	Unique identifier of this user.	String
Username	The Twitter handle (screen name) of this user.	String
Created At	The time this user account was created.	String	Date
Profile URL	The URL specified in the user's profile, if present.	String
Profile Name	The friendly name of this user, as shown on their profile.	String
Profile Image	The path to the locally cached profile image for this user, as shown on the user's profile.	String
Profile Description	The text of this user's profile description (also known as bio), if the user provided one.	String	Limit
Total Followers	Number of users who follows this user.	Int
Total Following	Number of users this user is following.	Int
Total Tweets	Number of Tweets (including Retweets) posted by this user.	Int
Total Listed	Number of lists that include this user.	Int

Vimeo Source

The Vimeo Source feeds media from Vimeo supporting My Videos, My Folder Videos and My Showcase Videos queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

Setting	Description
Account	The Vimeo Account which to authenticate with.

Vimeo My Videos Query

Fetches videos from the authenticated account and resolves to a list of Vimeo Video Type.

Setting	Description	Default	Dynamic
Query	The search term by which to filter the videos.		✓
Attribute	The video attribute by which to filter the videos, within Featured, Live, and No Live.
Tags	Comma separated tags by which to filter the videos.		✓
Sort	The order of the videos, within Default, Alphabetical, Date, Modified, Duration, Last User Action, Total Plays, and Total Likes.	Default	✓
Direction	The order direction of the videos, Ascending or Descending.	Descending
Page	The page number of the videos.	1	✓
Per Page	The number of videos to return on each page, up to a maximum of 100.	25	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Vimeo My Folder Videos Query

Fetches videos from the authenticated account specific folder and resolves to a list of Vimeo Video Type.

Setting	Description	Default	Dynamic
Folder ID	The unique identifier of the folder from which to retrieve the videos.		✓
Include Subfolders	Whether to include videos of all subfolders.
Query	The search term by which to filter the videos.		✓
Sort	The order of the videos, within Default, Alphabetical, Date, Duration, and Last User Action.	Default
Direction	The order direction of the videos, Ascending or Descending.	Descending
Page	The page number of the videos.	1	✓
Per Page	The number of videos to return on each page, up to a maximum of 100.	25	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Vimeo My Showcase Videos Query

Fetches videos from the authenticated account specific showcase and resolves to a list of Vimeo Video Type.

Setting	Description	Default	Dynamic
Showcase ID	The unique identifier of the showcase from which to retrieve the videos.		✓
Password	The password of the showcase in case it has one.		✓
Query	The search term by which to filter the videos.		✓
Sort	The order of the videos, within Default, Alphabetical, Date, Duration, and Last User Action.	Default
Direction	The order direction of the videos, Ascending or Descending.	Descending
Page	The page number of the videos.	1	✓
Per Page	The number of videos to return on each page, up to a maximum of 100.	25	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

Vimeo Video Type

Defines the mapping options of a Vimeo Video object.

Option	Description	Type	Filters
ID	The unique identifier of this video.	String
URL	The URL of this video, e.g. vimeo.com/123456789.	String
Custom URL	The custom URL of this video.	String
Type	The type of this video, live (is or was a live event), stock (is a Vimeo Stock video), or video (standard Vimeo video).	String
Title	The title of this video.	String	Limit
Description	A brief explanation of this video's content.	String	Limit
Duration	The duration of this video in seconds.	Int
Language	The primary language of this video.	String
License	The Creative Commons license given to this video under BY, BY-NC, BY-NC-ND, BY-NC-SA, BY-ND, BY-SA, or CC0.	String
Thumbnail	The path to the locally cached video picture.	String
Width	The width of this video in pixels.	Int
Height	The height of this video in pixels.	Int
Tags	A formated list of all tags assigned to this video, joined with a custom separator.	String
Categories	A formated list of all categories this video belongs to, joined with a custom separator, optional link and style.	String
Created At	The time this video was created.	String	Date
Released At	The time this video was released.	String	Date
Modified At	The time this video was modified.	String	Date
Total Plays	Number of times this video has been played.	Int
Total Comments	Number of times this video has been commented.	Int

Vimeo User Type

Defines the mapping options of a Vimeo User object.

Option	Description	Type	Filters
ID	The unique identifier of this user.	String
URL	The absolute URL of this user profile page.	String
Name	The display name of this user.	String
Gender	The gender of this user.	String
Bio	The long bio text of this user.	String	Limit
Bio Short	The short bio text of this user.	String	Limit
Location	The location of this user.	String
Is Expert	Whether the creator enrolled in and successfully completed the Vimeo Experts program.	String

XML Source

The XML Source feeds data from any XML URL or local file, reading its structure and building a dedicated query and source types to the best of its abilities.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

If the source is a remote file, the URL and an optional API key-based authentication are required:

Setting	Description
URL	The feed URL from which to generate the source content.
Requires Authentication	If the URL is protected by authorization.
Authentication	The authentication details to use.

When authentication is present, you can specify its details. Currently, only the API key method is supported, either via a header or a query parameter.

Setting	Description
API Key	The API key to use.
API Key Mode	Where the key is set, in a header or in a query parameter.
Parameter Name	The name of the header or of the query parameter where the API key is set.

If the source is a local file, the file path is required.

Setting	Description
File	The relative or absolute local path to the file to use as source.

Optionally, an XPath filter can be set, which will allow narrowing down your XML file if needed. It's also possible to map some of the result item properties to dedicated types, to make better use of YOOtheme Pro filters, such as dates or numbers.

Setting	Description
XPath Filter	Optional XPath filter, like /jobs/job.
Data Types	Data type mapping for each field.

XML Query

Fetches records from the XML file and resolves to a list of dynamically generated record types based on the feed schema.

Setting	Description	Default	Dynamic
Start	The offset applied to the query.	1	✓
Quantity	The limit applied to the query.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube Source

The YouTube Source feeds data from YouTube supporting Videos, My Channel, My Channel Video, My Channel Videos, My Channel Playlist, My Channel Playlist Videos, My Playlist Video and My Playlist Videos queries.

Setting	Description	Default
Name	The name that will identify this source instance.
Default Cache Time	The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration.	3600

If the source is based on a YouTube channel or playlist an oAuth authentication is required.

Setting	Description
Account	The Google Account which to authenticate with.
Channel	The YouTube Channel from which to create the source.
Playlist	The YouTube Playlist from which to create the source.

If the source is based on YouTube videos an API Key is required instead.

Setting	Description
API Key	The Google API Key which to authenticate with.

YouTube Videos Query

Fetches public videos with advanced query params resolving to a list of YouTube Video Type.

Setting	Description	Default	Dynamic
Videos ID	Restricts the results to videos created by a specific channel ID.		✓
Channel ID	Restricts the results to videos created by a specific channel ID.		✓
Query Term	The list of terms the videos should be associated with. Use the Boolean NOT (-) and OR (|) operators to exclude or find videos that are associated with one of several search terms. For example, to match either "boating" or "sailing", set as boating|sailing. Similarly, to exclude "fishing", set as boating|sailing -fishing.		✓
Since/Until	Restricts the results to videos that have been published within the specified range of dates.		✓
Location/Radius	Location in conjunction with radius, defines a circular geographic area to which to restrict the videos. The location points the center of the area with latitude/longitude coordinates e.g. 37.42307,-122.08427, while the radius is the maximum distance from the location in m, km, ft, or mi units, e.g 5km.		✓
Region	Restricts the results to videos that can be viewed in the specified country. The value is an ISO 3166-1 alpha-2 country code, e.g ES.		✓
Language	Restricts the results to videos that are most relevant to the specified language. The value is typically an ISO 639-1 two-letter language code, however, you should use the values zh-Hans for simplified Chinese and zh-Hant for traditional Chinese. Note that results in other languages will still be returned if they are highly relevant to the search query term.		✓
Definition	Restricts the results based on the videos quality, either High Definition, Standard Definition, or Any. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available.	Any
Duration	Restricts the results based on the videos duration, either Long, longer than 20 minutes, Medium, between four and 20 minutes, Short, less than four minutes, or Any.	Any
Start	The starting point, e.g of a list of 20 videos start from the number 2.	1	✓
Quantity	The maximum amount of videos to retrieve.	20	✓
Order	The order in which the videos will be returned, within Date, reverse chronological order based on the date the videos were created, Rating, from highest to lowest rating, Relevance, based on their relevance to the search query, Title, alphabetically by title, or View Count, from highest to lowest number of views.	Relevance
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube My Channel Query

Fetches the channel content resolving to a YouTube Channel Type.

Setting	Description	Default
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube My Channel Video Query

Fetches a single video from the channel resolving to a YouTube Video Type.

Setting	Description	Default	Dynamic
Video	The playlist video which content to fetch.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube My Channel Videos Query

Fetches videos from the channel resolving to a list of YouTube Video Type.

Setting	Description	Default	Dynamic
Start	The starting position to retrieve the videos at.	1	✓
Quantity	The maximum amount of videos to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube My Channel Playlist Query

Fetches a single playlist from the channel resolving to a YouTube Playlist Type.

Setting	Description	Default	Dynamic
Playlist	The YouTube Playlist which content to fetch.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600
Multi Items	The related multi-items content to query instead with Videos as the only option.

YouTube My Channel Playlist Videos Query

Fetches videos from the playlist resolving to a list of YouTube Video Type.

Setting	Description	Default	Dynamic
Start	The starting position to retrieve the videos at.	1	✓
Quantity	The maximum amount of videos to fetch.	20	✓

YouTube My Playlist Video Query

Fetches a single video from the playlist resolving to a YouTube Video Type.

Setting	Description	Default	Dynamic
Video	The playlist video which content to fetch.		✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube My Playlist Videos Query

Fetches videos from the playlist resolving to a list of YouTube Video Type.

Setting	Description	Default	Dynamic
Start	The starting position to retrieve the videos at.	1	✓
Quantity	The maximum amount of videos to fetch.	20	✓
Cache	The duration in seconds before the cache is invalidated and the query re-executed.	3600

YouTube Video Type

Defines the mapping options of a YouTube Video object.

Option	Description	Type	Filters
ID	The unique identifier of this video.	String
Title	The title of this video.	String	Limit
Description	The description of this video.	String	Limit
URL	The YouTube public URL, e.g. www.youtube.com/watch?v=c2pz2mlSfXA.	String
Iframe Player	Generates an HTML embed video player with several configuration settings.	String
Published At	The date this video was published.	String	Date
Thumbnail URL	The URL to this video thumbnail with different size options, Low, Medium (default), High Resolution, Standard, and `Max Resolution*	String
Thumbnail Width	The width of this video thumbnail with same size options as for URL.	String
Thumbnail Height	The height of this video thumbnail with same size options as for URL.	String
Total Views	Number of times this video has been viewed.	Int
Total Comments	Number of comments for this video.	Int
Total Likes	Number of users that have indicated they like this video.	Int
Total Dislikes	Number of users that have indicated they dislike this video.	Int

YouTube Channel Type

Defines the mapping options of a YouTube Channel object.

Option	Description	Type	Filters
ID	The unique identifier of this channel.	String
Title	The title of this channel.	String	Limit
Description	The description of this channel.	String	Limit
Country	The country with which this channel is associated.	String
Published At	The date this channel was published.	String	Date
Thumbnail URL	The URL to this channel thumbnail with different size options, Low, Medium (default), High Resolution, Standard, and Max Resolution	String
Thumbnail Width	The width of this channel thumbnail with same size options as for URL.	String
Thumbnail Height	The height of this channel thumbnail with same size options as for URL.	String
Total Views	Number of times this channel has been viewed.	Int
Total Videos	Number of public videos uploaded to this channel.	Int
Total Subscribers	Number of subscribers this channel has, the value is rounded down to three significant figures.	Int

YouTube Playlist Type

Defines the mapping options of a YouTube Playlist object.

Option	Description	Type	Filters
ID	The unique identifier of this playlist.	String
Title	The title of this playlist.	String	Limit
Description	The description of this playlist.	String	Limit
Iframe Player	Generates an HTML embed playlist player with several configuration settings.	String
Published At	The date this playlist was published.	String	Date
Thumbnail URL	The URL to this playlist thumbnail with different size options, Low, Medium (default), High Resolution, Standard, and Max Resolution	String
Thumbnail Width	The width of this playlist thumbnail with same size options as for URL.	String
Thumbnail Height	The height of this playlist thumbnail with same size options as for URL.	String