Retrieve Article

Retrieve an article

GET/articles/{article_id}

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the Retrieve Article action (under Articles).
Fill in the fields below, then reference the result from later steps as {{retrieveArticle.response.data}}.

Request

Path parameters

article_idintegerrequired

The unique identifier for the article which is given by Intercom.

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{retrieveArticle.response.data.<field>}}.

statisticsobject

The statistics of an article.

typestring

The type of object - `article_statistics`.

One ofarticle_statisticsDefault "article_statistics"

viewsinteger

The number of total views the article has received.

conversionsinteger

The number of conversations started from the article.

reactionsinteger

The number of total reactions the article has received.

happy_reaction_percentagenumber (float)

The percentage of happy reactions the article has received against other types of reaction.

neutral_reaction_percentagenumber (float)

The percentage of neutral reactions the article has received against other types of reaction.

sad_reaction_percentagenumber (float)

The percentage of sad reactions the article has received against

fin_involvementsinteger

The number of conversations in which Fin AI Agent used this article, summed across all of the article's locales.

fin_resolutionsinteger

The number of conversations Fin AI Agent resolved using this article, summed across all of the article's locales.

fin_resolution_ratenumber (float)

The percentage of Fin AI Agent involvements that resulted in a resolution (fin_resolutions / fin_involvements * 100).

json

{
  "statistics": {
    "type": "article_statistics",
    "views": 10,
    "conversions": 0,
    "reactions": 10,
    "happy_reaction_percentage": 40,
    "neutral_reaction_percentage": 40,
    "sad_reaction_percentage": 0,
    "fin_involvements": 10,
    "fin_resolutions": 8,
    "fin_resolution_rate": 80
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?