Ingest event

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

Ingest event

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/events \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "event_name": "api_request",
  "external_customer_id": "customer456",
  "customer_id": "customer456",
  "event_id": "event123",
  "properties": {
    "\"response_status\"": "200}",
    "{\"request_size\"": "100"
  },
  "source": "api",
  "timestamp": "2024-03-20T15:04:05Z"
}
'

import requests

url = "https://us.api.flexprice.io/v1/events"

payload = {
    "event_name": "api_request",
    "external_customer_id": "customer456",
    "customer_id": "customer456",
    "event_id": "event123",
    "properties": {
        ""response_status"": "200}",
        "{"request_size"": "100"
    },
    "source": "api",
    "timestamp": "2024-03-20T15:04:05Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_name: 'api_request',
    external_customer_id: 'customer456',
    customer_id: 'customer456',
    event_id: 'event123',
    properties: {'"response_status"': '200}', '{"request_size"': '100'},
    source: 'api',
    timestamp: '2024-03-20T15:04:05Z'
  })
};

fetch('https://us.api.flexprice.io/v1/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event_name' => 'api_request',
    'external_customer_id' => 'customer456',
    'customer_id' => 'customer456',
    'event_id' => 'event123',
    'properties' => [
        '"response_status"' => '200}',
        '{"request_size"' => '100'
    ],
    'source' => 'api',
    'timestamp' => '2024-03-20T15:04:05Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/events"

	payload := strings.NewReader("{\n  \"event_name\": \"api_request\",\n  \"external_customer_id\": \"customer456\",\n  \"customer_id\": \"customer456\",\n  \"event_id\": \"event123\",\n  \"properties\": {\n    \"\\\"response_status\\\"\": \"200}\",\n    \"{\\\"request_size\\\"\": \"100\"\n  },\n  \"source\": \"api\",\n  \"timestamp\": \"2024-03-20T15:04:05Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/events")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_name\": \"api_request\",\n  \"external_customer_id\": \"customer456\",\n  \"customer_id\": \"customer456\",\n  \"event_id\": \"event123\",\n  \"properties\": {\n    \"\\\"response_status\\\"\": \"200}\",\n    \"{\\\"request_size\\\"\": \"100\"\n  },\n  \"source\": \"api\",\n  \"timestamp\": \"2024-03-20T15:04:05Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/events")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_name\": \"api_request\",\n  \"external_customer_id\": \"customer456\",\n  \"customer_id\": \"customer456\",\n  \"event_id\": \"event123\",\n  \"properties\": {\n    \"\\\"response_status\\\"\": \"200}\",\n    \"{\\\"request_size\\\"\": \"100\"\n  },\n  \"source\": \"api\",\n  \"timestamp\": \"2024-03-20T15:04:05Z\"\n}"

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

202

{}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Event data

event_name · string · required

Example:

"api_request"

external_customer_id · string · required

Example:

"customer456"

customer_id · string

Example:

"customer456"

event_id · string

Example:

"event123"

properties · object

Handled separately for dynamic columns

Show child attributes

Example:

{
  "\"response_status\"": "200}",
  "{\"request_size\"": "100"
}

source · string

Example:

"api"

timestamp · string

Handled separately due to parsing

Example:

"2024-03-20T15:04:05Z"

Response

202

application/json

message:Event accepted for processing

{key} · string