Events

Ingest event

Changed on

Use when sending a single usage event from your app (e.g. one API call or one GB stored). Events are processed asynchronously; returns 202 with event_id.

post/events

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/events
  • Auth
    API key in header x-api-key

Request body

customer_idstring
event_idstring
event_namestring required
external_customer_idstring required
propertiesobject

Handled separately for dynamic columns

sourcestring
timestampstring

Handled separately due to parsing

Example request

{
  "customer_id": "customer456",
  "event_id": "event123",
  "event_name": "api_request",
  "external_customer_id": "customer456",
  "properties": {
    "\"response_status\"": "200}",
    "{\"request_size\"": "100"
  },
  "source": "api",
  "timestamp": "2024-03-20T15:04:05Z"
}

Response

message:Event accepted for processing

object required

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

  • 8ec2edea6b20Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new too_many_requests enum value to the response property for the response status

    • warning

      added the new too_many_requests enum value to the response property for the response status