Skip to main content
POST
/
datasets
/
{dataset_name}
/
ingest
cURL
curl --request POST \
  --url https://api.axiom.co/v1/datasets/{dataset_name}/ingest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'
{
  "ingested": 2,
  "failed": 0,
  "failures": [],
  "processedBytes": 16
}

Authorizations

​
Authorization
string
header
required

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

​
dataset_name
string
required

Unique name of the dataset.

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

Data you want to send to Axiom. Supported formats: JSON, NDJSON, CSV. Upload the data in a file or send it in the payload of the request.

Response

ingest status

​
failed
integer<uint64>
required

Number of failures that occurred during ingest

​
ingested
integer<uint64>
required

Number of events ingested

​
processedBytes
integer<uint64>
required

Number of bytes processed

​
blocksCreated
integer<uint32>

Number of blocks created

​
failures
object[]

List of failures that occurred during ingest

​
walLength
integer<uint32>

Length of the WAL