Ingest

post
/v1/datasets/{id}/ingest

Query Parameters

ParamTypeDescription

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 `,`.

Path Parameters

ParamTypeDescription

id

string

required

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

Body Parameters

ParamTypeDescription

payload

array

required

Data you want to send to Axiom in a supported format.

Responses

200
ingest status, an object with the following properties:
PropertyTypeDescription

blocksCreated

integer

Number of blocks created

failed

integer

Number of failures that occurred during ingest

failures

array

List of failures that occurred during ingest

ingested

integer

Number of events ingested

processedBytes

integer

Number of bytes processed

walLength

integer

Length of the WAL

401
Forbidden, an object with the following properties:
PropertyTypeDescription

code

string

message

string

Was this page helpful?