Ingest an event

POST

/v:version/ingest/meter-data

POST

/v:version/ingest/meter-data

$ curl -X POST "https://test.api.solvimon.com/v1/ingest/meter-data?meter_validation=DYNAMIC" \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "reference": "00124578951",
>   "customer_reference": "9923725805",
>   "meter_reference": "meter_subscriptions",
>   "timestamp": "2024-07-01T10:50:00+02:00",
>   "meter_properties": [
>     {
>       "reference": "plan",
>       "value": "pro",
>       "dynamic_validation_settings": {
>         "type": "ENUM",
>         "required": true
>       }
>     }
>   ],
>   "meter_values": [
>     {
>       "reference": "seats",
>       "number": "25"
>     }
>   ]
> }'

1 {
2   "object_type": "meter_data",
3   "id": "md_9876543210",
4   "reference": "00124578951",
5   "type": "INGEST",
6   "customer_reference": "9923725805",
7   "meter_reference": "meter_subscriptions",
8   "timestamp": "2024-07-01T10:50:00+02:00",
9   "meter_properties": [
10     {
11       "reference": "plan",
12       "value": "pro"
13     }
14   ],
15   "meter_values": [
16     {
17       "reference": "seats",
18       "number": "25"
19     }
20   ]
21 }

Requires the METER_DATA.INGEST permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

cost_predictionbooleanOptional

The option to return cost prediction.

clickhousebooleanOptional

Which engine computes the cost prediction requested by cost_prediction: true returns the ClickHouse engine’s result instead of the legacy one. Does not turn a prediction on by itself. Only honoured on dev/beta; anywhere else the legacy engine answers.

meter_validationstringOptional

The validation strategy applied to the referenced meter. STATIC (the default) requires the meter, its values and properties to already exist. DYNAMIC creates the meter and its missing values/properties/enum values on the fly during ingest.

Request

This endpoint expects an object.

referencestring or nullRequiredformat: "^.*$"10-256 characters

customer_idstring or nullOptional

The resource ID of the associated customer.

customer_referencestring or nullOptional

A custom reference assigned to the customer.

customerobject or nullOptional

meter_idstring or nullOptional

The resource ID of the meter.

meter_referencestring or nullOptional

A custom reference assigned to the meter.

pricing_plan_subscription_idstring or nullOptional

The resource ID of the associated pricing plan subscription.

pricing_plan_subscription_referencestring or nullOptional

A custom reference assigned to the pricing plan subscription.

pricing_plan_subscription_selectorobjectOptional

A selector to dynamically determine the subscription to use.

timestampdatetime or nullOptional

The associated timestamp presented in the ISO 8601 standard of the charge event, if not provided it will be set to 'now'.

meter_propertieslist of objects or nullOptional

The properties that provide information to give context to an event, used in the meter.

meter_valueslist of objects or nullOptional

The values used as input to calculate billable units, used in the meter.

cost_predictionobject or nullOptional

The cost prediction.

processed_detailsobject or nullOptional

Details of the result of processing the event.

Response

Created

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

referencestring or nullOptionalformat: "^.*$"10-256 characters

typeenum or nullOptionalRead-only

The type of meter data.