Generate Product Review Sentiment API - ApyHub

Generate Product Review Sentiment API

Artificial IntelligenceE-commerce Quick ToolsSmart Generation#ecommerce#introduction#product
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Product Review Sentiment Analysis API parses the customer's product review and provides its sentiment (POSITIVE/NEGATIVE/NEUTRAL) with a score between 0-100%. This API is perfect for generating sentiment reports for any online store, offering valuable insights into customer feedback.
Developers can use this API to enhance e-commerce platforms, customer feedback systems, or sentiment analysis tools. It automates the analysis process, helping businesses understand customer opinions and improve their offerings. Use cases include creating sentiment reports, enhancing customer service strategies, and refining product descriptions based on customer feedback.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Generate Product Review Sentiment Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/ecommerce/review_sentiment

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/ecommerce/review_sentiment' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "I got a variant of this laptop 4090 with miniLED and surprise, it does not work in SDR and if you enable HDR to make the miniLED work it causes so much back light bleed you can see light follow the mouse and around the the text. I found out Razer has two variants of the panel one called BOE and one called AUO. The BOE i got is whats broken, and they have the audacity to sell an inferior version of the laptop (early 2023) with a huge faulty screen.refer to my images to see how bad the MiniLED looks when HDR is enable, and without HDR well, the miniLED simply does not work. Great job Razer, will be returning this as I have no way of telling if I get the BOE or AUO variant of the screen. Do some research on this if you going for the MiniLED version.Other than the screen which is one of main reasons you likely buying this, the performance is amazing and temps are great."
8
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProvide review text to analyze the sentiment.
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/ecommerce/review_sentiment/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles