Bulk Create Client Events

POST {{baseUrl}}/client/event-bulk-create/?company_id={{companyId}}

Create new events to track a profile's activity.

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a public API key (site ID). Never use a private API key with our client-side endpoints.

To create events from server-side applications, please use POST /api/event-bulk-create-jobs.

Accepts a maximum of 1000 events per request.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes: events:write

Request Params

KeyDatatypeRequiredDescription
company_idstring(Required) Your Public API Key / Site ID. See this article for more details.

Request Body

{"data"=>{"type"=>"event-bulk-create", "attributes"=>{"profile"=>{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_id"=>"<string>", "anonymous_id"=>"<string>", "_kx"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "organization"=>"<string>", "title"=>"<string>", "image"=>"<string>", "location"=>{"address1"=>"<string>", "address2"=>"<string>", "city"=>"<string>", "country"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "region"=>"<string>", "zip"=>"<string>", "timezone"=>"<string>", "ip"=>"<string>"}}, "id"=>"<string>", "meta"=>{"patch_properties"=>{"unset"=>"<string>"}}}}, "events"=>{"data"=>[{"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}, {"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}]}}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring