Numerical identifier. Useful for creating SEO friendly URLs (combined with a slug of the Article name).
collectionId
String
5214c83d45667acd25394b53
The id of the Collection that this Category is associated with.
slug
String
"my-article"
SEO-friendly identifier for the article that can be used in a URL.
status
String
published
The status of the Article. Possible values:
published - viewable by the public
notpublished - only viewable in admin
hasDraft
Boolean
false
If this value is true, the article has changes saved in a draft that have not been published.
name
String
My Article
text
String
This is my <b>article text</b>.
categories
Array
An array of Strings that represents the Category ids that the Article is associated with.
related
Array
An array of Strings that represent the ids of Articles that are related to the Article.
publicUrl
String
https://docs.helpscout.net/article/100-my-article
A read-only attribute that returns the public URL for the article.
popularity
Number
4.3
A number between 1 and 5 that indicates the popularity of the article. The higher the number, the more popular the article is. Currently based only on viewCount.
keywords
Array
An array of Strings that list all associated keywords for the Article
viewCount
Int
237
The number of views the Article has received.
createdBy
Integer
73423
The Help Scout id of the user who created this Collection.
updatedBy
Integer
73423
The Help Scout id of the user who last updated this Collection.
createdAt
DateTime
"2013-08-21T19:34:13Z"
The UTC date/time that the Article was created.
updatedAt
DateTime
"2013-08-21T19:34:13Z"
The UTC date/time that the Article was last updated.
lastPublishedAt
DateTime
"2013-08-21T19:34:13Z"
The UTC date/time that the Article was last published.
Example
{"id":"521632244566c845e582652d","number":125,"collectionId":"5214c77c45667acd25394b51","slug":"my-article","status":"published","hasDraft":false,"name":"My Article","text":"This is the text of the article.","categories":["5214c77d45667acd25394b52"],"related":["521632244566c845e582652b","521632244566c845e582652c"],"publicUrl":"https://docs.helpscout.net/article/100-my-article","popularity":4.3,"viewCount":237,"createdBy":73423,"updatedBy":73423,"createdAt":"2013-08-22T15:45:40Z","updatedAt":"2013-08-22T21:40:56Z","lastPublishedAt":"2013-08-22T21:40:56Z"}