Updating README

README.md

@@ -169,6 +169,187 @@ DATABASE_NAME="pegabot"
 5. Run migrations with `sequelize-cli db:migrate`
 
 
+## Endpoints
+
+### `/botometer`
+Get analysis with only main indexes.
+
+**Method**: `GET`
+
+**Example**: `/botometer?profile=twitter&search_for=profile`
+
+
+**Required parameters**
+- `profile` (STRING): user handle that will be analyzed;
+
+- `search_for` (STRING): only one value allowed `profile`
+
+**Response**
+```
+{
+  "metadata": {
+    "count": 1
+  },
+  "profiles": [
+    {
+      "username": "twitter",
+      "url": "https://twitter.com/twitter",
+      "avatar": "http://pbs.twimg.com/profile_images/1354479643882004483/Btnfm47p_normal.jpg",
+      "language_dependent": {
+        "sentiment": {
+          "value": 0.57
+        }
+      },
+      "language_independent": {
+        "friend": null,
+        "temporal": 0.32269754443513865,
+        "network": 0.4103015075376884,
+        "user": 0
+      },
+      "bot_probability": {
+        "all": 0.18614272171040389,
+        "info": "<p>Um dos critérios que mais teve peso na análise foi o índice de Perfil</p>"
+      },
+      "user_profile_language": null
+    }
+  ]
+}
+```
+
+### `/analyze`
+Get analysis with main indexes and subindexes.
+
+**Method**: `GET`
+
+**Example**: `/analyze?profile=twitter&search_for=profile`
+
+
+**Required parameters**
+- `profile` (STRING): user handle that will be analyzed;
+
+- `search_for` (STRING): only one value allowed `profile`
+
+**Response**
+```
+{
+  "root": {
+    "profile": {
+      "handle": "twitter",
+      "link": "https://twitter.com/twitter",
+      "label": "Perfil",
+      "description": "<p>Algumas das informações públicas dos perfis consideradas na análise do PEGABOT são o nome do perfil do usuário, e quantos caracteres ele possui, quantidade de perfis seguidos (following) e seguidores (followers), texto da descrição do perfil, número de postagens (tweets) e favoritos. Após coletar as informações, os algoritmos do PEGABOT processam e transformam os dados recebidos em variáveis que compõem o cálculo final de probabilidade.</p>",
+      "figure": "",
+      "analyses": [
+        {
+          "title": "SELO DE VERIFICAÇÃO",
+          "description": "A presença do selo de verificação oferecido pelo Twitter influencia positivamente nos resultados, uma vez que a plataforma possui um procedimento manual para validar a identidade desses usuários.",
+          "summary": "<p>Usuário verificado</p>",
+          "conclusion": 0
+        }
+      ]
+    },
+    "network": {
+      "description": "<p>O algoritmo do PegaBot coleta uma amostra da linha do tempo do usuário, identificando hashtags utilizadas e menções ao perfil para realizar suas análises. O objetivo é identificar características de distribuição de informação na rede da conta analisada.</p>O índice de rede avalia se o perfil possui uma frequência alta de repetições de menções e hashtags. No caso de um bot de spams, geralmente se usam as mesmas hashtags/menções, e é isso que esse índice observa. Por exemplo, se 50 hashtags são usadas e são 50 hashtags diferentes, não é suspeito, mas se só uma hashtag é usada 100% das vezes, então é muito suspeito.</p>",
+      "label": "Rede",
+      "analyses": [
+        {
+          "title": "DISTRIBUIÇÃO DAS HASHTAGS",
+          "description": "<p>Calcula o tamanho da distribuição dessas hashtags na rede. Ou seja, avalia se a utilização de hashtags do perfil apresenta uma frequência anormal.</p><p>Quanto mais próximo de 0% menor a probabilidade de ser um comportamento de bot.</p>",
+          "summary": "<p>Total: 10. Únicas: 3</p>",
+          "conclusion": "0.70",
+          "hashtags": []
+        },
+        {
+          "title": "DISTRIBUIÇÃO DAS MENÇÕES",
+          "description": "<p>Calcula o tamanho da distribuição de menções ao perfil do usuário na rede. Ou seja, avalia as menções realizadas pelo perfil com base em sua frequência.</p><p>Quanto mais próximo de 0% menor a probabilidade de ser um comportamento de bot.</p>",
+          "summary": "<p>Total: 14. Únicas: 14</p>",
+          "conclusion": "0.00",
+          "mentions": []
+        },
+        {
+          "title": "HASHTAGS E MENÇÕES",
+          "description": "HASHTAGS E MENÇÕES",
+          "summary": "<p>Calculamos o score distríbuido (0.35) e o tamanho da rede (0.06)</p>",
+          "conclusion": "0.41",
+          "stats": []
+        }
+      ]
+    },
+    "emotions": {
+      "description": "<p>Após coletar os dados, os algoritmos do PEGABOT fornecem uma pontuação, em uma escada de -5 a 5m de cada uma das palavras dos tweets coletados. A classificação se baseia em uma biblioteca, onde, cada uma das palavras possui uma pontuação, sendo considerada mais ou menos negativa, positiva ou neutra. Assim, ao final da classificação, calcula-se a pontuação média para a quantidade de palavras positivas, negativas e neutras utilizadas pelo usuário.</p>",
+      "label": "Sentimentos",
+      "analyses": [
+        {
+          "summary": "<p>o perfil tem pontuação de 0.57, classificando-se como positivo.</p>",
+          "conclusion": 0.57,
+          "samples": {
+            "title": "VEJA AQUI O EXEMPLO DE 3 TWEETS DO USUÁRIO",
+            "list": []
+          }
+        }
+      ]
+    }
+  }
+}
+```
+
+### `/botometer-buld`
+Bulk process for first endpoint.
+**The params for this request must be sent as JSON**
+
+**Method**: `GET`
+**Example**: `/botometer-bulk`
+
+**Required headers**
+- apiKey (string): Must be set on the `.env` file, with the `BULK_API_KEY` key;
+
+**Required parameters**
+- `profiles` (STRING ARRAY): Array containing the profiles that will be analyzed.
+  - **MAX ARRAY SIZE**: 50
+
+**Optional parameters**
+
+- `is_admin` (BOOLEAN): used to identify requests that are coming from the Pegabot admin interface;
+- `twitter_api_consumer_key` (STRING): Consumer key that will be used to instantiate a Twitter API client;
+  - **Must be sent alongside `twitter_api_consumer_secret`**
+- `twitter_api_consumer_secret` (STRING): Consumer key that will be used to instantiate a Twitter API client;
+  - **Must be sent alongside `twitter_api_consumer_key`**
+
+**Response**
+```
+{
+  "analyses_count": 1,
+  "analyses": [
+    {
+      "twitter_user_data": {
+        "id": "111111111111111111111111111",
+        "handle": "@twitter",
+        "user_name": "Twitter",
+        "url": "https://twitter.com/twitter",
+        "avatar": "https://twitter.com",
+        "created_at": "Thu Apr 09 21:32:54 +0000 2020"
+      },
+      "twitter_user_meta_data": {
+        "tweet_count": 2176,
+        "follower_count": 304,
+        "following_count": 537,
+        "hashtags": [],
+        "mentions": []
+      },
+      "pegabot_analysis": {
+        "user_index": 0.2755072802592182,
+        "temporal_index": 0.09934108527131784,
+        "network_index": 0.7706060606060606,
+        "sentiment_index": 0.6,
+        "bot_probability": 0.34909088522731935
+      },
+      "metadata": {
+          "used_cache": true
+      }
+    }
+  ]
+}
+```
 
 **spottingbot is a project inspired by [Botometer](https://botometer.iuni.iu.edu/#!/), an [OSoMe](https://osome.iuni.iu.edu/) project.**