Articles

Columns

Name

Type

ReadOnly

Description

Id [KEY]

Long

True

The ID of the article.

BlogId [KEY]

Long

False

The ID of the blog containing the article.

AdminGraphqlApiId

String

True

Displays the Admin Graphql API id.

Author

String

False

The name of the author of the article.

BodyHtml

String

False

The text of the body of the article, complete with HTML markup.

CreatedAt

Datetime

True

The date and time (ISO 8601 format) when the article was created.

Handle

String

False

A human-friendly unique string for the article that's automatically generated from the article's title. The handle is used in the article's URL.

Image.alt

String

False

Alternative text that describes the image.

Image.createdAt

Datetime

True

The date and time when image is created.

Image.height

Integer

False

Height of the image.

Image.src

String

False

A source URL that specifies the location of the image.

Image.width

Integer

False

Width of the image.

Image.attachment

String

False

An image attached to article returned as Base64-encoded binary data.

PublishedAt

Datetime

False

The date and time (ISO 8601 format) when the article was published.

SummaryHtml

String

False

A summary of the article, complete with HTML markup.

Tags

String

False

Tags are additional short descriptors formatted as a string of comma-separated values.

Template_suffix

String

False

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

Title

String

False

The title of the article.

UpdatedAt

Datetime

True

The date and time (ISO 8601 format) when the article was last updated.

UserId

Long

True

A unique numeric identifier for the author of the article.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

published_status

String

Filter articles by their publish status. Valid values are: published, unpublished and any ; default: any.

Last updated