The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.
statisticsobject or null(Article Statistics)The statistics of an article.
The type of object - article
.
Default "article"
Value"article"
Example: "article"
The unique identifier for the article which is given by Intercom.
Example: "6871119"
The id of the workspace which the article belongs to.
Example: "hfi1bx4l"
The title of the article. For multilingual articles, this will be the title of the default language's content.
Example: "Default language title"
descriptionstring or nullThe description of the article. For multilingual articles, this will be the description of the default language's content.
Example: "Default language description"
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
Example: "Default language body in html"
The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.
Example: "5017691"
Whether the article is published
or is a draft
. For multilingual articles, this will be the state of the default language's content.
Default "draft"
Enum"published""draft"
Example: "published"
created_atinteger(date-time)The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
Example: 1672928359
updated_atinteger(date-time)The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
Example: 1672928610
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
Example: "http://intercom.test/help/en/articles/3-default-language"
The id of the article's parent collection or section. An article without this field stands alone.
Example: "125685"
parent_idsArray of integersThe ids of the article's parent collections or sections. An article without this field stands alone.
Example: [18,19]
parent_typestring or nullThe type of parent, which can either be a collection
or section
.
Example: "collection"
The default locale of the help center. This field is only returned for multilingual help centers.
Example: "en"
translated_contentobject or null(Article Translated Content)The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
{ "statistics": { "type": "article_statistics", "views": 10, "conversions": 0, "reactions": 10, "happy_reaction_percentage": 40, "neutral_reaction_percentage": 40, "sad_reaction_percentage": 20 }, "type": "article", "id": "6871119", "workspace_id": "hfi1bx4l", "title": "Default language title", "description": "Default language description", "body": "Default language body in html", "author_id": "5017691", "state": "published", "created_at": 1672928359, "updated_at": 1672928610, "url": "http://intercom.test/help/en/articles/3-default-language", "parent_id": "125685", "parent_ids": [ 18, 19 ], "parent_type": "collection", "default_locale": "en", "translated_content": { "type": "article_translated_content", "ar": { … }, "bg": { … }, "bs": { … }, "ca": { … }, "cs": { … }, "da": { … }, "de": { … }, "el": { … }, "en": { … }, "es": { … }, "et": { … }, "fi": { … }, "fr": { … }, "he": { … }, "hr": { … }, "hu": { … }, "id": { … }, "it": { … }, "ja": { … }, "ko": { … }, "lt": { … }, "lv": { … }, "mn": { … }, "nb": { … }, "nl": { … }, "pl": { … }, "pt": { … }, "ro": { … }, "ru": { … }, "sl": { … }, "sr": { … }, "sv": { … }, "tr": { … }, "vi": { … }, "pt-BR": { … }, "zh-CN": { … }, "zh-TW": { … } } }
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4