Generate segmentation for customers

1 min

POST

https://app.amberflo.io/pricing/segmentation

Body Parameters

bodycom.amberflo.analysis.segmentation.CustomerSegmentationRequest.in
- meterApiNamesstring[]required
  Description
  A set of meter-api-names which will be used for segmentation.
- meterGroupInfosmap<string, payment.meters.GroupInfo.in[]>
  Description
  A map from meter-api-name to a list of dimensions
- minSegmentRationumber
  Description
  Minimum customer ratio of any produced segment (0.1 is the default, and it means that each cluster is at least 10% of customers).
- amountOfSegmentsinteger<int32>
  Description
  Amount of segments to produce (default to 1).
- amountOfMonthsToConsiderinteger<int32>
  Description
  Amount of months of data to consider for the segmentation (default to 3).

Responses

200Successful request

com.amberflo.analysis.segmentation.AccountCustomerSegments.out
- customerSegmentscom.amberflo.analysis.segmentation.AccountUsageClusterSegment.out[]
  Description
  A set of segments which are the result of the customers clustering.
  - meterUsageClusterSegmentscom.amberflo.analysis.segmentation.MeterUsageClusterSegment.out[]
    Description
    A list of usage statics for each meter requested.
    - meterApiNamestring
      Description
      The meter-api-name.
    - groupInfopayment.meters.GroupInfo.out
      Description
      The dimension of the meter Api Name.
      - gimap<string, string>
    - usageBucketListcom.amberflo.analysis.segmentation.MeterUsageSegmentBucket.out[]
      Description
      The list of the usage buckets in the customer cluster segment.
      - usagenumber
        Description
        The average usage for the customers in the bucket.
      - amountOfCustomersnumber
        Description
        The number of customers in the bucket.
      - monthlyCustomerTrendnumber
        Description
        How many customers on average to join or leave this bucket every month
    - averageUsagenumber
      Description
      Avg usage over all customers.
  - customersInSegmentinteger<int32>
    Description
    Number of customers in the segment.

curl

curl --location 'https://app.amberflo.io/pricing/segmentation' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "meterApiNames": [
    ""
  ],
  "meterGroupInfos": "",
  "minSegmentRatio": 0,
  "amountOfSegments": 0,
  "amountOfMonthsToConsider": 0
}'

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "meterApiNames": [
      ""
   ],
   "meterGroupInfos": "",
   "minSegmentRatio": 0,
   "amountOfSegments": 0,
   "amountOfMonthsToConsider": 0
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/pricing/segmentation", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/pricing/segmentation")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "meterApiNames": [
      ""
   ],
   "meterGroupInfos": "",
   "minSegmentRatio": 0,
   "amountOfSegments": 0,
   "amountOfMonthsToConsider": 0
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/pricing/segmentation"

payload = json.dumps({
   "meterApiNames": [
      ""
   ],
   "meterGroupInfos": "",
   "minSegmentRatio": 0,
   "amountOfSegments": 0,
   "amountOfMonthsToConsider": 0
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "customerSegments": [
    {
      "meterUsageClusterSegments": [
        {
          "meterApiName": "",
          "groupInfo": {
            "gi": ""
          },
          "usageBucketList": [
            {
              "usage": 0,
              "amountOfCustomers": 0,
              "monthlyCustomerTrend": 0
            }
          ],
          "averageUsage": 0
        }
      ],
      "customersInSegment": ""
    }
  ]
}