getPostComments Documentation

Purpose

This node is designed to interface with Reddit's API to fetch comments for a specific post within a specified subreddit. It allows users to retrieve data about comments made on a post, including the post's metadata itself, facilitating further analysis or integration into applications that utilize discussions and engagement data from Reddit.

Settings

1. Subreddit

• Input Type: String
• Description: This setting specifies the subreddit from which to retrieve comments. If provided, it filters the comments to those belonging to the specified subreddit.
• Default Value: An empty string (''), which means no specific subreddit is applied.

2. Article ID

• Input Type: String
• Description: This setting expects the ID portion of the Reddit post URL to identify which post’s comments to retrieve. This setting is mandatory; if it’s missing, the function will return an error stating that the post/article ID is required.
• Default Value: An empty string (''), which does not suffice for a successful operation.

3. Sort

• Input Type: String
• Description: Indicates the sort order of the comments returned. It accepts options such as confidence, top, new, etc. Changing this setting affects the order in which comments are presented in the output.
• Default Value: 'confidence', which provides comments sorted based on the algorithm that Reddit uses to determine comment relevance.

4. Limit

• Input Type: Numeric
• Description: This controls the maximum number of comments to retrieve. Adjusting this will directly influence the number of comments returned in the output.
• Default Value: 50, which means that by default, the system is set to retrieve a maximum of 50 comments.

5. Depth

• Input Type: Numeric
• Description: This specifies how many levels of comment replies to include in the output. A higher value allows for deeper nesting of comments, whereas a lower value restricts the depth.
• Default Value: 5, indicating that by default, comments will be pulled up to 5 levels deep in the thread of replies.

How It Works

1. Input Handling: The logic first checks for any inputs that may have been provided. If inputs aren't specified, it defaults to configuration values. An essential check is implemented for the articleId, as it is required.

2. Integration Setup: It utilizes the integration connection to establish a connection with the Reddit API, preparing to fetch the data.

3. Data Retrieval: With a successful connection established, it makes a call to fetch the comments for the specified post, using the parameters defined (subreddit, articleId, sort, limit, and depth).

4. Output Processing: Upon receiving the results, the logic processes the response:

   • It distinguishes between post metadata and the actual comments.
   • It filters and structures the comments appropriately, discarding any non-comment entities.

5. Error Handling: If any errors occur during the API request, appropriate error messages are returned to the caller, ensuring robust error management.

Data Expectations

The node specifically expects:

• Inputs: The inputs are expected to be provided as an object with keys for subreddit, articleId, sort, limit, and depth.
• Output Structure: The output structure will contain:
  • data: An array of comment objects.
  • post: An object containing metadata about the original post.
  • count: A numeric value indicating how many comments were retrieved.

Use Cases & Examples

Use Case 1: Social Media Monitoring

Businesses can utilize this logic to monitor customer sentiments regarding their brand by analyzing comments on relevant subreddit posts.

Use Case 2: Content Analysis for Research

Researchers can retrieve and analyze comment sections from specific Reddit threads to study community behavior or language patterns, offering insights into social trends.

Example Configuration

Scenario: A content marketer wants to analyze comments on a popular post in the /r/technology subreddit to gauge public opinion on a recent tech release.

Sample Configuration:

{
    "inputs": {
        "subreddit": "technology",
        "articleId": "xxyz123", // replace with actual post ID
        "sort": "top",
        "limit": 100,
        "depth": 3
    },
    "config": {}
}

In this configuration, the user specifies the subreddit as "technology", the article ID (which could be obtained from the post link), requests the top comments, limits the retrieval to 100 comments, and sets the depth to 3 to allow some nested replies.