Appstore

1. Overview

The Appstore tool provides an interface to the Apple App Store Connect API, allowing developers to programmatically manage their app's customer reviews. It enables direct interaction with review data, facilitating automated monitoring, analysis, and response workflows.

With the GoInsight Appstore node, you can integrate customer feedback management directly into your automated processes. This includes:

• Fetching and Listing Reviews: Retrieve a list of all customer reviews for your app, with powerful filtering and sorting capabilities. You can also fetch the complete details of a single, specific review by its ID.
• Responding to Reviews: Engage with your users by programmatically posting developer responses to their reviews.

2. Prerequisites

Before using this node, you need to have a valid Apple Developer account with access to App Store Connect. You will also need appropriate permissions (such as Admin or App Manager) to generate the necessary API keys for authentication.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This node allows you to perform operations related to customer reviews for your applications.

Operation Details

Get a Review

Retrieve detailed information for a specific customer review from Apple App Store Connect using API Key authentication. This tool allows you to fetch complete review details including rating, content, reviewer information, and optional developer response for a single review by its ID.

Input Parameters:

• ReviewId: The unique identifier of the customer review to retrieve

Options:

• IncludeResponse: Whether to include developer response information in the result

Output:

• Id (string): Unique identifier for the review
• Title (string): Title/headline of the review
• Body (string): Full text content of the customer's review
• Rating (number): Star rating given by the reviewer (1-5 stars)
• CreatedDate (string): ISO 8601 timestamp when the review was created
• Territory (string): Country/territory code where the review was submitted
• ReviewerNickname (string): Display name chosen by the reviewer
• AppStoreVersionId (string): Unique identifier of the app version being reviewed
• ResponseId (string): Unique identifier for the developer response
• ResponseBody (string): Text content of the developer's reply to the review
• ResponseLastModifiedDate (string): ISO 8601 timestamp when the response was last modified
• ResponseState (string): Current publication state of the response
• StatusCode (number): HTTP status code
• ErrorMessage (string): Error message if any

List Reviews

Retrieve a list of customer reviews for a specific app from Apple App Store Connect using API Key authentication. This tool allows you to fetch customer reviews including ratings, review content, reviewer information, and optional developer responses with filtering, sorting, and pagination capabilities.

Input Parameters:

• AppId: The Apple ID of the app for which to retrieve reviews

Options:

• Limit: Maximum number of reviews to return (1-200)
• FilterRating: Filter reviews by specific rating (1-5)
• FilterTerritory: Filter reviews by territory/country code
• Sort: Sort reviews by field
• IncludeResponse: Whether to include developer responses in the results
• NextLink: Next page link for retrieving the next page of results

Output:

• Reviews (string-array): List of customer reviews from Apple App Store Connect
• TotalCount (number): Total number of reviews returned
• NextLink (string): Next page link for pagination
• StatusCode (number): HTTP status code
• ErrorMessage (string): Error message if any

Reply a Review

Create a developer response to a specific customer review in Apple App Store Connect using API Key authentication. This tool allows developers to reply to customer reviews, providing customer support and engagement directly through the App Store review system.

Input Parameters:

• ReviewId: The unique identifier of the customer review to reply to
• ResponseBody: The text content of your response to the customer review

Output:

• ReplyId (string): Unique identifier of the created response
• ResponseBody (string): Text content of the developer's response
• LastModifiedDate (string): Last modification date of the response
• State (string): Current state of the response
• StatusCode (number): HTTP status code
• ErrorMessage (string): Error message if any

5. Example Usage

This section will guide you through creating a simple workflow to retrieve the latest reviews for one of your apps.

The workflow will consist of three nodes: Start -> Appstore: List Reviews -> Answer.

1. Add the Appstore Node
   • In the workflow canvas, click the "+" icon to add a new node.
   • In the pop-up panel, select the "Tools" tab.
   • Find and select "Appstore" from the list of tools.
   • From the list of supported operations for Appstore, click on "List Reviews" to add the node to your canvas.
2. Configure the Node
   • Click on the newly added "List Reviews" node to open its configuration panel on the right.
   • Credentials Configuration: At the top of the panel, find the credentials field. Click the dropdown menu and select your pre-configured Appstore credential.
   • Parameter Configuration: Fill in the input parameters to specify which reviews to fetch.
   • AppId: Enter the unique Apple ID for your application. For example, 1234567890. This is a required field.
   • Limit: You can optionally specify the maximum number of reviews to return in a single run. The default is 50.
   • FilterRating: To see only 1-star reviews, you could enter 1 here.
   • Sort: You can sort the results. For example, enter -createdDate to get the newest reviews first.
3. Run and Verify
   • Once all required parameters are correctly filled, any error indicators on the workflow canvas will disappear.
   • Click the "Run" button in the top-right corner of the canvas to execute the workflow.
   • After a successful execution, you can click the logs icon in the top-right corner to view the detailed inputs and outputs of the node, verifying that the reviews were retrieved successfully.

After completing these steps, your workflow is fully configured. When executed, it will fetch a list of reviews from the App Store Connect API based on your criteria.

6. FAQs

Q: Why am I getting a 401 Unauthorized or 403 Forbidden error?

A: This typically indicates an issue with your API credentials. Please check the following:

• API Key: Ensure your API Key ID and the private key file are correct and have not expired.
• Issuer ID: Verify that the Issuer ID in your credential configuration is correct.
• Permissions: Confirm that the API key has the necessary roles and permissions (e.g., "Customer Support" or "App Manager") in App Store Connect to access review data.

Q: How do I find my App's Apple ID?

A: You can find the Apple ID in the URL of your app's page on the App Store. It is the number that follows "id" in the URL. For example, in https://apps.apple.com/us/app/your-app-name/id1234567890, the App ID is 1234567890.

Q: The List Reviews operation returned an empty list, but I know there are reviews. What's wrong?

A: This could be due to overly restrictive filters. Double-check the values you've provided for FilterRating and FilterTerritory. Also, confirm that the AppId is correct and does not contain any typos.

7. Official Documentation

For more in-depth information about the capabilities and technical details of the API, please refer to the Appstore Official API Documentation.