https://github.com/truesparrowsystems/brand-monitoring
Monitor the brand customer satisfaction
https://github.com/truesparrowsystems/brand-monitoring
Last synced: 4 months ago
JSON representation
Monitor the brand customer satisfaction
- Host: GitHub
- URL: https://github.com/truesparrowsystems/brand-monitoring
- Owner: TrueSparrowSystems
- License: mit
- Created: 2022-06-07T11:14:36.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-16T07:48:55.000Z (almost 3 years ago)
- Last Synced: 2024-11-06T18:56:09.959Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 4
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Brand Monitoring
Brand Monitor helps you understand your twitter audience better. This module provides you with number of promoters & detractors, [Net Promoter Score (NPS)](https://en.wikipedia.org/wiki/Net_promoter_score) and the total number of tweets within a particular time duration.
## Approach
Using [Twitter API](https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions), we gather the tweet mentions of a particular account. These tweets are searched within a given time duration. Sentiments analysis of these tweets is done using [AWS Comprehend](https://docs.aws.amazon.com/comprehend/latest/dg/API_BatchDetectSentiment.html), to gather promoters and detractors.
## Prerequisites
- [Twitter Developer App](https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api)
- [AWS Comprehend](https://docs.aws.amazon.com/comprehend/index.html)
## Install
```shell script
npm install @plgworks/brand-monitoring --save
```
## Initialize
```js
const BrandMonitoring = require('@plgworks/brand-monitoring');
const twitterApiConfig = {
bearerToken: ''
};
const awsComprehendConfig = {
region: '',
accessKeyId: '',
secretAccessKey: ''
};
const brandmonitoring = new BrandMonitoring(twitterApiConfig, awsComprehendConfig);
```
### Initialization Params
- **twitterApiConfig** Object which has following key(s).
- **bearerToken**: Used to have a more secure point of entry to use Twitter APIs, and can be obtained from the developer portal inside the keys and tokens section of your Twitter App's settings.
- **awsComprehendConfig** Object which contains AWS Comprehend access credentials. It has following keys.
- **region**: AWS region.
- **accessKeyId**: AWS uses this to verify your identity and grant or deny you access to specific resources.
- **secretAccessKey**: AWS uses this to verify your identity and grant or deny you access to specific resources.
## Get Statistics
Once the Brand Monitoring module is initialized, the next step is to perform sentimental analysis on tweets.
```js
const reportParams = {
twitterUsername: '',
startTimestamp: '',
endTimestamp: '',
awsThreshold: {
positive: '',
negative: ''
}
};
const stats = await brandmonitoring.getStats(reportParams).catch(function(err) {
console.log('Error:: --------- ', err);
});
```
**reportParams** Object with following keys.
- **twitterUsername**: Twitter username for which you want to generate the stats. Example: @PLGWorks
- **startTimestamp**: Start timestamp used to search tweets
- **endTimestamp**: End timestamp used to search tweets
- **awsThreshold**: (Optional) Object which contains AWS Comprehend sentiment score threshold values. Default positive value is 0.55 and negative value is 0.40
- **positive**: Range is from 0 to 1. If sentiment is positive and the sentiment score is greater than this threshold, then we consider the tweet as positive (i.e. promoter).
- **negative**: Range is from 0 to 1. If sentiment is negative and the sentiment score is greater than this threshold, then we consider the tweet as negative (i.e. detractor).
## Success Response
`getStats` method returns a promise which returns a stats object as shown in the following.
```js
console.log(stats);
// stats is a object which looks like this:
// {
// nps: -8.333333333333336,
// promotersCount: 14,
// detractorsCount: 21,
// totalTweets: 84
// }
```