Bulk ingest events

Use when batching usage events (e.g. backfill or high-volume ingestion). More efficient than single event calls; returns 202 when accepted.

POST /events/bulk

Bulk ingest events

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/events/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "events": [
    {
      "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/bulk"

payload = { "events": [
        {
            "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({
    events: [
      {
        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/bulk', 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/bulk",
  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([
    'events' => [
        [
                '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/bulk"

	payload := strings.NewReader("{\n  \"events\": [\n    {\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    }\n  ]\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/bulk")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    {\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    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"events\": [\n    {\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    }\n  ]\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

events · object[] · required

Required array length: 1 - 1000 elements

Show child attributes

Response

202

application/json

message:Event accepted for processing

{key} · string