v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB

Events

Create Events

Supports batch creation of events.

Dataset names are case insensitive. POST requests to "MyDatasET" will land in the same dataset as "mydataset". Names may contain URL-encoded spaces or other special characters, but not URL-encoded slashes. For example, "My%20Dataset" will show up in the UI as "My Dataset".

The first event received for a dataset determines the casing of the displayed name. All subsequent variations in casing will use the originally specified case.

post/1/batch/{datasetSlug}

Headers

Content-Encoding'gzip' | 'zstd'

Included when sending events in a file. Size limitations may be addressed by compressing request bodies with gzip or zstd compression. Be sure to set the Content-Encoding to gzip or zstd when compressing the request body. If sending plaintext, omit this header; "plaintext" is included to simplify the example with curl.

Request body

dataEvent

timestring

Should be in RFC3339 high precision format (for example, YYYY-MM-DDTHH:MM:SS.mmmZ). May be a Unix epoch (seconds since 1970) with second or greater precision (for example, 1452759330927). Optional. If not set, defaults to the time that the API receives the event.

samplerateinteger

An integer representing the denominator in the fraction 1/n when client-side sampling has been applied. Optional. If not set, defaults to 1, meaning "not sampled". Refer to Sampling for more detail.

Response

Enqueued for processing

statusnumber

errorstring