Ingest Data

Ingest

Authorizations

Authorization

string

headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Axiom-CSV-Fields

string[]

A list of optional comma separated fields to use for CSV ingestion. If not specified, the first line of the CSV will be used as the field names.

X-Axiom-Event-Labels

string

An optional JSON encoded object with additional labels to add to all events in the request

Path Parameters

id

string

required

Unique ID of the dataset where you want to send data.

Query Parameters

timestamp-field

string

The name of the field to use as the timestamp. If not specified, the timestamp will be the time the event was received by Axiom.

timestamp-format

string

The date-time format of the timestamp field. The reference time is Mon Jan 2 15:04:05 -0700 MST 2006, as specified in https://pkg.go.dev/time/?tab=doc#Parse

csv-delimiter

string

The delimiter to use when parsing CSV data. If not specified, the default delimiter is ,.

Body

a JSON or ND-JSON array of events to ingest

Response

200 - application/json

failed

integer

required

Number of failures that occurred during ingest

ingested

integer

required

Number of events ingested

processedBytes

integer

required

Number of bytes processed

blocksCreated

integer

Number of blocks created

failures

object[]

List of failures that occurred during ingest

Show child attributes

walLength

integer

Length of the WAL