Ingest events (dry-run)

1 min

POST

https://app.amberflo.io/ingest/dry-run

Use this endpoint to see how your ingest payload will be processed before ingestion.

Useful to validate custom ingestion schemas and multi-valued records.

Body Parameters

bodyingestion.IngestMessage.in[]
- uniqueIdstring
  Description
  Set this value in order to differentiate otherwise identical (same meter, customer, time, and dimensions) events.
- meterApiNamestring
  Description
  `meterApiName` as defined in [Meter API](ref:post_meters). Required if `values` is not set or empty.
- meterValuenumber
  Description
  Meter value to be ingested. This will be used for aggregation. Required if `values` is not set or empty.
- meterTimeInMillisinteger<int64>required
  Description
  Meter event timestamp, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
- customerIdstringrequired
  Description
  `customerId` as defined in [Customer API](ref:post_customers).
- dimensionsmap<string, string>
  Description
  Dimension values for keys defined in `dimensions` in [Meter API](ref:post_meters).
- variantsingestion.IngestMessage.Variant.in[]
  Description
  When set, each entry will be merged with the main fields to form the resulting ingest messages. This is a more flexible alternative to the `values` field. May not be used together with the `values` field.
  - meterApiNamestring
    Description
    See the main `meterApiName` field.
  - meterValuenumber
    Description
    See the main `meterValue` field.
  - dimensionsmap<string, string>
    Description
    See the main `dimension` field.
- valuesmap<string, number>
  Description
  Map of `meterApiName` to `meterValue`. Use this field instead of the `meterApiName` and `meterValue` fields if you want to send multiple values in a single ingest message May only be used if the fields `meterApiName`, `meterValue`, and `variants` are not.

Responses

200Successful request

ingestion.IngestMessage.out[]
- uniqueIdstring
  Description
  Set this value in order to differentiate otherwise identical (same meter, customer, time, and dimensions) events.
- meterApiNamestring
  Description
  `meterApiName` as defined in [Meter API](ref:post_meters). Required if `values` is not set or empty.
- meterValuenumber
  Description
  Meter value to be ingested. This will be used for aggregation. Required if `values` is not set or empty.
- meterTimeInMillisinteger<int64>required
  Description
  Meter event timestamp, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
- customerIdstringrequired
  Description
  `customerId` as defined in [Customer API](ref:post_customers).
- dimensionsmap<string, string>
  Description
  Dimension values for keys defined in `dimensions` in [Meter API](ref:post_meters).
- variantsingestion.IngestMessage.Variant.out[]
  Description
  When set, each entry will be merged with the main fields to form the resulting ingest messages. This is a more flexible alternative to the `values` field. May not be used together with the `values` field.
  - meterApiNamestring
    Description
    See the main `meterApiName` field.
  - meterValuenumber
    Description
    See the main `meterValue` field.
  - dimensionsmap<string, string>
    Description
    See the main `dimension` field.
- valuesmap<string, number>
  Description
  Map of `meterApiName` to `meterValue`. Use this field instead of the `meterApiName` and `meterValue` fields if you want to send multiple values in a single ingest message May only be used if the fields `meterApiName`, `meterValue`, and `variants` are not.

curl

curl --request POST \
     --url https://app.amberflo.io/ingest/dry-run \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '[
     {
     "meterTimeInMillis": 0,
     "customerId": ""
     }
     ]'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify([
   {
      "meterTimeInMillis": 0,
      "customerId": ""
   }
]);

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

fetch("https://app.amberflo.io/ingest/dry-run", 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/ingest/dry-run")

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([
   {
      "meterTimeInMillis": 0,
      "customerId": ""
   }
])

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

python

import requests
import json

url = "https://app.amberflo.io/ingest/dry-run"

payload = json.dumps([
   {
      "meterTimeInMillis": 0,
      "customerId": ""
   }
])
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Successful request
[
  {
    "uniqueId": "",
    "meterApiName": "",
    "meterValue": 0,
    "meterTimeInMillis": "",
    "customerId": "",
    "dimensions": "",
    "variants": [
      {
        "meterApiName": "",
        "meterValue": 0,
        "dimensions": ""
      }
    ],
    "values": ""
  }
]

Use this endpoint to see how your ingest payload will be processed before ingestion.

Useful to validate custom ingestion schemas and multi-valued records.