Field containing a URL.
Field | Type | Description |
object_type | string | The object_type of this entity (eg: "article", "tag", or "blog_post"). |
is_valid | True|False | Indicates whether or not this references an entity. |
guid | guid | The unique identifier for this entity. |
name | text_field | The entity name. This field is primarily intended for internal use by website administrators to identify objects. |
title | text_field | The entity title. |
linked_title | html | A link to the default page if one exists, or the escaped title if not. |
default_page_guid | text_field | The unique identifier of the default page, if one exists. |
default_page_url | text_field | The URL of the default page, if one exists. |
page | page | The default page, if one exists. |
Type-Specific Properties | Each entity will include the specific property of the entity type that it belongs to (eg: if it is a blog_post it will include the blog, image, post_date, etc... properties). | |
value | string | Synonymn for guid. |
output | html | The default output that the entity would produce if it were output directly to the template. |
output_in_list | html | The default output that the article would produce if it were output directly to to the template from inside a list. |
Contains a collection of content, including pagination-related information.
Field | Type | Description |
object_type | string | Will always be "entity_collection". |
is_valid | true/false | Returns true if the collection contains at least one entity. |
items | list of snippets | Contains a list of content. |
limit | number | The maximum number of snippets that could have been fetched dynamically from the database |
start | number | The 1-based index of the first snippet that was (or would have been) dynamically fetched from the database |
page | number | The 1-based index of the first "page" of snippets that could have been fetched dynamically from the database - as determined by the start and limit properties |
total_count | number | The total number of snippets in the database that matched the provided filter parameters when fetching the list of fetched snippets |
total_pages | number | The total number of "pages" of results that matched the provided filter parameters when fetching the list of fetched snippets - as determined by the total_count and limit properties |
output | html | The default output that the entity_collection would produce if it were output directly to the template - using the "output_in_list" property of each item in the list. |