{"info":{"_postman_id":"8e239ac3-f169-498a-ae4c-b52bea5a85f1","name":"API Aumento","description":"

To get started with aumento.ai you only need your API access TOKEN.
Aumento works with the concept of a collection of data, every time series is a collection in Aumento and must be identified with a unique id for your organization.

Contact email: orrego@gmail.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25363166","collectionId":"8e239ac3-f169-498a-ae4c-b52bea5a85f1","publishedId":"2s8ZDU64nb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"40C1C1"},"publishDate":"2023-01-16T18:01:15.000Z"},"item":[{"name":"Collections","item":[{"name":"Single Observation","id":"8be47157-2a45-41b7-85a8-96e2fbceb223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/api/observation?token=&value=&id=&time=&group=","description":"

Receives an observation associated to a time series collection.

If the request was succesful, the response will show basic information about the collection such as min, max, average and number of samples.

\n","urlObject":{"protocol":"https","path":["api","observation"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization

Example: 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":""},{"description":{"content":"

(Required) Value of the observation

Example: 78.9

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.

Example: sales-daily

\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"

(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.

Example: 1617835190875

\n","type":"text/plain"},"key":"time","value":""},{"description":{"content":"

(Optional) Collection belongs to this group. Useful for group summaries.

Example: sales

\n","type":"text/plain"},"key":"group","value":""}],"variable":[]}},"response":[{"id":"a5a655b6-efdd-4104-844f-dfaaba0e8364","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"token","value":"2a439044-7b44-49a9-9f19-3f3d8cd072f2","description":"(Required) API access token for your organization","type":"text","disabled":true},{"key":"value","value":"78.9","description":"(Required) Value of the observation","type":"text","disabled":true},{"key":"id","value":"sales-daily","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.","type":"text","disabled":true},{"key":"time","value":"1617835190875","description":"(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.","type":"text","disabled":true},{"key":"group","value":"sales","description":"(Optional) Collection belongs to this group. Useful for group summaries.","type":"text","disabled":true}],"url":{"raw":"https://api.aumento.ai/api/observation?token=ACCESS_TOKEN&value=350&id=sales-daily&time=&group=sales","protocol":"https","host":["api","aumento","ai"],"path":["api","observation"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":"350","description":"(Required) Value of the observation\n\nExample: 78.9"},{"key":"id","value":"sales-daily","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"time","value":"","description":"(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.\n\nExample: 1617835190875"},{"key":"group","value":"sales","description":"(Optional) Collection belongs to this group. Useful for group summaries.\n\nExample: sales"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 16 Jan 2023 17:53:59 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Cache","value":"MISS from proxy.cec.uchile.cl"},{"key":"X-Cache-Lookup","value":"MISS from proxy.cec.uchile.cl:8000"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 proxy.cec.uchile.cl (squid/3.5.20)"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"collection\": \"sales-daily\",\n \"group\": \"sales\",\n \"day\": \"2023-01-16\",\n \"nsamples\": 4,\n \"min\": 350,\n \"max\": 900,\n \"avg\": 537.5,\n \"value\": 350\n}"},{"id":"82a47725-34c2-4d75-923d-90eb7bcdad4a","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"token","value":"2a439044-7b44-49a9-9f19-3f3d8cd072f2","description":"(Required) API access token for your organization","type":"text","disabled":true},{"key":"value","value":"78.9","description":"(Required) Value of the observation","type":"text","disabled":true},{"key":"id","value":"sales-daily","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.","type":"text","disabled":true},{"key":"time","value":"1617835190875","description":"(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.","type":"text","disabled":true},{"key":"group","value":"sales","description":"(Optional) Collection belongs to this group. Useful for group summaries.","type":"text","disabled":true}],"url":{"raw":"https://api.aumento.ai/api/observation?token=ACCESS_TOKEN&value=&id=&time=&group=","protocol":"https","host":["api","aumento","ai"],"path":["api","observation"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":"","description":"(Required) Value of the observation\n\nExample: 78.9"},{"key":"id","value":"","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"time","value":"","description":"(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.\n\nExample: 1617835190875"},{"key":"group","value":"","description":"(Optional) Collection belongs to this group. Useful for group summaries.\n\nExample: sales"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 16 Jan 2023 17:55:44 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Cache","value":"MISS from proxy.cec.uchile.cl"},{"key":"X-Cache-Lookup","value":"MISS from proxy.cec.uchile.cl:8000"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 proxy.cec.uchile.cl (squid/3.5.20)"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"8be47157-2a45-41b7-85a8-96e2fbceb223"},{"name":"Collection List","id":"033392ae-ef7f-42fb-bead-4ef875502b1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/api/collections?token=","description":"

Returns a list of all collections associated with your access token.

\n","urlObject":{"protocol":"https","path":["api","collections"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization

Example: 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":""}],"variable":[]}},"response":[{"id":"36c9dcf5-fbc0-476e-8fdb-78ea7362b448","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/collections?token=ACCESS_TOKEN","protocol":"https","host":["api","aumento","ai"],"path":["api","collections"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Jan 2023 21:59:38 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"sales-daily\",\n \"name\": \"sales-daily\",\n \"description\": null,\n \"limitBuffer\": 1000,\n \"group\": \"sales\",\n \"updated\": \"2023-01-16T17:53:36Z\",\n \"created\": \"2023-01-16T17:53:36Z\"\n },\n {\n \"id\": \"prueba2\",\n \"name\": \"prueba2\",\n \"description\": null,\n \"limitBuffer\": 1000,\n \"group\": \"grupo-prueba\",\n \"updated\": \"2023-01-12T20:54:30Z\",\n \"created\": \"2023-01-12T20:54:30Z\"\n },\n {\n \"id\": \"prueba1\",\n \"name\": \"prueba1\",\n \"description\": null,\n \"limitBuffer\": 1000,\n \"group\": \"grupo-prueba\",\n \"updated\": \"2023-01-12T20:47:53Z\",\n \"created\": \"2023-01-12T20:47:53Z\"\n }\n]"},{"id":"3cc15fad-1dfe-4fc7-b6f6-c4ab6c532ebc","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/collections?token=ACCESS_TOKEN","protocol":"https","host":["api","aumento","ai"],"path":["api","collections"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Jan 2023 22:00:04 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"033392ae-ef7f-42fb-bead-4ef875502b1c"}],"id":"f39c18f1-49ce-4950-9e52-58cadca5d291","description":"

Collections are the sets of data on a time series, each collection belongs to a group, groups are useful for summarizing the information within its collections.

Example of a basic Group-Collection structure:

Group: Sales
- Collection: Sales-Daily
  - Observation 1
  - Observation 2
  - ...
  \n
- Collection: Sales-Weekly
- Collection: Sales-Monthly
\n

\n","_postman_id":"f39c18f1-49ce-4950-9e52-58cadca5d291"},{"name":"Anomaly Detection","item":[{"name":"Outlier Observation","id":"327328a1-d954-4590-91ba-c4852fae0849","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/api/outlier?token=ACCESS_TOKEN&value=&id=&start=2023-01-13&end&group=sales","description":"

Receives a new observation value and detects if it is an anomaly in this time series collection, you can set the dates between where you want to detect this outlier. Returns json object with parameter outlier. If outlier == 1, received value is a high outlier, if outlier == -1, received value is a low outlier, if ourlier == 0, received value is normal.

\n","urlObject":{"protocol":"https","path":["api","outlier"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization

Example: 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":"ACCESS_TOKEN"},{"description":{"content":"

(Required) Value of the observation

Example: 78.9

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.

Example: sales-daily

\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"

(Optional) Start date of the time series data to use for outlier detection. If not given, will use last month as default.

Example : 2012-03-20

\n","type":"text/plain"},"key":"start","value":"2023-01-13"},{"description":{"content":"

(Optional) End date of the time series data to use for outlier detection. If not given, will use today as default.

Example : 2012-04-20

\n","type":"text/plain"},"key":"end","value":null},{"description":{"content":"

(Optional) Collection belongs to this group. Useful for group summaries.

Example: sales

\n","type":"text/plain"},"key":"group","value":"sales"}],"variable":[]}},"response":[{"id":"228d9a1c-ad0b-43af-923f-905cb2c70e96","name":"200 OK: Outlier == 1","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/outlier?token=ACCESS_TOKEN&value=1000&id=sales-daily&start=2023-01-13&end&group=sales","protocol":"https","host":["api","aumento","ai"],"path":["api","outlier"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":"1000","description":"(Required) Value of the observation\n\nExample: 78.9"},{"key":"id","value":"sales-daily","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"start","value":"2023-01-13","description":"(Optional) Start date of the time series data to use for outlier detection. If not given, will use last month as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use for outlier detection. If not given, will use today as default.\n\nExample : 2012-04-20"},{"key":"group","value":"sales","description":"(Optional) Collection belongs to this group. Useful for group summaries.\n\nExample: sales"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Jan 2023 22:48:12 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"std\": 257.37901243876905,\n \"max\": 900,\n \"highRange\": 831.25,\n \"outlier\": 1,\n \"start\": \"2023-01-13T00:00:00Z\",\n \"sum\": 2680,\n \"collection\": \"sales-daily\",\n \"n\": 14,\n \"percentile25\": 50,\n \"min\": 20,\n \"variance\": 66243.95604395603,\n \"percentile75\": 362.5,\n \"mean\": 191.42857142857142,\n \"end\": \"2023-01-17T22:48:11Z\",\n \"lowRange\": -418.75,\n \"value\": 1000\n}"},{"id":"e8775177-5351-4150-b0ac-4c3239e98002","name":"200 OK: Outlier == 0","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/outlier?token=ACCESS_TOKEN&value=60&id=sales-daily&start=2023-01-13&end&group=sales","protocol":"https","host":["api","aumento","ai"],"path":["api","outlier"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":"60","description":"(Required) Value of the observation\n\nExample: 78.9"},{"key":"id","value":"sales-daily","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"start","value":"2023-01-13","description":"(Optional) Start date of the time series data to use for outlier detection. If not given, will use last month as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use for outlier detection. If not given, will use today as default.\n\nExample : 2012-04-20"},{"key":"group","value":"sales","description":"(Optional) Collection belongs to this group. Useful for group summaries.\n\nExample: sales"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Jan 2023 22:48:43 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"std\": 324.1883638227862,\n \"max\": 1000,\n \"highRange\": 925,\n \"outlier\": 0,\n \"start\": \"2023-01-13T00:00:00Z\",\n \"sum\": 3680,\n \"collection\": \"sales-daily\",\n \"n\": 15,\n \"percentile25\": 50,\n \"min\": 20,\n \"variance\": 105098.0952380952,\n \"percentile75\": 400,\n \"mean\": 245.33333333333331,\n \"end\": \"2023-01-17T22:48:43Z\",\n \"lowRange\": -475,\n \"value\": 60\n}"},{"id":"093c75a3-867c-4716-b074-9e71d27c6d31","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/outlier?token=ACCESS_TOKEN&value=&id=&start=2023-01-13&end&group=sales","protocol":"https","host":["api","aumento","ai"],"path":["api","outlier"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":"","description":"(Required) Value of the observation\n\nExample: 78.9"},{"key":"id","value":"","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"start","value":"2023-01-13","description":"(Optional) Start date of the time series data to use for outlier detection. If not given, will use last month as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use for outlier detection. If not given, will use today as default.\n\nExample : 2012-04-20"},{"key":"group","value":"sales","description":"(Optional) Collection belongs to this group. Useful for group summaries.\n\nExample: sales"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 17 Jan 2023 22:49:19 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"327328a1-d954-4590-91ba-c4852fae0849"}],"id":"570f7568-fbb1-454c-b8e2-0307959fa842","description":"

Anomaly detections are a deeper analysis in an observation from a collection in a certain period of time. This observation will be cataloged as an outlier if it is an anomaly with respect all the data at the selected time.

Anomaly detections also bring more information of the time series data such as standard deviation, variance and quartiles based on the selected difference on date.

\n","_postman_id":"570f7568-fbb1-454c-b8e2-0307959fa842"},{"name":"Forecasting","item":[{"name":"ARIMA Forecast","id":"22deea10-7322-4df3-81c0-87a1c4eebb79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/api/arima?token=ACCESS_TOKEN&id=COLLECTION_ID&p&d&q&m&forecastSize&start&end","description":"

Forecast of a day time series value using Autoregressive integrated moving average ARIMA. Details on the ARIMA model and its parameters can be found in https://en.wikipedia.org/wiki/Autoregressive_integrated_moving_average

\n","urlObject":{"protocol":"https","path":["api","arima"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization

Example: 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":"ACCESS_TOKEN"},{"description":{"content":"

(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.

Example: sales-daily

\n","type":"text/plain"},"key":"id","value":"COLLECTION_ID"},{"description":{"content":"

(Optional) The p value in ARIMA model. Represents the number of lagged values to use on the model. Default value is 3.

Example : 3

\n","type":"text/plain"},"key":"p","value":null},{"description":{"content":"

(Optional) The d value in ARIMA model. Represents the number of time to differentiate the model to have a stationary model (white noise). Default value is 0.

Example : 3

\n","type":"text/plain"},"key":"d","value":null},{"description":{"content":"

(Optional) The q value in ARIMA model. Represents the number of lagged forecast errors. Default value is 3.

Example : 3

\n","type":"text/plain"},"key":"q","value":null},{"description":{"content":"

(Optional) The m value in ARIMA model, number of periods in each season. Default value is 0.

Example : 0

\n","type":"text/plain"},"key":"m","value":null},{"description":{"content":"

(Optional) Number of future days to forecast. Default value is 10.

Example : 10

\n","type":"text/plain"},"key":"forecastSize","value":null},{"description":{"content":"

(Optional) Start date of the time series data to use. If not given, will use last month as default.

Example : 2012-03-20

\n","type":"text/plain"},"key":"start","value":null},{"description":{"content":"

(Optional) End date of the time series data to use. If not given, will use today as default.

Example : 2012-04-20

\n","type":"text/plain"},"key":"end","value":null}],"variable":[]}},"response":[{"id":"e274a819-fb8f-47f4-a0d4-aacc11e555b0","name":"200 OK (p,d,q) default","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/arima?token=ACCESS_TOKEN&id=COLLECTION_ID&p&d&q&m&forecastSize&start&end","protocol":"https","host":["api","aumento","ai"],"path":["api","arima"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"id","value":"COLLECTION_ID","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"p","value":null,"description":"(Optional) The p value in ARIMA model. Represents the number of lagged values to use on the model. Default value is 3.\n\nExample : 3"},{"key":"d","value":null,"description":"(Optional) The d value in ARIMA model. Represents the number of time to differentiate the model to have a stationary model (white noise). Default value is 0.\n\nExample : 3"},{"key":"q","value":null,"description":"(Optional) The q value in ARIMA model. Represents the number of lagged forecast errors. Default value is 3.\n\nExample : 3"},{"key":"m","value":null,"description":"(Optional) The m value in ARIMA model, number of periods in each season. Default value is 0.\n\nExample : 0"},{"key":"forecastSize","value":null,"description":"(Optional) Number of future days to forecast. Default value is 10.\n\nExample : 10"},{"key":"start","value":null,"description":"(Optional) Start date of the time series data to use. If not given, will use last month as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use. If not given, will use today as default.\n\nExample : 2012-04-20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 18 Jan 2023 21:49:57 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"forecast\": [\n 113.01985273204374,\n 109.89702607940792,\n 101.19059198129769,\n 99.83186514606834,\n 100.97268138122564,\n 100.70806857204306,\n 100.52376092235193,\n 100.62001439242096,\n 100.62587279478068,\n 100.60519420502128\n ],\n \"uppers\": [\n 1382.7023307751108,\n 1379.5795041224749,\n 1371.7674088970691,\n 1372.927138702864,\n 1381.9030464628715,\n 1381.7034939722314,\n 1381.6806465646805,\n 1381.8586685227938,\n 1381.8967618698966,\n 1381.8805123816144\n ],\n \"lowers\": [\n -1156.6626253110232,\n -1159.7854519636592,\n -1169.3862249344736,\n -1173.2634084107274,\n -1179.9576837004204,\n -1180.2873568281454,\n -1180.6331247199769,\n -1180.618639737952,\n -1180.6450162803353,\n -1180.670123971572\n ],\n \"rmse\": 647.8090863190142,\n \"nsample\": 18,\n \"start\": \"2022-12-18T21:49:56Z\",\n \"end\": \"2023-01-18T21:49:56Z\",\n \"property\": \"max\"\n}"},{"id":"806de96d-dcee-457e-b6b6-c18fec861468","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/arima?token=&id=&p&d&q&m&forecastSize&start&end","protocol":"https","host":["api","aumento","ai"],"path":["api","arima"],"query":[{"key":"token","value":"","description":"(Required) API access token for your organization\n\nExample: 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"id","value":"","description":"(Required) id of the collection where to add this new observation value. Must be unique. If collection does not exist, it will be created and this observation added.\n\nExample: sales-daily"},{"key":"p","value":null,"description":"(Optional) The p value in ARIMA model. Represents the number of lagged values to use on the model. Default value is 3.\n\nExample : 3"},{"key":"d","value":null,"description":"(Optional) The d value in ARIMA model. Represents the number of time to differentiate the model to have a stationary model (white noise). Default value is 0.\n\nExample : 3"},{"key":"q","value":null,"description":"(Optional) The q value in ARIMA model. Represents the number of lagged forecast errors. Default value is 3.\n\nExample : 3"},{"key":"m","value":null,"description":"(Optional) The m value in ARIMA model, number of periods in each season. Default value is 0.\n\nExample : 0"},{"key":"forecastSize","value":null,"description":"(Optional) Number of future days to forecast. Default value is 10.\n\nExample : 10"},{"key":"start","value":null,"description":"(Optional) Start date of the time series data to use. If not given, will use last month as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use. If not given, will use today as default.\n\nExample : 2012-04-20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 18 Jan 2023 21:56:45 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"22deea10-7322-4df3-81c0-87a1c4eebb79"},{"name":"Regression Forecast","id":"6821a93f-ae9b-4715-b0eb-7707ccb2f44c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/api/regression?token=ACCESS_TOKEN&x=DATE_FORECAST&id=COLLECTION_ID&start&end","description":"

Forecast of a time series value using linear regression on past data of collection. You can find more information here https://en.wikipedia.org/wiki/Linear_regression.

\n","urlObject":{"protocol":"https","path":["api","regression"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization.

Example : 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":"ACCESS_TOKEN"},{"description":{"content":"

(Required) The day to predict based on this collection data using formula y = intercept + slope*x

Example : 2021-09-09

\n","type":"text/plain"},"key":"x","value":"DATE_FORECAST"},{"description":{"content":"

(Required) id of the collection. Must be unique. If it does not exist, it will be created

Example : sales-daily

\n","type":"text/plain"},"key":"id","value":"COLLECTION_ID"},{"description":{"content":"

(Optional) Start date of the time series data to use. If not given, will use last month as default.

Example : 2012-03-20

\n","type":"text/plain"},"key":"start","value":null},{"description":{"content":"

(Optional) End date of the time series data to use. If not given, will use today as default.

Example : 2012-04-20

\n","type":"text/plain"},"key":"end","value":null}],"variable":[]}},"response":[{"id":"7a2e0339-e6ba-4b2a-b5f6-4e042bcf2c61","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/regression?token=ACCESS_TOKEN&x=2023-01-20&id=prueba1&start&end","protocol":"https","host":["api","aumento","ai"],"path":["api","regression"],"query":[{"key":"token","value":"ACCESS_TOKEN"},{"key":"x","value":"2023-01-20"},{"key":"id","value":"prueba1"},{"key":"start","value":null},{"key":"end","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 18 Jan 2023 21:59:01 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"collection\": \"prueba1\",\n \"y\": 92.83089649599424,\n \"targetDay\": \"2023-01-20\",\n \"slope\": 2.0543358593013513e-8,\n \"intercept\": -34300.3012805735,\n \"nsamples\": 51,\n \"r\": 0.03828570329749542,\n \"rsquare\": 0.0014657950769838518,\n \"function\": \"y = intercept + slope*x\"\n}"},{"id":"89dedb4e-3e79-4244-a8db-bd6b76a74cd2","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/api/regression?token=ACCESS_TOKEN&x=DATE_FORECAST&id=COLLECTION_ID&start&end","protocol":"https","host":["api","aumento","ai"],"path":["api","regression"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization.\n\nExample : 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"x","value":"DATE_FORECAST","description":"(Required) The day to predict based on this collection data using formula y = intercept + slope*x\n\nExample : 2021-09-09"},{"key":"id","value":"COLLECTION_ID","description":"(Required) id of the collection. Must be unique. If it does not exist, it will be created\n\nExample : sales-daily"},{"key":"start","value":null,"description":"(Optional) Start date of the time series data to use. If not given, will use last month as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use. If not given, will use today as default.\n\nExample : 2012-04-20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 19 Jan 2023 18:31:20 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"6821a93f-ae9b-4715-b0eb-7707ccb2f44c"}],"id":"5cd41858-c73d-4837-a61c-101ea9d39a6b","description":"

In this section there are methods to forecast a time series to a desired time, for example, 10 days. The forecast is generated using machine learning mathematical tools, such as ARIMA, linear regression, etc.

General differences between ARIMA and linear regression:

ARIMA works based on a neighbourhood of the recent data, this is, the previous data on a certain range (lagged data). Linear regression does not, it will use every information of data given on the subset of data selected to work with.
Linear regression only works with observed values, while ARIMA incorporates not observable data such as errors on the non stationary mean of the data.
In general, ARIMA is better for forecasting because it can represent a variety of different models (even the linear regression) deppending on the parameters given, sometimes adding more information to them, like seasonality and non-stationary mean.

\n","_postman_id":"5cd41858-c73d-4837-a61c-101ea9d39a6b"},{"name":"Churn Prediction","item":[{"name":"Churn Risk on sales","id":"12139441-1007-42ef-8a0c-e99f8da08093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/churn/sales?token=ACCESS_TOKEN&value=&id=COLLECTION_ID&ip&referer&group&time","description":"

Forecasts risk of churn based on sales data from given collection id. it can receive a value to add a new value to the collection.

\n","urlObject":{"protocol":"https","path":["churn","sales"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization.

Example : 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":"ACCESS_TOKEN"},{"description":{"content":"

(Optional) The value of a sale. If it comes it will be added to this collection.

Example : 78.9

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

(Required) id of the collection where to add this new observation value. Must be unique.

Example : sales-daily-client

\n","type":"text/plain"},"key":"id","value":"COLLECTION_ID"},{"description":{"content":"

(Optional)

\n","type":"text/plain"},"key":"ip","value":null},{"description":{"content":"

(Optional)

\n","type":"text/plain"},"key":"referer","value":null},{"description":{"content":"

(Optional)

\n","type":"text/plain"},"key":"group","value":null},{"description":{"content":"

(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.

Example: 1617835190875

\n","type":"text/plain"},"key":"time","value":null}],"variable":[]}},"response":[{"id":"9d79d715-baae-49d4-8feb-e8372ad6b4c8","name":"200 OK: no value","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/sales?token=ACCESS_TOKEN&value&id=prueba1&ip&referer&group","protocol":"https","host":["api","aumento","ai"],"path":["churn","sales"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization.\n\nExample : 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":null,"description":"(Optional) The value of a sale. If it comes it will be added to this collection.\n\nExample : 78.9"},{"key":"id","value":"prueba1","description":"(Required) id of the collection where to add this new observation value. Must be unique.\n\nExample : sales-daily-client"},{"key":"ip","value":null,"description":"(Optional)"},{"key":"referer","value":null,"description":"(Optional)"},{"key":"group","value":null,"description":"(Optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 19 Jan 2023 19:13:54 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"nsamples\": 19,\n \"riskDescription\": \"low\",\n \"start\": \"2021-01-19\",\n \"totalSales\": 4070,\n \"risk\": 1,\n \"collection\": \"prueba1\",\n \"id\": \"prueba1\",\n \"firstObservation\": \"2023-01-01T17:58:21Z\",\n \"explanation\": \"decreasing frequency of sales\",\n \"lastObservation\": \"2023-01-19T19:12:34Z\"\n}"},{"id":"075abc6d-a8d2-45c8-a9b5-1e7164332f99","name":"200 OK: with value","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/sales?token=ACCESS_TOKEN&value=25&id=prueba1&ip&referer&group","protocol":"https","host":["api","aumento","ai"],"path":["churn","sales"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization.\n\nExample : 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":"25","description":"(Optional) The value of a sale. If it comes it will be added to this collection.\n\nExample : 78.9"},{"key":"id","value":"prueba1","description":"(Required) id of the collection where to add this new observation value. Must be unique.\n\nExample : sales-daily-client"},{"key":"ip","value":null,"description":"(Optional)"},{"key":"referer","value":null,"description":"(Optional)"},{"key":"group","value":null,"description":"(Optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 19 Jan 2023 19:14:50 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"nsamples\": 19,\n \"riskDescription\": \"low\",\n \"start\": \"2021-01-19\",\n \"totalSales\": 4115,\n \"risk\": 1,\n \"collection\": \"prueba1\",\n \"id\": \"prueba1\",\n \"firstObservation\": \"2023-01-01T17:58:21Z\",\n \"explanation\": \"decreasing frequency of sales\",\n \"value\": 25,\n \"lastObservation\": \"2023-01-19T19:14:49Z\"\n}"},{"id":"5d76deb4-37e4-4f1e-b994-96304d0f6d05","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/sales?token=ACCESS_TOKEN&value&id&ip&referer&group","protocol":"https","host":["api","aumento","ai"],"path":["churn","sales"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization.\n\nExample : 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"value","value":null,"description":"(Required) The value of a sale. If it comes it will be added to this collection.\n\nExample : 78.9"},{"key":"id","value":null,"description":"(Required) id of the collection where to add this new observation value. Must be unique.\n\nExample : sales-daily-client"},{"key":"ip","value":null,"description":"(Optional)"},{"key":"referer","value":null,"description":"(Optional)"},{"key":"group","value":null,"description":"(Optional)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 19 Jan 2023 19:07:54 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"12139441-1007-42ef-8a0c-e99f8da08093"},{"name":"Churn Risk on pageviews","id":"20284f30-eb42-4791-88fa-92b3b9baa9df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/churn/pageviews?token=ACCESS_TOKEN&views=&id=COLLECTION_ID&ip&referer&group&time","description":"

Forecasts risk of churn based on pageviews activity from given user (collection id).

\n","urlObject":{"protocol":"https","path":["churn","pageviews"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization.

Example : 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":"ACCESS_TOKEN"},{"description":{"content":"

(Optional) this is not required. The value of pageviews. Default value is 1 meaning one page view for this collection id.

Example : 1

\n","type":"text/plain"},"key":"views","value":""},{"description":{"content":"

(Required) id of the collection where to add this new observation value. Must be unique.

Example : pageviews-client

\n","type":"text/plain"},"key":"id","value":"COLLECTION_ID"},{"description":{"content":"

(Optional) remote IP address of the user using your app.

Example : 192.158.1.38

\n","type":"text/plain"},"key":"ip","value":null},{"description":{"content":"

(Optional) Referer URI, identifies the address of the web page, from which the resource has been requested.

Example : /index/action/pay

\n","type":"text/plain"},"key":"referer","value":null},{"description":{"content":"

(Optional) collection belongs to this group. Useful for group summaries.

Example : sales

\n","type":"text/plain"},"key":"group","value":null},{"description":{"content":"

(Optional) Timestamp of this observation in milliseconds since unix epoch. If not present, server will set current time.

Example: 1617835190875

\n","type":"text/plain"},"key":"time","value":null}],"variable":[]}},"response":[{"id":"c024f4e9-fb25-44b1-af08-bda145ad20ef","name":"Churn Risk on pageviews","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/pageviews?token=ACCESS_TOKEN&views=1&id=prueba1&ip&referer&group","protocol":"https","host":["api","aumento","ai"],"path":["churn","pageviews"],"query":[{"key":"token","value":"ACCESS_TOKEN"},{"key":"views","value":"1"},{"key":"id","value":"prueba1"},{"key":"ip","value":null},{"key":"referer","value":null},{"key":"group","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 19 Jan 2023 19:19:32 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"nsamples\": 19,\n \"riskDescription\": \"no risk\",\n \"risk\": 0,\n \"collection\": \"prueba1\",\n \"id\": \"prueba1\",\n \"totalActivity\": 4116,\n \"firstObservation\": \"2023-01-01T17:58:21Z\",\n \"explanation\": \"\",\n \"lastObservation\": \"2023-01-19T19:19:32Z\"\n}"},{"id":"82c6bbd4-f7ed-4105-a6d9-2b0dbbabff3e","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/pageviews?token=ACCESS_TOKEN&views=&id=COLLECTION_ID&ip&referer&group","protocol":"https","host":["api","aumento","ai"],"path":["churn","pageviews"],"query":[{"key":"token","value":"ACCESS_TOKEN","description":"(Required) API access token for your organization.\n\nExample : 2a439044-7b44-49a9-9f19-3f3d8cd072f2"},{"key":"views","value":"","description":"(Optional) this is not required. The value of pageviews. Default value is 1 meaning one page view for this collection id.\n\nExample : 1"},{"key":"id","value":"COLLECTION_ID","description":"(Required) id of the collection where to add this new observation value. Must be unique.\n\nExample : pageviews-client"},{"key":"ip","value":null,"description":"(Optional) remote IP address of the user using your app.\n\nExample : 192.158.1.38"},{"key":"referer","value":null,"description":"(Optional) Referer URI, identifies the address of the web page, from which the resource has been requested.\n\nExample : /index/action/pay"},{"key":"group","value":null,"description":"(Optional) collection belongs to this group. Useful for group summaries.\n\nExample : sales"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Thu, 19 Jan 2023 19:20:57 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."}],"_postman_id":"20284f30-eb42-4791-88fa-92b3b9baa9df"},{"name":"Churn Alerts","id":"8e925980-1c63-4671-b826-06c27ccae46b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aumento.ai/churn/pageviews?token=ACCESS_TOKEN&start&end&max","description":"

Lists churn alerts generated for this organization (ACCES_TOKEN).

The list is paginated and ordered by created date descending.

\n","urlObject":{"protocol":"https","path":["churn","pageviews"],"host":["api","aumento","ai"],"query":[{"description":{"content":"

(Required) API access token for your organization.

Example : 2a439044-7b44-49a9-9f19-3f3d8cd072f2

\n","type":"text/plain"},"key":"token","value":"ACCESS_TOKEN"},{"description":{"content":"

(Optional) Start date of the time series data to use. If not given, will use last month as default.

Example : 2012-03-20

\n","type":"text/plain"},"key":"start","value":null},{"description":{"content":"

(Optional) End date of the time series data to use. If not given, will use today as default.

Example : 2012-04-20

\n","type":"text/plain"},"key":"end","value":null},{"description":{"content":"

(Optional) maximum number of results returned per page. Page size. Default is 100.

Example : 25

\n","type":"text/plain"},"key":"max","value":null}],"variable":[]}},"response":[{"id":"5e54a2b3-0dd7-4425-abb5-a988a661b91c","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/pageviews?token=ACCESS_TOKEN&start&end","protocol":"https","host":["api","aumento","ai"],"path":["churn","pageviews"],"query":[{"key":"token","value":"ACCESS_TOKEN"},{"key":"start","value":null,"description":"(Optional) Start date of the time series data to use. If not given, will use last week as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use. If not given, will use today as default.\n\nExample : 2012-04-20"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 15 Mar 2023 14:32:23 GMT"},{"key":"Content-Type","value":"text/html;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"}],"cookie":[],"responseTime":null,"body":"Invalid data."},{"id":"cdbae626-b958-4335-af67-f241348b438f","name":"200 Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.aumento.ai/churn/pageviews?token=ACCESS_TOKEN&start&end","protocol":"https","host":["api","aumento","ai"],"path":["churn","pageviews"],"query":[{"key":"token","value":"ACCESS_TOKEN"},{"key":"start","value":null,"description":"(Optional) Start date of the time series data to use. If not given, will use last week as default.\n\nExample : 2012-03-20"},{"key":"end","value":null,"description":"(Optional) End date of the time series data to use. If not given, will use today as default.\n\nExample : 2012-04-20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"pagination\": {\n \"nextPage\": \"http://localhost:8080/churn/alerts?token=6332d9-573b-4635-b320-b969fbc0ce8e&max=1&offset=11&start=2023-02-01&end=2023-02-27\",\n \"previousPage\": \"http://localhost:8080/churn/alerts?token=6332d9-573b-4635-b320-b969fbc0ce8e&max=1&offset=9&start=2023-02-01&end=2023-02-27\",\n \"totalCount\": 525,\n \"max\": 1,\n \"offset\": 10\n },\n \"data\": [\n {\n \"clientId\": \"932\",\n \"risk\": 2,\n \"avgPageViewsDay\": 6.199386503067484,\n \"avgIpDay\": 3.7361963190184064,\n \"riskDescription\": \"medium\",\n \"daysOfData\": 326,\n \"created\": \"2023-02-28T01:59:27Z\",\n \"explanation\": \"pageviews tending to medium low levels in the near future, frecuency of sessions tending to medium low levels in the near future, ip diversity tending to medium low levels in the near future\",\n \"firstObservation\": \"2015-04-16T00:31:25Z\",\n \"lastObservation\": \"2016-11-15T20:28:27Z\",\n \"avgSessionFrequency\": null,\n \"type\": \"churn\"\n }\n ]\n}"}],"_postman_id":"8e925980-1c63-4671-b826-06c27ccae46b"}],"id":"4d34f389-6afc-4aba-ba64-4859045bee8a","description":"

Churn rate, refers to the proportion of contractual customers or subscribers who leave a supplier during a given time period. It is a possible indicator of customer dissatisfaction, cheaper and/or better offers from the competition, more successful sales and/or marketing by the competition, or reasons having to do with the customer life cycle.

For this reason, predicting the state of a client, product or service on a time series can add critical value to the efficiency and productivity. Aumento provide 2 algorithms to predict the Churn risk, the first is based on sales, for example, if a certain client is not buying the same quantity as before or if a service lost popularity over time. The second algorithm is by pageviews, that makes an analysis of how much a client is visiting (or not) a webpage.

Risk is returned in 3 levels: low risk (1), medium risk (2) and high risk (3).